DocBook 5: The Definitive Guide

Name

Highlights -- A summary of the main points of the discussed component

Synopsis

Content Model

Highlights ::= ((CalloutList|GlossList|ItemizedList|OrderedList|SegmentedList| SimpleList|VariableList|Caution|Important|Note|Tip|Warning| FormalPara|Para|SimPara|IndexTerm)+)

Attributes

Common attributes

Tag Minimization

Both the start- and end-tags are required for this element.

Parameter Entities

Description

Highlights are generally presented at the beginning of a component and offer some sort of summary of the main points that will be discussed.

Processing expectations

Formatted as a displayed block. Highlights often contain some sort of list.

Parents

These elements contain Highlights: Answer, Appendix, Article, BiblioDiv, Bibliography, BlockQuote, Callout, Chapter, Glossary, GlossDiv, Index, ListItem, MsgExplan, MsgText, PartIntro, Preface, Procedure, QandADiv, QandASet, Question, RefSect1, RefSect2, RefSect3, RefSynopsisDiv, Sect1, Sect2, Sect3, Sect4, Sect5, Section, SetIndex, Sidebar, SimpleSect, Step.

Children

The following elements occur in Highlights: CalloutList, Caution, FormalPara, GlossList, Important, IndexTerm, ItemizedList, Note, OrderedList, Para, SegmentedList, SimPara, SimpleList, Tip, VariableList, Warning.

In some contexts, the following elements are excluded: Caution, Important, IndexTerm, Note, Tip, Warning.

See Also

Abstract, BlockQuote, Epigraph, Sidebar

Examples

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> <chapter><title>Example Chapter</title> <highlights> <para> This chapter will teach you <itemizedlist> <listitem> <para> How to disassemble an automobile. </para> </listitem> <listitem> <para> How to properly carry the component pieces. </para> </listitem> <listitem> <para> How to reassemble an automobile in a standard telephone booth. </para> </listitem> </itemizedlist> </para> </highlights> <para>&hellip</para> </chapter>

Back to: DocBook: The Definitive Guide