This is the mail archive of the docbook@lists.oasis-open.org mailing list for the DocBook project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

[docbook] 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.
</para>

                                        Be seeing you,
                                          norm

[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

To unsubscribe from this list, send a post to docbook-unsubscribe@lists.oasis-open.org, or visit http://www.oasis-open.org/mlmanage/.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]