It's not "Caches API"
It's not "Schemas API"
It's not "Batches API"
Ergo, it should not be "Forms API"
When I was paging through the Drupal 6 Module Developer book from Packt and came across a chapter on "Forms API" and went, "How silly. They really should've caught that in tech editing." Then I remembered that the original (and that the time, only) FAPI documentation that Chad Phillips and I wrote, the FAPI reference and FAPI quickstart guide, respectively, call it "Forms API" for no other reason than we were trying to get the damn docs written so people would start migrating their modules to 4.7, and didn't think too much about the long-lasting ramifications of our arbitrary naming at the time. :P
Then tonight I noticed pages and pages in the handbook that also call this the "Forms API". I went through and fixed a bunch, but THE MADNESS. MUST. STOP.
Here's what I propose:
1. CVS rename contributions/docs/developer/topics/forms_api.html to form_api.html and forms_api_reference.html to form_api_reference.html.
2. Setup some kinda special 405 or whatever redirect codes on api.drupal.org to take care of all the dead links.
3. Go on a massive cleaning spree to eradicate any traces of "FormS API" in the handbook, in the API docs, in the source code, everywhere.
I can do #3. I need help on #1 and #2.
Comment | File | Size | Author |
---|---|---|---|
#20 | form_api_rename-262690-20.patch | 4.14 KB | Albert Volkman |
#16 | form_api_rename-262690-16.patch | 2.86 KB | Albert Volkman |
#14 | form_api_rename-262690-14.patch | 6.15 KB | Albert Volkman |
#14 | form_api_rename-docs-262690-14-do-not-test.patch | 2.54 KB | Albert Volkman |
#8 | form-api.patch | 464.51 KB | webchick |
Comments
Comment #1
pwolanin CreditAttribution: pwolanin commentedyou'll be happy that I at least got it right in the doxygen: http://api.drupal.org/api/group/form_api/6
Comment #2
drummComment #3
drummProperly moving the CVS files requires a brief CVS downtime, not happening before code freeze.
Comment #4
mikey_p CreditAttribution: mikey_p commentedNo more CVS.
Comment #5
webchickEr. Maybe so, but that link still says "Forms API Reference".
Comment #6
mikey_p CreditAttribution: mikey_p commentedMoving to the Documentation queue.
Comment #7
webchickI LOVE YOU GIT!!!!!!
I can patch this now. :D
Comment #8
webchickComment #9
mikey_p CreditAttribution: mikey_p commentedActually its a bit of a bummer, since the migration to Git this need to flow through someone who can commit this. In CVS the documentation directory was a free for all that anyone could commit to: http://drupal.org/node/18753/committers.
Comment #10
jhodgdonWhy is this patch so big, and can we discuss it in the Core issue queue (I'll commit it to the proper place when it's ready to go)?
It's impossible to review with so many changed lines. And which branch is it against?
Comment #11
jhodgdonOh I see, it's a file name change.
I would prefer not to change the file name. If we change the file name, we definitely need a redirect. How about a patch that just finds all the places where it's called Forms API and change that text only?
Comment #12
jhodgdonIf you do need to change the file name, then you need to find all refs to it and change them in Core as well.
Comment #13
jhodgdonIf we do commit this (to which branches?), then we need to also provide drumm with .htaccess redirect lines.
I'm inclined towards "won't fix" in hopes that we'll eventually just get rid of the file entirely.
Comment #14
Albert Volkman CreditAttribution: Albert Volkman commentedHere's a patch for required renames in core. Also included a patch for the documentation project.
Comment #15
jhodgdonWe are not changing the file name for the HTML file -- there are too many links to it at this point. So yes, change the text anywhere you find it, but when we patched that file before to call it "Form" instead of "Forms API" at the top, we consciously decided not to change the file name.
Comment #16
Albert Volkman CreditAttribution: Albert Volkman commentedAh okay, so this.
Comment #17
drummAPI.drupal.org does have path redirect module installed. If we want, we can add a redirect.
Comment #18
jhodgdonThat is true, but we really just want to get rid of the stupid file and document form elements in a better way. Let's not bother to rename it first.
Comment #19
jhodgdonThe patch in #16 is committed to 8.x, thanks! Time for 7.x...
Comment #20
Albert Volkman CreditAttribution: Albert Volkman commentedBackported.
Comment #21
jhodgdonThat patch looks fine, thanks! I'll get it committed shortly.
Comment #22
jhodgdonCommitted to 7.x.