API page: http://api.drupal.org/api/drupal/includes--form.inc/group/form_api/6

Describe the problem you have found:

The "reference" link is a generic link which resolves to the form reference for drupal 7. Since this is a drupal 6 api page, it would be more appropriate for the link to stay with the same version of drupal. ie: http://api.drupal.org/api/drupal/developer--topics--forms_api_reference....

Best,
Matt

Files: 
CommentFileSizeAuthor
#11 form_api_doc_link-1154722-11.patch700 bytesbarbi
PASSED: [[SimpleTest]]: [MySQL] 190 pass(es).
[ View ]
#7 form_api_doc_link-1154722-7.patch704 bytesbarbi
PASSED: [[SimpleTest]]: [MySQL] 190 pass(es).
[ View ]
#2 form_api_doc_link-1154722-2.patch622 bytesbarbi
PASSED: [[SimpleTest]]: [MySQL] 190 pass(es).
[ View ]

Comments

Title:Documentation problem with Form generation - Reference link incorrect.Form generation page - Reference link incorrect.
Issue tags:+Novice

Good catch! This would be a good project for a novice doc contributor to fix.

Assigned:Unassigned» barbi
Status:Active» Needs review
StatusFileSize
new622 bytes
PASSED: [[SimpleTest]]: [MySQL] 190 pass(es).
[ View ]

Ah. One other thing -- in the next line, the link
http://api.drupal.org/api/file/developer/topics/forms_api.html
is now redirected to
http://drupal.org/node/751826

But perhaps we should just provide a link to
http://drupal.org/node/20427
instead, and make the link text be
Form API guide on Drupal.org
thoughts?

Status:Needs review» Needs work

I had forgotten to change the status, sorry!

I am guessing the URL http://drupal.org/node/20427 is wrong. Or am I missing some thing here?

I have replaced the link http://api.drupal.org/api/file/developer/topics/forms_api.html to http://drupal.org/node/751826

Suggested hyperlink text : Form API guide

Let me know if it is good and I ll submit the patch.

Sorry, the link should have been http://drupal.org/node/204270 (last digit got cut off). That is the Form API section.

Status:Needs work» Needs review
StatusFileSize
new704 bytes
PASSED: [[SimpleTest]]: [MySQL] 190 pass(es).
[ View ]

Using anchor text : Form API guide

Looks good! The only thing I'm not sure of is whether the API module works correctly with
@link ... @endlink
not all on the same line.

I also think maybe it's easier for a person reading form.inc to read if the links are all on one line. What do you think? I see that we don't have it in http://drupal.org/node/1354 as a standard to make them all on one line (probably because I'm not sure whether API module requires it or not).

I am not sure either. Can the @endlink being on the next line?
If it will break the link or an HTML tag, I ll redo it.

I would need to test it in the API module to be sure... But there is no harm it making sure the links are on the same line (except that it would make the line wrapping less optimal), so let's do it.

StatusFileSize
new700 bytes
PASSED: [[SimpleTest]]: [MySQL] 190 pass(es).
[ View ]

Put @endlink on the same line.

Status:Needs review» Reviewed & tested by the community

I think that's better, thanks!

Status:Reviewed & tested by the community» Fixed

Committed to Drupal 6, thank you.

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