Thread: Doc changes

Doc changes

From
Rod Taylor
Date:
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

Re: Doc changes

From
Rod Taylor
Date:
All that and I forgot the patch -- attached.


On Sun, 2003-02-23 at 10:45, Rod Taylor wrote:
> 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

Re: Doc changes

From
Bruce Momjian
Date:
Your patch has been added to the PostgreSQL unapplied patches list at:

    http://momjian.postgresql.org/cgi-bin/pgpatches

I will try to apply it within the next 48 hours.

---------------------------------------------------------------------------


Rod Taylor wrote:
-- Start of PGP signed section.
> All that and I forgot the patch -- attached.
>
>
> On Sun, 2003-02-23 at 10:45, Rod Taylor wrote:
> > 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, skipping... ]
-- End of PGP section, PGP failed!

--
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 359-1001
  +  If your life is a hard drive,     |  13 Roberts Road
  +  Christ can be your backup.        |  Newtown Square, Pennsylvania 19073

Re: Doc changes

From
Rod Taylor
Date:
Peter decided he didn't like this.

Please skip it.

On Mon, 2003-03-17 at 12:47, Bruce Momjian wrote:
> Your patch has been added to the PostgreSQL unapplied patches list at:
>
>     http://momjian.postgresql.org/cgi-bin/pgpatches
>
> I will try to apply it within the next 48 hours.
>
> ---------------------------------------------------------------------------
>
>
> Rod Taylor wrote:
> -- Start of PGP signed section.
> > All that and I forgot the patch -- attached.
> >
> >
> > On Sun, 2003-02-23 at 10:45, Rod Taylor wrote:
> > > 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, skipping... ]
> -- End of PGP section, PGP failed!
--
Rod Taylor <rbt@rbt.ca>

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

Attachment

Re: Doc changes

From
Bruce Momjian
Date:
Patch removed at request of author.

---------------------------------------------------------------------------

Rod Taylor wrote:
-- Start of PGP signed section.
> All that and I forgot the patch -- attached.
>
>
> On Sun, 2003-02-23 at 10:45, Rod Taylor wrote:
> > 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, skipping... ]
-- End of PGP section, PGP failed!

--
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 359-1001
  +  If your life is a hard drive,     |  13 Roberts Road
  +  Christ can be your backup.        |  Newtown Square, Pennsylvania 19073

Re: Doc changes

From
Bruce Momjian
Date:
Thanks, removed.

---------------------------------------------------------------------------

Rod Taylor wrote:
-- Start of PGP signed section.
> Peter decided he didn't like this.
>
> Please skip it.
>
> On Mon, 2003-03-17 at 12:47, Bruce Momjian wrote:
> > Your patch has been added to the PostgreSQL unapplied patches list at:
> >
> >     http://momjian.postgresql.org/cgi-bin/pgpatches
> >
> > I will try to apply it within the next 48 hours.
> >
> > ---------------------------------------------------------------------------
> >
> >
> > Rod Taylor wrote:
> > -- Start of PGP signed section.
> > > All that and I forgot the patch -- attached.
> > >
> > >
> > > On Sun, 2003-02-23 at 10:45, Rod Taylor wrote:
> > > > 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, skipping... ]
> > -- End of PGP section, PGP failed!
> --
> Rod Taylor <rbt@rbt.ca>
>
> PGP Key: http://www.rbt.ca/rbtpub.asc
-- End of PGP section, PGP failed!

--
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 359-1001
  +  If your life is a hard drive,     |  13 Roberts Road
  +  Christ can be your backup.        |  Newtown Square, Pennsylvania 19073