Re: House style for DocBook documentation?

From: Chapman Flack <chap(at)anastigmatix(dot)net>
To: Peter Eisentraut <peter(dot)eisentraut(at)2ndquadrant(dot)com>, Alvaro Herrera <alvherre(at)2ndquadrant(dot)com>
Cc: Pavel Stehule <pavel(dot)stehule(at)gmail(dot)com>, Markus Winand <markus(dot)winand(at)winand(dot)at>, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>, PostgreSQL Hackers <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: House style for DocBook documentation?
Date: 2019-03-08 14:38:29
Message-ID: 59163962-7234-71b9-e88e-6e9c8bd17264@anastigmatix.net
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: 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

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Amit Langote 2019-03-08 14:43:29 Re: Update does not move row across foreign partitions in v11
Previous Message Alvaro Herrera 2019-03-08 14:31:06 Re: PostgreSQL vs SQL/XML Standards