Skip to Content
DocBook 5: The Definitive Guide
book

DocBook 5: The Definitive Guide

by Norman Walsh, Richard L. Hamilton
May 2010
Intermediate to advanced
552 pages
13h 37m
English
O'Reilly Media, Inc.
Content preview from DocBook 5: The Definitive Guide

Name

indexterm — A wrapper for an indexed term that covers a range

Synopsis

indexterm (db.indexterm.startofrange) ::= (primary?, ((secondary, ((tertiary, (seealso+ | see)?) | seealso+ | see)?) | seealso+ | see)?)

Attribute synopsis

Common attributes and common linking attributes.

Additional attributes:

  • class (enumeration) = “startofrange”

  • pagenum

  • scope (enumeration) = “all” | “global” | “local”

  • significance (enumeration) = “normal” | “preferred”

  • type

  • zone (IDREFS)

Required attributes are shown in bold.

Description

A “start of range” indexterm marks the start of a range. It must have an associated “end of range” indexterm. The resulting index entry applies to the entire range. See indexterm (db.indexterm.singular).

Processing expectations

See indexterm (db.indexterm.singular).

It is possible to construct index terms that are difficult to parse at best and totally illogical at worst. Consider the following:

<indexterm class='startofrange' zone="id1 id2">...</indexterm>

There is no way that this can fit into the semantics of an indexterm. Although it claims to be the start of a range, it does not have an xml:id for the end-of-range indexterm to point back to. In addition, it includes zoned terms, and mixing the two different methods for indicating a range in the same indexterm is probably a bad idea.

Attributes

Common attributes and common linking attributes.

class

Identifies the class of index term

Enumerated values:
“startofrange”

The start of a range

pagenum

Indicates the page on which this index term occurs ...

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.

Read now

Unlock full access

More than 5,000 organizations count on O’Reilly

AirBnbBlueOriginElectronic ArtsHomeDepotNasdaqRakutenTata Consultancy Services

QuotationMarkO’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.
Julian F.
Head of Cybersecurity
QuotationMarkI wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.
Addison B.
Field Engineer
QuotationMarkI’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.
Amir M.
Data Platform Tech Lead
QuotationMarkI'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.
Mark W.
Embedded Software Engineer

You might also like

WebAssembly: The Definitive Guide

WebAssembly: The Definitive Guide

Brian Sletten
Spark: The Definitive Guide

Spark: The Definitive Guide

Bill Chambers, Matei Zaharia

Publisher Resources

ISBN: 9781449380243Errata