Skip site navigation (1) Skip section navigation (2)

Re: Cross-referencing

From: Neil Conway <neilc(at)samurai(dot)com>
To: Jim Nasby <jnasby(at)pervasive(dot)com>
Cc: pgsql-docs(at)postgresql(dot)org
Subject: Re: Cross-referencing
Date: 2006-08-10 00:24:24
Message-ID: 1155169465.5129.20.camel@localhost (view raw or flat)
Thread:
Lists: pgsql-docs
On Wed, 2006-08-09 at 15:29 -0500, Jim Nasby wrote:
> It's always bugged me that the docs don't do a better job of cross- 
> referencing things. IE: if a webpage mentions pg_start_backup(), that  
> mention should be a link to the documentation for that  function.
> 
> Is there a historical reason for this?

When the documentation was split into separate DocBook books, you
couldn't link easily link between books. That has since changed. Several
people have been incrementally improving the cross-references, but there
is room for further improvement.

> Any reason not to change it?

If a phrase is mentioned multiple times within a short span of text, I
think we need only make a link out of the first mention. It would also
be nice to ensure the typesetting is consistent: for example, if we're
marking up "pg_start_backup" with <function>, it would be nice to ensure
that linked versions of same are typeset in a similar manner.

If you'd like to improve the cross-referencing, please go ahead and
submit patches.

-Neil



In response to

pgsql-docs by date

Next:From: Heejin MunDate: 2006-08-10 08:49:15
Subject: Re: During compiling sgml files, there is a error message...
Previous:From: Jim NasbyDate: 2006-08-09 20:29:04
Subject: Cross-referencing

Privacy Policy | About PostgreSQL
Copyright © 1996-2014 The PostgreSQL Global Development Group