OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.


Help: OASIS Mailing Lists Help | MarkMail Help

docbook message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]

Subject: Better documentation for option/optional

I have a long-standing action item to improve the documentation for
option[1] and optional[2]. I propose to discharge this action by changing
the description of option to read:

<para><sgmltag>Option</sgmltag> identifies an argument to a software
command or instruction. Options may or may not be required. The
<sgmltag>optional</sgmltag> element can be used to explicitly identify
options that are not required.

                                        Be seeing you,

[1] http://docbook.org/tdg/en/html/option.html
[2] http://docbook.org/tdg/en/html/optional.html

Norman Walsh <ndw@nwalsh.com>      | Two starving men cannot be twice
http://www.oasis-open.org/docbook/ | as hungry as one; but two rascals
Chair, DocBook Technical Committee | can be ten times as vicious as
                                   | one.--George Bernard Shaw

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]