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

Charlie Lowe cel4145 at cyberdash.com
Fri Nov 18 04:23:28 UTC 2005



Angie Byron wrote:
> 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. :\

I should probably mention that I'm working on updating all of the core 
modules, not contrib.

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

I just tried the following test which is different from yours:

<strong class="drupal-link/admin/aggregator">administer >> 
aggregator</strong>

Firefox doesn't mind it at all. Would it be invalid XHTML to use "/" in 
the class names? If it would be valid, then we can avoid a lot of typing 
errors. If someone has clean url's enabled and is checking the handbook 
pages against a live Drupal site, they only need to copy and paste the 
appropriate relative URL for part of the class name.

Now, since we aren't using the CSS, it doesn't have to validate in a CSS 
file, just as XHTML, right?

I know. I'm probably making all the web designers cringe. But this would 
make it very easy to do :)

Charlie



More information about the documentation mailing list