From: | Michael Glaesemann <grzm(at)myrealbox(dot)com> |
---|---|
To: | pgsql-docs(at)postgresql(dot)org |
Cc: | pgsql-hackers(at)postgresql(dot)org |
Subject: | Linking the previously separated documentation |
Date: | 2004-02-09 03:15:31 |
Message-ID: | 381A237E-5AAE-11D8-98AB-000A95C88220@myrealbox.com |
Views: | Raw Message | Whole Thread | Download mbox | Resend email |
Thread: | |
Lists: | pgsql-docs pgsql-hackers |
Hello all!
I've been eyeing providing links between the previously separated
documentation books, e.g., linking this sentence "Please familiarize
yourself with the pg_dump reference page." in the backup and restore
section <http://www.postgresql.org/docs/current/static/backup.html> to
the applicable reference page. I haven't gone through all of the docs
yet (there are a lot of them!) and right now I'm just looking for
obvious linking possibilities of the "see foo" variety. Is anyone else
working on something like this? Is it worthwhile?
If so, I've got a question as to style. My first idea was not to change
the text at all, and just replace (in the above example) "pg_dump" with
<xref linkend="APP-PGDUMP">. Should I be rewriting these sections or is
what I'm doing agreeable? (Might not be a bad idea to work up a style
book for the documentation to guide writing, but that's a project in
and of itself.)
If everything seems fine, I'll see if I can't figure out how to submit
a patch.
Michael Glaesemann
grzm myrealbox com
From | Date | Subject | |
---|---|---|---|
Next Message | Tom Lane | 2004-02-09 05:16:44 | Re: [HACKERS] Linking the previously separated documentation |
Previous Message | Enver ALTIN | 2004-01-28 17:01:34 | Re: small typo in doc |
From | Date | Subject | |
---|---|---|---|
Next Message | Mark Kirkwood | 2004-02-09 03:52:54 | CVS HEAD compile failure on Freebsd 4.9 |
Previous Message | Tom Lane | 2004-02-09 02:47:12 | Re: psql tab completion & USERSET vars |