[documentation] modifying links in admin/help in handbook to prevent dead links

[Angie Byron]

Charlie Lowe wrote:
> I'm in the midst of reviewing the admin/help handbook pages against 4.7,
> and I want to start coding the links and inserting them back into the
> handbook. Back on Sept 23, Angie mentioned coding the admin/help
> handbook pages with links such as
> 
> <strong class="admin-help-link">administer >> help</strong>
> 
> This way they would show as bold text instead of the broken links that
> they are now in the handbook. Anyone know if this was coded into Angie's
>  updated script? If so, I'll start using it.
> 
> Charlie

Hi, Charlie!

Wow, that would be awesome if you'd be willing to do that.. it is quite a chore. :\

As for scripting, the current docbook2helphook script just takes the links from
the handbook as-is when it generates the module help. However, I wrote a second
script (still a couple little bugs to work out but not too horrible) as my
original "proof of concept" (http://drupal.org/node/32078#comment-46194) that
will translate <strong class="...">..</strong> stuff into "normal" links which
the docbook2helphook script can then parse.

The convention it used was:

<strong class="drupal-link_PATH-TO-LINK">path >> to >> link</strong>

(actually it was "id" not "class", but I've since learned that certain pages
have the same link more than once so "id" won't work.)

So, for example (first link of aggregator module help):

administer your list of news feeds <strong
class="drupal-link_admin-aggregator">administer >> aggregator</strong>.

There's an underscore separating the string "drupal-link" from the actual path,
to make it easy to parse out which is which. However, if it's easier for you to
type drupal-link-admin-aggregator (no pesky shift key involved), or even
dl-admin-aggregator, then that's fine too, just as long as consistency is used
throughout.

Some kind of prefix is important though, not only to help me parse out the link
paths, but also so that the bold text doesn't accidentally take on properties of
other elements which may have class names specified in Bluebeach's CSS that
match "path-to-link" by itself.

This would be great if you were willing to do this, as it would finally allow me
to close that pesky issue that I got so sidetracked on. ;)

-Angie