O'Reilly logo

DocBook 5: The Definitive Guide by Richard L. Hamilton, Norman Walsh

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

Name

seg — An element of a list item in a segmented list

Synopsis

seg ::= (text | Bibliography inlines | Error inlines | Graphic inlines | GUI inlines | Indexing inlines | Keyboard inlines | Linking inlines | Markup inlines | Math inlines | Object-oriented programming inlines | Operating system inlines | Product inlines | Programming inlines | Publishing inlines | Technical inlines | Ubiquitous inlines)*

Description

A segmentedlist consists of a set of headings (segtitles) and a list of parallel sets of elements. Every seglistitem contains a set of elements that have a one-to-one correspondence with the headings. Each of these elements is contained in a seg.

Processing expectations

Segmented lists can be formatted in a number of ways. Two popular formats are tabular and as a list of repeated headings and elements. In a tabular presentation, each seg is a cell in the body of the table. In the list presentation, each seg occurs next to the appropriate heading.

DocBook cannot detect errors caused by too many or too few segs in a seglistitem. You will have to rely on external processes to find those errors.

Examples

See segmentedlist for an example that uses this element.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required