DOCBOOK: Re: Which element should be used as a status ?

[Norman Walsh <ndw at nwalsh dot com>]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

/ Fr?éd?éric Glorieux <frederic dot glorieux at ajlsm dot com> was heard to say:
| I'm a newbie to Docbook (but not in XML and relative standards).
| I'm beginning a documentation in this schema, and I've got some (bad?)
| habits from other namespaces (standard or personal).
| For example, I'm usually using a <status/> element at the beginning of
| an article or a book (like in a W3C spec). What should I use in docbook
| for this meaning?

It depends on what you want to say. I often use a legalnotice as a
kind of status in *info elements (with an appropriate role). There's
also an attribute to show the publication status.

| <concept/> to tag the master idea of a block (useful for future
| indexation)

You can use indexterm to mark index terms, but DocBook doesn't have
the notion of an inline concept. The catch-all for things like this is
phrase with a role attribute.

| <definition/> or <dfn/> to tag the definition of the concept

Since DocBook is about software documentation, you can usually use the
tag that identifies what it is. The notion of an inline definition,
like a concept, isn't directly supported.

| <samp/> or <example/> to tag an example relative to the definition

Programlisting or screen or literallayout are common choices.

                                        Be seeing you,
                                          norm

- -- 
Norman Walsh <ndw at nwalsh dot com>      | So, are you working on finding
http://www.oasis-open.org/docbook/ | that bug now, or are you leaving
Chair, DocBook Technical Committee | it until later? Yes.
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.0.6 (GNU/Linux)
Comment: Processed by Mailcrypt 3.5.7 <http://mailcrypt.sourceforge.net/>

iD8DBQE+ZSsNOyltUcwYWjsRAkAXAJ9C4vO/ST94vDGKSi8LVvJGUq2BhQCgitTO
YkdNNm3PcdBU6Y9cK0h2yow=
=zYsU
-----END PGP SIGNATURE-----