Doc changes - Mailing list pgsql-patches

From Rod Taylor
Subject Doc changes
Date
Msg-id 1046015101.84130.180.camel@jester
Whole thread Raw
Responses Re: Doc changes
List pgsql-patches
If applied, a second pass on the docs will be made for format tweeking,
content sharing, and exporting more elements as synopfragments.


Sent to -docs:

I needed to make the synopsis areas more consistent for a side project.
By far the simplest way to do that was to change them into <cmdsynopsis>
entities.

Benefits include increased consistency in spacing and formatting, nice
<synopfragment> linkouts (click the (1)), and the ability to share
code.  It may be possible to generate railroad diagrams from the marked
up copy.

The biggest problem is you cannot indent sections anymore, but that may
be correctable with a stylesheet change.


New CREATE TABLE:
http://www.rbt.ca/docs/reference/sql-createtable.html#SQL-CREATETABLE-REFERENCES-FRAGMENT

Old CREATE TABLE:
http://candle.pha.pa.us/main/writings/pgsql/sgml/sql-createtable.html


Yes, I've updated psql's create_help.pl to deal with the SGML formatted
areas.
--
Rod Taylor <rbt@rbt.ca>

PGP Key: http://www.rbt.ca/rbtpub.asc

Attachment

pgsql-patches by date:

Previous
From: Rod Taylor
Date:
Subject: Re: [HACKERS] Allow pg_dump to dump sequences using NO_MAXVALUE
Next
From: Rod Taylor
Date:
Subject: Re: Doc changes