Do we care for manpage links in <title> elements?

Warren Block wblock at wonkity.com
Tue Feb 26 17:45:37 UTC 2013


On Tue, 26 Feb 2013, Giorgos Keramidas wrote:

> On 2013-02-26 09:45, Tom Rhodes <trhodes at FreeBSD.org> wrote:
>> On Tue, 26 Feb 2013 14:44:15 +0100 Giorgos Keramidas <keramida at FreeBSD.org> wrote:
>>> On 2013-02-26 13:49, Giorgos Keramidas <keramida at FreeBSD.org> wrote:
>>>> Hi everyone,
>>>> I just noticed that in all the places where a chapter <title> includes a
>>>> &an.xxx.section; entity the rendering in HTML output sucks a bit.  Note
>>>> how there are two separate links in the 'Using rc(8) Under FreeBSD'
>>>> title in the following screenshot:
>>>>
>>>>     http://people.freebsd.org/~keramida/rc8-title-link.png
>>>
>>> This sort of diff fixes the title-link rendering:
>>> http://bitbucket.org/keramida/doc-work/commits/d44757193d819f1c950f0236801a37ef77d4711a
>>>
>>> But this is admittedly a "hack", and the optimal solution would be to
>>> conditionally render &man.foo.N; differently in <title> elements.
>>
>> Change the title "Using Run Control (RC)"
>
> This is not the only case where <title> embeds a &man.xxx.N; link, so I
> think we need a more general plan for all of them :-)

Agreed.  If valid markup produces broken output, it's the toolchain's 
fault and should be fixed.

Should man page or other entities be used in titles?  Sure.  Using a 
different term in the title than in the text only makes things less 
consistent for the reader.


More information about the freebsd-doc mailing list