Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
API page: http://api.drupal.org/api/drupal/modules--field--field.module/group/field/7
This links to a lot of subtopics. It would be handy if these linked back up.
Comments
Comment #1
jhodgdonGood idea. Probably a good Novice project -- just add links to the main topic, following the link syntax:
http://drupal.org/node/1354#links
Comment #2
bartlantz CreditAttribution: bartlantz commentedHere's a patch. I added a link back to the Field API document from all of the subtopics.
Comment #3
bartlantz CreditAttribution: bartlantz commentedThis is the back port of the patch to drupal 7.
Comment #4
bartlantz CreditAttribution: bartlantz commentedI've assigned the issue to myself.
Comment #5
jhodgdonThanks for the patches! We need to leave this issue as Drupal 8 until it's resolved for D8, and normally I recommend not porting a d8 patch to d7 until the d8 patch has been accepted and committed (saves time and effort, since often patches go through a couple of iterations before they are accepted).
Looking at the patch for D8 in #2, I see:
This should just be
@see field
which will make the desired link back to the field topic.
Also, in this issue what we wanted was for the @defgroup topic sections that are subtopics of the Field API topic to have this link, not the individual functions that are listed in the topics.
Comment #6
bartlantz CreditAttribution: bartlantz commentedOkay, I think I've got it. I've put a "@see field" link in all of the @defgroup subtopics that the main Field API links to. (Sorry about switching versions, I was thinking it switched it for just that patch.)
Comment #7
jhodgdonPerfect, thanks! (Assuming the committers agree, after it is committed would be the time to port this to D7.)
Comment #8
catchMakes sense, committed/pushed to 8.x., moving to 7.x to webchick.
Comment #9
bartlantz CreditAttribution: bartlantz commentedPatch that puts a "@see field" link in all of the @defgroup subtopics that the main Field API links to. Here's the backport of the patch to Drupal 7.
Comment #10
jhodgdonThanks!
Comment #11
webchickAwesome improvement!
Committed and pushed to 7.x. Thanks!
Comment #12
jhodgdonThis needs to be reopened. The @see links did not work. Apparently we need to make them @link instead of using @see.
http://api.drupal.org/api/drupal/modules--field--field.attach.inc/group/...
Comment #13
bartlantz CreditAttribution: bartlantz commentedThat's strange! Here's a new patch. I wasn't sure what to put as the link text, I used the following
See @link field Field API @endlink.
Let me know if should be something else. Thanks!
Comment #14
bartlantz CreditAttribution: bartlantz commentedoops, I forgot to change the status to needs review.
Comment #15
jhodgdonThe link text is fine... and this looks OK... but I'm wondering if we should say something like "See (link) for information about the other parts of the Field API", or something like that to explain why we are putting that See line there? Or maybe "See also (link)" rather than just "See (link)"? (@see normally formats to a See Also section).
Note also that this patch will interfere with the patch for #1373194: Field Attach API topic/group page should link to Field Language API page. One of them will need a reroll when the other is committed.
Comment #16
bartlantz CreditAttribution: bartlantz commentedThat sounds like a good idea to add more explanation. I used the longer text because I think it might look strange to have a 'See also ' that wasn't formatted with the See Also section. Also the line was over 80 characters so I folded it onto another line.
Comment #17
jhodgdonThat looks totally reasonable. Thanks!
Comment #18
webchickLooks like a great change, thanks!
Committed and pushed to 8.x and 7.x. This looks mis-filed as a feature request.