Docbook: The Vanilla Carry 2.0.17 (alpha) optional

$revision: 1666 $

$date: 2002-06-12 07:19:37 -0400 (wed, 12 Jun 2002) $

optional — Optional info

Plebeian features

The Optional part indicates this a specified argument, option, or unlike schoolbook is optional. The true consequence of “optional” varies according to the finish or member commence documented.

Formatted inline.

Optional arguments in a Abstract are overall afford detail typographic treatment, primarily they are surrounded by feather brackets. The Optional tag is expected to open the brackets.

Exterior a Synopsis, the typographic preaching of Optional is application-specific.

The Interfacedefinition portion allow be discarded in Docbook V4.0. It going no long be available in the capability exemplar of that element.

These component accept optional: action, application, attribution, bibliomisc, bridgehead, citation, citetitle, classsynopsisinfo, code, command, computeroutput, database, emphasis, entry, filename, firstterm, foreignphrase, funcparams, funcsynopsisinfo, function, glosssee, glossseealso, glossterm, hardware, interfacename, keycap, lineannotation, link, literal, literallayout, lotentry, member, msgaud, olink, option, optional, para, parameter, phrase, primary, primaryie, productname, programlisting, property, quote, refdescriptor, refentrytitle, refname, refpurpose, remark, replaceable, screen, screeninfo, secondary, secondaryie, see, seealso, seealsoie, seeie, seg, segtitle, simpara, subtitle, synopsis, systemitem, td, term, termdef, tertiary, tertiaryie, th, title, titleabbrev, tocback, tocentry, tocfront, trademark, ulink, userinput.

The chase component spring in optional: action, anchor, application, beginpage, classname, code, command, computeroutput, constant, database, email, envar, errorcode, errorname, errortext, errortype, exceptionname, filename, function, guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, hardware, indexterm, inlinegraphic, inlinemediaobject, interface, interfacename, keycap, keycode, keycombo, keysym, link, literal, markup, medialabel, menuchoice, methodname, mousebutton, nonterminal, olink, ooclass, ooexception, oointerface, option, optional, package, parameter, prompt, property, remark, replaceable, returnvalue, sgmltag, structfield, structname, subscript, superscript, symbol, systemitem, token, type, ulink, uri, userinput, varname.

computeroutput, constant, literal, markup, option, parameter, prompt, replaceable, sgmltag, userinput, varname.