option

The <option> element describes an option that can be used to modify a command (or something else, like a configuration). This element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts and reference information.

Contains

( text data )

Contained by

title, navtitle, searchtitle, shortdesc, section, example, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, alt, stentry, draft-comment, fn, cite, xref, linktext, linkinfo, entry, author, source, publisher, copyrholder, category, keywords, prodname, brand, series, platform, prognum, featnum, component, indexterm, prereq, context, cmd, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, refsyn, proptypehd, propvaluehd, propdeschd, proptype, propvalue, propdesc, uicontrol, screen, b, u, i, tt, sup, sub, codeph, codeblock, var, synph, oper, delim, sep, pt, pd, fragref, synnote, repsep, msgph, msgblock, filepath, userinput, systemoutput, coords

Inheritance

topic/keyword, pr-d/option

Attributes

Name	Description	Data Type	Default Value	Required?
keyref	Currently not implemented in DITA processors. Provides a key that a process can use to look up associated information.	NMTOKEN	#IMPLIED	No
%univ-atts; (%select-atts;, %id-atts;, translate, xml:lang)	A set of related attributes, described at %univ-atts;	parameter entity	PE not applicable	Not applicable
%global-atts; (xtrf, xtrc)	A set of related attributes, described at %global-atts;	parameter entity	PE not applicable	Not applicable
class, outputclass	Common attributes described in Other common DITA attributes

Example

something <option>/modifier</option>