Re: vs - Mailing list pgsql-docs

From Peter Eisentraut
Subject Re: vs
Date
Msg-id Pine.LNX.4.30.0111302007100.609-100000@peter.localdomain
Whole thread Raw
In response to Re: vs  (Tom Lane <tgl@sss.pgh.pa.us>)
List pgsql-docs
Tom Lane writes:

> More generally, what are the standard set of markup tags that should be
> used?  I know that I tend to overuse <literal>foo</> because I'm not
> clear on the alternatives like <type>, <envar>, <option>, yadda yadda.
> It'd help if there were a list somewhere.


At docbook.org you can download (read online, buy, ...) "DocBook: The
Definitive Guide", which contains introductions to SGML, XML, DocBook,
stylesheets, plus a complete reference of all elements, what they're for
and what can go where.  I use it nearly every day.

As for what tags to use, it's difficult to keep track of the over a
hundred elements that DocBook has, but "when in doubt, use <literal>"
seems like a reasonable thing to do and it seems to fit the idea of the
element.

One day we might want to add some tags that fit our domain better, such as
<sqlcode> or <databaseobject>.

--
Peter Eisentraut   peter_e@gmx.net


pgsql-docs by date:

Previous
From: Peter Eisentraut
Date:
Subject: Re: vs
Next
From: Mayan
Date:
Subject: Running PostgreSQL @ bootup time