[dapper] xreflabel considered harmful

Matthew East mdke at ubuntu.com
Sat Apr 15 22:39:31 UTC 2006


On Sat, 2006-04-15 at 10:25 -0700, Jordan Mantha wrote:
> > To give an example of the changes that need to be made:
> >
> > <sect1 id="codecs" xreflabel="Multimedia Codecs" status="complete">
> >
> > Will become:
> >
> > <sect1 id="codecs" status="complete">
> >
> > Please could each document maintainer grep through the source and remove
> > all of these? I've done it for the Ubuntu Desktop Guide, and I'll do
> > About Ubuntu too.
> >
> > You don't need to generate new pots, as these are not in the pot files
> > anyway.
> 
> Hmm, so what do we use to replace xreflabel? Is there an alternate way
> of specifing the text of the link? If we just take it out completely
> I'll need to adjust the packaging guide so that the text makes sense.

Why? You should just take it out completely, then the link uses the text
from the section's title. You shouldn't need to change any strings. In
terms of making sense, the stylesheets should deal with it. So a section
with a title of "Bug Trackers", referred to in a linkend, will generally
appear like this with most stylesheets: "the section called Bug
Trackers". With the Yelp stylesheets, it will often look something like
"Chapter 5, Bug Trackers".

It really shouldn't be any problem simply to remove them.

Matt
-- 
mdke at ubuntu.com
gnupg pub 1024D/0E6B06FF
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 191 bytes
Desc: This is a digitally signed message part
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20060415/15b84c72/attachment.pgp>


More information about the ubuntu-doc mailing list