Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 17 Jun 2013 12:24:16 -0700 (PDT)
From:      Dru Lavigne <dru.lavigne@att.net>
To:        freebsd-doc@freebsd.org
Subject:   correct way to do links?
Message-ID:  <1371497056.46380.YahooMailClassic@web184902.mail.gq1.yahoo.com>

next in thread | raw e-mail | index | archive | help
I'm updating http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/xml-markup-docbook.html, section "4.2.7 Links" to make sure how to do these 3 types of links is crystal clear:

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?

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?

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>

Cheers,

Dru






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