From owner-freebsd-doc@FreeBSD.ORG  Wed Jun 19 10:52:45 2013
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
Delivered-To: freebsd-doc@freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org [8.8.178.115])
 by hub.freebsd.org (Postfix) with ESMTP id 42EC1F37
 for <freebsd-doc@freebsd.org>; Wed, 19 Jun 2013 10:52:45 +0000 (UTC)
 (envelope-from gabor@FreeBSD.org)
Received: from server.mypc.hu (server.mypc.hu [87.229.73.95])
 by mx1.freebsd.org (Postfix) with ESMTP id 0258918A5
 for <freebsd-doc@freebsd.org>; Wed, 19 Jun 2013 10:52:44 +0000 (UTC)
Received: from server.mypc.hu (localhost [127.0.0.1])
 by server.mypc.hu (Postfix) with ESMTP id 6BEAF14D250A;
 Wed, 19 Jun 2013 12:43:30 +0200 (CEST)
X-Virus-Scanned: amavisd-new at !change-mydomain-variable!.example.com
Received: from server.mypc.hu ([127.0.0.1])
 by server.mypc.hu (server.mypc.hu [127.0.0.1]) (amavisd-new, port 10024)
 with LMTP id PekrkSzxFWrY; Wed, 19 Jun 2013 12:43:23 +0200 (CEST)
Received: from [192.168.0.10] (54034B4D.catv.pool.telekom.hu [84.3.75.77])
 (using TLSv1 with cipher DHE-RSA-CAMELLIA256-SHA (256/256 bits))
 (No client certificate requested)
 by server.mypc.hu (Postfix) with ESMTPSA id 126DE14D242E;
 Wed, 19 Jun 2013 12:43:23 +0200 (CEST)
Message-ID: <51C18B3C.4040503@FreeBSD.org>
Date: Wed, 19 Jun 2013 12:43:08 +0200
From: Gabor Kovesdan <gabor@FreeBSD.org>
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64;
 rv:22.0) Gecko/20100101 Thunderbird/22.0
MIME-Version: 1.0
To: Dru Lavigne <dru.lavigne@att.net>, freebsd-doc@freebsd.org
Subject: Re: correct way to do links?
References: <1371497056.46380.YahooMailClassic@web184902.mail.gq1.yahoo.com>
In-Reply-To: <1371497056.46380.YahooMailClassic@web184902.mail.gq1.yahoo.com>
Content-Type: text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding: 7bit
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.14
Precedence: list
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/options/freebsd-doc>,
 <mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc>
List-Post: <mailto:freebsd-doc@freebsd.org>
List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
 <mailto:freebsd-doc-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Wed, 19 Jun 2013 10:52:45 -0000

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