correct way to do links?

Gabor Kovesdan gabor at FreeBSD.org
Wed Jun 19 10:52:45 UTC 2013


Em 17-06-2013 21:24, Dru Lavigne escreveu:
> 1. Links to another section within the same document.
>
> 2. Links to another book or article within the FDP.
>
> 3. Links to an external website.
>
> What is the correct usage for Docbook 4/5 for each type of link?
>
> 1. Links to another section within the same document:
>
> Is this a <link> with the description to appear specified or an <xref> with the section automatically rendered?
Yes.
>
> 2. Links to another book or article within the FDP:
>
> Is this a <link> with the description to appear specified or an <xref> with the section automatically rendered?
No. These work in a single documentation only. The best solution 
currently available is using <ulink> with a link to the XHTML version of 
the document at the FreeBSD website. The drawback of this is that it 
hardcodes the URL into the documents. A more XML-friendly solution would 
be olinking but it has never been configured and used in FreeBSD's 
DocBook sources. It could be a longer-term target to change to that but 
for now, <ulink> will do.
>
> 3. Should links to an external website use a <ulink> tag, an url=, and the description to appear? For example:
>
> <ulink url="http://www.wi-fi.org/">Wi-Fi alliance</ulink>
Yes.

Gabor



More information about the freebsd-doc mailing list