important
important — An admonition set off from the text.
Synopsis
important ::=
- Sequence of:
- One of:
- One or more of:
bridgeheaddialoguedramaformalgrouppoetryremarkrevhistorystagedir- Indexing inlines
- Admonition elements
- Formal elements
- Graphic elements
- Informal elements
- List elements
- Paragraph elements
- Publishing elements
- Technical elements
- Verbatim elements
Attributes
Common attributes and common linking attributes.
No additional attributes.
Additional Constraints
- caution must not occur among the children or descendants of important
- danger must not occur among the children or descendants of important
- important must not occur among the children or descendants of important
- note must not occur among the children or descendants of important
- tip must not occur among the children or descendants of important
- warning must not occur among the children or descendants of important
Description
An important element is an admonition set off
from the main text.
In some types of documentation, the semantics of admonitions are
clearly defined (caution might imply the possibility
of harm to equipment whereas warning might imply harm
to a person), but DocBook makes no such assertions.
Processing expectations
Formatted as a displayed block. It often outputs the generated
text Important
or some other visible indication of the
type of admonition, especially if a title is not
present. Sometimes outputs a graphical icon or other symbol as
well.
Attributes
Common attributes and common linking attributes.
- any attribute
Any attribute in any other explicit namespace
Parents
These elements contain important: abstract, acknowledgements, answer, appendix, article, bibliodiv, bibliography, bibliolist, blockquote, callout, calloutlist, caption, caution, chapter, colophon, danger, dedication, dialogue, drama, entry, example, figure, footnote, glossary, glossdef, glossdiv, glosslist, important, index, informalexample, informalfigure, itemizedlist, legalnotice, linegroup, listitem, meta (db.meta.content), note, orderedlist, para, partintro, poetry, preface, procedure, qandadiv, qandaset, question, result, revdescription, section, setindex, sidebar, simplesect, step, taskprerequisites, taskrelated, tasksummary, textobject, tip, toc, variablelist, warning.
Children
The following elements occur in important: address, anchor, bibliolist, blockquote, bridgehead, calloutlist, caution, danger, dialogue, drama, epigraph, equation, example, figure, formalgroup, formalpara, glosslist, important, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), info (db.titleforbidden.info), info (db.titleonly.info), informalequation, informalexample, informalfigure, informaltable, itemizedlist, literallayout, mediaobject, note, orderedlist, para, poetry, procedure, qandaset, remark, revhistory, sidebar, simpara, simplelist, stagedir, table, task, tip, title, titleabbrev, variablelist, warning.
See Also
Examples
1 |<article xmlns='http://docbook.org/ns/docbook'>|<title>Example important</title>||<important>5 |<para>No user-servicable parts inside. Breaking this seal voids all warranties.|</para>|</important>||</article>
No user-servicable parts inside. Breaking this seal voids all warranties.