index
An index to a book or part of a book
Element information
Namespace: http://docbook.org/ns/docbook
Schema document: docbook.xsd
Type: Anonymous
Properties: Global, Qualified
Content
- Sequence [1..1]
- Choice [1..1]
- Sequence [1..1]
- Choice [0..*]
- title The text of the title of a section of a document or of a formal block-level element
- titleabbrev The abbreviation of a title
- subtitle The subtitle of a document
- info [0..1] A wrapper for information about a component or other block without a title
from group db._titlefrom group db.titleforbidden.info - Choice [0..*]
- Sequence [1..1]
- Choice [0..*]
- itemizedlist A list in which each entry is marked with a bullet or other dingbat
- orderedlist A list in which each entry is marked with a sequentially incremented label
- procedure A list of operations to be performed in a well-defined sequence
- simplelist An undecorated list of single words or short phrases
- variablelist A list in which each entry is composed of a set of one or more terms and an associated description
- segmentedlist A segmented list, a list of sets of elements
- glosslist A wrapper for a list of glossary entries
- bibliolist A wrapper for a list of bibliography entries
- calloutlist A list of callout s
- qandaset A question-and-answer set
- example A formal example, with a title
- figure A formal figure, generally an illustration, with a title
- table A formal table in a document
- table A formal (captioned) HTML table in a document
- equation A displayed mathematical equation
- informalexample A displayed example without a title
- informalfigure A untitled figure
- informaltable A table without a title
- informaltable An HTML table without a title
- informalequation A displayed mathematical equation without a title
- sidebar A portion of a document that is isolated from the main narrative flow
- blockquote A quotation set off from the main text
- epigraph A short inscription at the beginning of a document or component
- address A real-world address, generally a postal address
- screenshot A representation of what the user sees or might see on a computer screen
- mediaobject A displayed media object (video, audio, image, etc.)
- procedure A list of operations to be performed in a well-defined sequence
- task A task to be completed
- productionset A set of EBNF productions
- constraintdef The definition of a constraint in an EBNF production
- msgset A detailed set of messages, usually error messages
- literallayout A block of text in which line breaks and white space are to be reproduced faithfully
- screen Text that a user sees or might see on a computer screen
- programlistingco A program listing with associated areas used in callouts
- screenco A screen with associated areas used in callouts
- synopsis A general-purpose element for representing the syntax of commands or functions
- programlisting A literal listing of all or part of a program
- bridgehead A free-floating heading
- remark A remark (or comment) intended for presentation in a draft manuscript
- revhistory A history of the revisions to a document
- indexterm A wrapper for an indexed term
- indexterm A wrapper for an indexed term that covers a range
- indexterm Identifies the end of a range associated with an indexed term
- cmdsynopsis A syntax summary for a software command
- funcsynopsis The syntax summary for a function definition
- classsynopsis The syntax summary for a class definition
- fieldsynopsis The name of a field in a class definition
- constructorsynopsis A syntax summary for a constructor
- destructorsynopsis A syntax summary for a destructor
- methodsynopsis A syntax summary for a method
- anchor A spot in the document
- para A paragraph
- formalpara A paragraph with a title
- simpara A paragraph that contains only text and inline markup, no block elements
- annotation An annotation
from group db.nopara.blocksfrom group db.list.blocksfrom group db.formal.blocksfrom group db.table.choicefrom group db.cals.tablefrom group db.html.tablefrom group db.informal.blocksfrom group db.informaltable.choicefrom group db.cals.informaltablefrom group db.html.informaltablefrom subst. group db.publishing.blocksfrom subst. group db.graphic.blocksfrom group db.technical.blocksfrom subst. group db.verbatim.blocksfrom group db.indextermfrom group db.indexterm.singularfrom group db.indexterm.startofrangefrom group db.indexterm.endofrangefrom subst. group db.synopsis.blocksfrom group db.para.blocks - Choice [1..1]
- indexdiv [0..*] A division in an index
- indexentry [0..*] An entry in an index
- segmentedlist A segmented list, a list of sets of elements
from group db._infofrom group db.all.blocks - Choice [1..1]
Attributes
| Name | Occ | Type | Description | Notes |
|---|---|---|---|---|
| role | [0..1] | xsd:anySimpleType | from group db.index.attlist | |
| xml:id | [0..1] | Unspecified | from group db.common.attributes | |
| version | [0..1] | xsd:anySimpleType | Specifies the DocBook version of the element and its descendants | from group db.common.base.attributes |
| xml:lang | [0..1] | Unspecified | from group db.common.base.attributes | |
| xml:base | [0..1] | Unspecified | from group db.common.base.attributes | |
| remap | [0..1] | xsd:anySimpleType | Provides the name or similar semantic identifier assigned to the content in some previous markup scheme | from group db.common.base.attributes |
| xreflabel | [0..1] | xsd:anySimpleType | Provides the text that is to be generated for a cross reference to the element | from group db.common.base.attributes |
| revisionflag | [0..1] | db.revisionflag.enumeration | Identifies the revision status of the element | from group db.common.base.attributes |
| dir | [0..1] | db.dir.enumeration | Identifies the direction of text in an element | from group db.common.base.attributes |
| arch | [0..1] | xsd:anySimpleType | Designates the computer or chip architecture to which the element applies | from group db.effectivity.attributes |
| audience | [0..1] | xsd:anySimpleType | Designates the intended audience to which the element applies, for example, system administrators, programmers, or new users. | from group db.effectivity.attributes |
| condition | [0..1] | xsd:anySimpleType | provides a standard place for application-specific effectivity | from group db.effectivity.attributes |
| conformance | [0..1] | xsd:anySimpleType | Indicates standards conformance characteristics of the element | from group db.effectivity.attributes |
| os | [0..1] | xsd:anySimpleType | Indicates the operating system to which the element is applicable | from group db.effectivity.attributes |
| revision | [0..1] | xsd:anySimpleType | Indicates the editorial revision to which the element belongs | from group db.effectivity.attributes |
| security | [0..1] | xsd:anySimpleType | Indicates something about the security level associated with the element to which it applies | from group db.effectivity.attributes |
| userlevel | [0..1] | xsd:anySimpleType | Indicates the level of user experience for which the element applies | from group db.effectivity.attributes |
| vendor | [0..1] | xsd:anySimpleType | Indicates the computer vendor to which the element applies. | from group db.effectivity.attributes |
| wordsize | [0..1] | xsd:anySimpleType | Indicates the word size (width in bits) of the computer architecture to which the element applies | from group db.effectivity.attributes |
| annotations | [0..1] | xsd:anySimpleType | Identifies one or more annotations that apply to this element | from group db.common.attributes |
| linkend | [0..1] | xsd:IDREF | Points to an internal link target by identifying the value of its xml:id attribute | from group db.common.linking.attributes |
| xlink:href | [0..1] | xsd:anySimpleType | from group db.common.linking.attributes | |
| xlink:role | [0..1] | xsd:anySimpleType | from group db.common.linking.attributes | |
| xlink:arcrole | [0..1] | xsd:anySimpleType | from group db.common.linking.attributes | |
| xlink:title | [0..1] | xsd:anySimpleType | from group db.xlink.title.attribute | |
| xlink:show | [0..1] | Anonymous | from group db.common.linking.attributes | |
| xlink:actuate | [0..1] | Anonymous | from group db.common.linking.attributes | |
| label | [0..1] | xsd:anySimpleType | Specifies an identifying string for presentation purposes | from group db.index.attlist |
| status | [0..1] | xsd:anySimpleType | Identifies the editorial or publication status of the element on which it occurs | from group db.index.attlist |
| type | [0..1] | xsd:anySimpleType | Specifies the target index for this term | from group db.index.attlist |
Used in
- Group db.navigation.components
- Anonymous type of element appendix via reference to db.component.contentmodel
- Anonymous type of element article via reference to db.navigation.components
- Anonymous type of element book via reference to db.navigation.components
- Anonymous type of element chapter via reference to db.component.contentmodel
- Anonymous type of element part via reference to db.part.components
- Anonymous type of element preface via reference to db.component.contentmodel
- Anonymous type of element sect1 via reference to db.navigation.components
- Anonymous type of element sect2 via reference to db.navigation.components
- Anonymous type of element sect3 via reference to db.navigation.components
- Anonymous type of element sect4 via reference to db.navigation.components
- Anonymous type of element sect5 via reference to db.navigation.components
- Anonymous type of element section via reference to db.navigation.components
- Group db.component.contentmodel via reference to db.navigation.components
- Group db.part.components via reference to db.navigation.components