unionsynopsis

V5.2unionsynopsis

unionsynopsis — The syntax summary for a union-of-types definition.

Synopsis

unionsynopsis ::=

Sequence of:
- info? (db.titleforbidden.info)
- Zero or more of:
  - synopsisinfo
- Zero or more of:
  - modifier
  - package
- unionname?
- union
- Zero or more of:
  - modifier
  - package
- Zero or more of:
  - synopsisinfo

Attributes

Common attributes and common linking attributes.

Additional attributes:

language
ordered (enumeration)
- “0”
- “1”
packageref

Additional Constraints

If this element is the root element, it must have a version attribute.

Description

A unionsynopsis contains the syntax summary of a union (generally speaking, unions programming language sense).

This is one of the few places where DocBook attempts to model as well as describe. The content model of unionsynopsis was designed to capture a wide range of semantics.

Processing expectations

Formatted inline.

Attributes

Common attributes and common linking attributes.

any attribute

Any attribute in any other explicit namespace

language

Identifies the language (i.e. programming language) of the content

ordered

Indicates how the value of a union is specified.

Enumerated values:
“0”	Value of enum is specified explicitly using enumvalue
“1”	Value of enum is inferred from its position

packageref

Identifies the package to which this synopsis (logically) belongs

Parents

These elements contain unionsynopsis: abstract, acknowledgements, annotation, answer, appendix, article, bibliodiv, bibliography, bibliolist, blockquote, callout, calloutlist, caption (db.caption), caution, chapter, colophon, constraintdef, cover, danger, dedication, entry, example, figure, footnote, glossary, glossdef, glossdiv, glosslist, important, index, indexdiv, informalexample, informalfigure, itemizedlist, legalnotice, listitem, meta (db.meta.content), msgexplan, msgtext, note, orderedlist, packagesynopsis, para, partintro, preface, procedure, qandadiv, qandaset, question, refsect1, refsect2, refsect3, refsection, refsynopsisdiv, result, revdescription, sect1, sect2, sect3, sect4, sect5, section, setindex, sidebar, simplesect, step, taskprerequisites, taskrelated, tasksummary, td, textobject, th, tip, toc, tocdiv, topic, variablelist, warning.

Children

The following elements occur in unionsynopsis: info (db.titleforbidden.info), modifier, package, synopsisinfo, union, unionname.