Skip site navigation (1)Skip section navigation (2)
Date:      Tue, 26 Feb 2013 18:19:07 +0100
From:      Giorgos Keramidas <keramida@FreeBSD.org>
To:        Tom Rhodes <trhodes@FreeBSD.org>
Cc:        freebsd-doc@freebsd.org
Subject:   Re: Do we care for manpage links in <title> elements?
Message-ID:  <20130226171905.GA10642@saturn>
In-Reply-To: <20130226094528.6cff2a60.trhodes@FreeBSD.org>
References:  <20130226124932.GA7258@saturn> <20130226134414.GA8899@saturn> <20130226094528.6cff2a60.trhodes@FreeBSD.org>

next in thread | previous in thread | raw e-mail | index | archive | help
On 2013-02-26 09:45, Tom Rhodes <trhodes@FreeBSD.org> wrote:
>On Tue, 26 Feb 2013 14:44:15 +0100 Giorgos Keramidas <keramida@FreeBSD.org> wrote:
>>On 2013-02-26 13:49, Giorgos Keramidas <keramida@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 :-)

%%%
kobe:/hg/freebsd/doc-work/en_US.ISO8859-1$ grep -r '<title>.*\&man\..*\.[0-9];' .
./articles/nanobsd/article.xml:	<title>Using &man.ftp.1;</title>
./articles/nanobsd/article.xml:	<title>Using &man.ssh.1;</title>
./articles/nanobsd/article.xml:	<title>Using &man.nc.1;</title>
./books/arch-handbook/jail/chapter.xml:        <title>&man.jail.2; System Call</title>
./books/fdp-primer/sgml-primer/chapter.xml:	    <title><filename>.profile</filename>, for &man.sh.1; and
./books/fdp-primer/sgml-primer/chapter.xml:	    <title><filename>.cshrc</filename>, for &man.csh.1; and
./books/handbook/bsdinstall/chapter.xml:	      <title>Writing the Image with &man.dd.1;</title>
./books/handbook/config/chapter.xml:    <title>Tuning with &man.sysctl.8;</title>
./books/handbook/config/chapter.xml:      <title>&man.sysctl.8; Read-only</title>
./books/handbook/disks/chapter.xml:      <title>Using &man.sysinstall.8;</title>
./books/handbook/disks/chapter.xml:      <title>Serial Access with &man.sa.4;</title>
./books/handbook/disks/chapter.xml:      <title>Swap Encryption with &man.gbde.8;</title>
./books/handbook/disks/chapter.xml:      <title>Swap Encryption with &man.geli.8;</title>
./books/handbook/install/chapter.xml:	      <title>Writing the Image with &man.dd.1;</title>
./books/handbook/mac/chapter.xml:    <title>The &man.mac.seeotheruids.4; Module</title>
./books/handbook/mac/chapter.xml:    <title>The &man.mac.bsdextended.4; Module</title>
./books/handbook/mac/chapter.xml:    <title>The &man.mac.ifoff.4; Module</title>
./books/handbook/mac/chapter.xml:    <title>The &man.mac.portacl.4; Module</title>
./books/handbook/mac/chapter.xml:    <title>The &man.mac.partition.4; Module</title>
./books/handbook/mac/chapter.xml:      <title>Error: &man..secure.path.3; cannot stat
./books/handbook/users/chapter.xml:      <title>Adding a Group Using &man.pw.8;</title>
./books/handbook/users/chapter.xml:      <title>Adding a New Member to a Group Using &man.pw.8;</title>
./books/handbook/users/chapter.xml:      <title>Using &man.id.1; to Determine Group Membership</title>
kobe:/hg/freebsd/doc-work/en_US.ISO8859-1$
%%%

If there are no serious objections I'll convert all of these to the
text-only version of the same manpage(section) at first, to fix the
immediate rendering problem.  Then if/when I find a way to automatically
do the right thing in <title> elements, I'll do that too.



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20130226171905.GA10642>