DocBook 5: The Definitive Guide

Name

ListItem -- A wrapper for the elements of a list item

Synopsis

Content Model

ListItem ::= ((CalloutList|GlossList|ItemizedList|OrderedList|SegmentedList| SimpleList|VariableList|Caution|Important|Note|Tip|Warning| LiteralLayout|ProgramListing|ProgramListingCO|Screen|ScreenCO| ScreenShot|Synopsis|CmdSynopsis|FuncSynopsis|FormalPara|Para| SimPara|Address|BlockQuote|Graphic|GraphicCO|MediaObject| MediaObjectCO|InformalEquation|InformalExample|InformalFigure| InformalTable|Equation|Example|Figure|Table|MsgSet|Procedure| Sidebar|QandASet|Anchor|BridgeHead|Comment|Highlights|Abstract| AuthorBlurb|Epigraph|IndexTerm)+)

Attributes

Common attributes

Tag Minimization

The start-tag is required for this element. The end-tag is optional, if your SGML declaration allows minimization.

Description

The ListItem element is a wrapper around an item in a list. In an ItemizedList or an OrderedList, the ListItem surrounds the entire list item. In a VariableList, ListItem surrounds the "definition" part of the list item.

Processing expectations

Formatted as a displayed block. List items usually generate the appropriate mark (a number or bullet) and appear indented, next to the mark. In a VariableList, the presentation may be influenced by the length of the Term or Terms that precede the list item and by attributes on the list itself.

Parents

These elements contain ListItem: ItemizedList, OrderedList, VarListEntry.

Children

The following elements occur in ListItem: Abstract, Address, Anchor, AuthorBlurb, BlockQuote, BridgeHead, CalloutList, Caution, CmdSynopsis, Comment, Epigraph, Equation, Example, Figure, FormalPara, FuncSynopsis, GlossList, Graphic, GraphicCO, Highlights, Important, IndexTerm, InformalEquation, InformalExample, InformalFigure, InformalTable, ItemizedList, LiteralLayout, MediaObject, MediaObjectCO, MsgSet, Note, OrderedList, Para, Procedure, ProgramListing, ProgramListingCO, QandASet, Screen, ScreenCO, ScreenShot, SegmentedList, Sidebar, SimPara, SimpleList, Synopsis, Table, Tip, VariableList, Warning.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

In some contexts, the following elements are excluded: Caution, Equation, Example, Figure, Important, IndexTerm, InformalTable, Note, Table, Tip, Warning.

Attributes

Override

Override specifies the keyword for the type of mark to be used on this ListItem instead of the mark currently in use for the list.

See Also

CalloutList, ItemizedList, OrderedList, SegmentedList, SimpleList, VariableList

Examples

For examples, see Highlights, ItemizedList, OrderedList, Para, RefEntry, VariableList, XRef.

Back to: DocBook: The Definitive Guide