Re: <application> vs <command>

From: Peter Eisentraut <peter_e(at)gmx(dot)net>
To: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
Cc: Bruce Momjian <pgman(at)candle(dot)pha(dot)pa(dot)us>, PostgreSQL-documentation <pgsql-docs(at)postgresql(dot)org>
Subject: Re: <application> vs <command>
Date: 2001-12-01 14:03:25
Message-ID: Pine.LNX.4.30.0111302007100.609-100000@peter.localdomain
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: 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(at)gmx(dot)net

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message Jan Wieck 2001-12-05 21:26:47 Re: PL/pgSQL examples NOT involving functions
Previous Message Peter Eisentraut 2001-11-30 18:13:05 Re: <application> vs <command>