Re: [HACKERS] Linking the previously separated documentation

From: Peter Eisentraut <peter_e(at)gmx(dot)net>
To: Michael Glaesemann <grzm(at)myrealbox(dot)com>, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
Cc: pgsql-docs(at)postgresql(dot)org, pgsql-hackers(at)postgresql(dot)org
Subject: Re: [HACKERS] Linking the previously separated documentation
Date: 2004-02-09 09:23:58
Message-ID: 200402091023.58803.peter_e@gmx.net
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-hackers

Michael Glaesemann wrote:
> If I'm understanding you correctly, that's what I'm doing. Here's an
> example of the change:
>
> Original:
> Please familiarize yourself with the
> <citerefentry><refentrytitle>pg_dump</> reference page.
>
> Revised:
> Please familiarize yourself with the
> <citerefentry><refentrytitle><xref linkend="APP-PGDUMP"></></>
> reference page.

If you write xref then you already say that this is a cross-reference,
so you don't need the citerefentry element. (citerefentry is typically
used to automatically link all occurences to the location of the
manpage. For instance, FreeBSD uses it to link all refentry
"citations" to their online manpage gateway.)

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Michael Glaesemann 2004-02-09 10:50:30 Re: [HACKERS] Linking the previously separated documentation
Previous Message Michael Glaesemann 2004-02-09 05:57:13 Re: [HACKERS] Linking the previously separated documentation

Browse pgsql-hackers by date

  From Date Subject
Next Message Peter Eisentraut 2004-02-09 09:29:53 Re: psql variables
Previous Message Peter Eisentraut 2004-02-09 09:19:51 Re: Advice regarding configuration parameters