Linking the previously separated documentation

Поиск
Список
Период
Сортировка
От Michael Glaesemann
Тема Linking the previously separated documentation
Дата
Msg-id 381A237E-5AAE-11D8-98AB-000A95C88220@myrealbox.com
обсуждение исходный текст
Ответы Re: Linking the previously separated documentation  (Tom Lane <tgl@sss.pgh.pa.us>)
Список 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


В списке pgsql-hackers по дате отправления:

Предыдущее
От: Tom Lane
Дата:
Сообщение: Re: psql tab completion & USERSET vars
Следующее
От: Mark Kirkwood
Дата:
Сообщение: CVS HEAD compile failure on Freebsd 4.9