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.

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

pwolanin’s picture

you'll be happy that I at least got it right in the doxygen: http://api.drupal.org/api/group/form_api/6

drumm’s picture

Assigned: Unassigned » drumm
drumm’s picture

Properly moving the CVS files requires a brief CVS downtime, not happening before code freeze.

mikey_p’s picture

Status: Active » Closed (won't fix)

No more CVS.

webchick’s picture

Component: CVS » api.drupal.org
Status: Closed (won't fix) » Active

Er. Maybe so, but that link still says "Forms API Reference".

mikey_p’s picture

Project: Drupal.org infrastructure » Documentation
Component: api.drupal.org » Correction/Clarification
Assigned: drumm » Unassigned

Moving to the Documentation queue.

webchick’s picture

Status: Active » Needs review

I LOVE YOU GIT!!!!!!

I can patch this now. :D

webchick’s picture

FileSize
464.51 KB
mikey_p’s picture

Actually 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.

jhodgdon’s picture

Project: Documentation » Drupal core
Version: » 8.x-dev
Component: Correction/Clarification » documentation
Status: Needs review » Needs work

Why 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?

jhodgdon’s picture

Oh 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?

jhodgdon’s picture

If you do need to change the file name, then you need to find all refs to it and change them in Core as well.

jhodgdon’s picture

If 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.

Albert Volkman’s picture

Status: Needs work » Needs review
FileSize
2.54 KB
6.15 KB

Here's a patch for required renames in core. Also included a patch for the documentation project.

jhodgdon’s picture

Status: Needs review » Needs work
- * @link forms_api_reference.html Form API reference @endlink
+ * @link form_api_reference.html Form API reference @endlink

We 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.

Albert Volkman’s picture

Status: Needs work » Needs review
FileSize
2.86 KB

Ah okay, so this.

drumm’s picture

API.drupal.org does have path redirect module installed. If we want, we can add a redirect.

jhodgdon’s picture

That 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.

jhodgdon’s picture

Version: 8.x-dev » 7.x-dev
Status: Needs review » Patch (to be ported)

The patch in #16 is committed to 8.x, thanks! Time for 7.x...

Albert Volkman’s picture

Status: Patch (to be ported) » Needs review
FileSize
4.14 KB

Backported.

jhodgdon’s picture

Assigned: Unassigned » jhodgdon
Status: Needs review » Reviewed & tested by the community

That patch looks fine, thanks! I'll get it committed shortly.

jhodgdon’s picture

Assigned: jhodgdon » Unassigned
Status: Reviewed & tested by the community » Fixed

Committed to 7.x.

Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.