Re: House style for DocBook documentation? - Mailing list pgsql-hackers

From Chapman Flack
Subject Re: House style for DocBook documentation?
Date
Msg-id 59163962-7234-71b9-e88e-6e9c8bd17264@anastigmatix.net
Whole thread Raw
In response to Re: House style for DocBook documentation?  (Peter Eisentraut <peter.eisentraut@2ndquadrant.com>)
Responses Re: House style for DocBook documentation?
List pgsql-hackers
On 3/8/19 7:38 AM, Peter Eisentraut wrote:
> On 2019-03-08 05:04, Chapman Flack wrote:
>> -o  If you want to supply text, use <link>, else <xref>
>> +o  If you want to supply text, use <link> or <ulink>, else <xref>
> 
> The choice of <link> vs <xref> is for internal links.  For external
> links you have to use <ulink>.

Understood, but I was thinking of the unintended message possibly
taken by a fast reader who wants to create an external link but also
wants to supply text. "I want to supply text! Is ulink not an option?"

Perhaps:

o  For an internal link, use <link> if you will supply text, else <xref>
o  For an external link, use <ulink> with or without link text

-Chap


pgsql-hackers by date:

Previous
From: Alvaro Herrera
Date:
Subject: Re: PostgreSQL vs SQL/XML Standards
Next
From: Amit Langote
Date:
Subject: Re: Update does not move row across foreign partitions in v11