DocBook 5: The Definitive Guide

Name

Common Attribute Parameter Entities -- Parameter entities which define the common attributes

Synopsis

These parameter entities define the attributes that are considered "common". Common attributes occur on every element. They are provided by either the %common.attrib; parameter entity or the %idreq.common.attrib; parameter entity. Those parameter entities are defined in terms of the others, listed here.

Description

The following parameter entities define the common attributes in DocBook:

%common.attrib;

Parameterizes the common attributes on elements with an optional ID.

%id.attrib; %lang.attrib; %remap.attrib; %xreflabel.attrib; %revisionflag.attrib; %effectivity.attrib; %local.common.attrib;

idreq.common.attrib

Parameterizes the common attributes on elements with a required ID.

%idreq.attrib; %lang.attrib; %remap.attrib; %xreflabel.attrib; %revisionflag.attrib; %effectivity.attrib; %local.common.attrib;

%effectivity.attrib;

Parameterizes the effectivity attributes.

The effectivity attributes allow you to indicate when the content of an element applies to only a certain class of hardware or software or a particular level of user experience.

%arch.attrib; %conformance.attrib; %os.attrib; %revision.attrib; %userlevel.attrib; %vendor.attrib; %local.effectivity.attrib;

If you are not using effectivity attributes in your documents, removing them from your DTD, with a customization layer, greatly reduces the size of the ESIS. This can dramatically improve the processing speed of some applications.

%id.attrib;

Parameterizes the definition of the ID attribute.

Id is an identifying string for the element. It must be unique at least within the document and must begin with a letter.

Name	Type	Default
Id	ID	None

%idreq.attrib;

Parameterizes the definition of the required ID attribute.

Id is an identifying string for the element. It must be unique at least within the document and must begin with a letter.

Name	Type	Default
Id	ID	Required

%lang.attrib;

Parameterizes the definition of the Lang attribute.

Lang should be a language code drawn from ISO 639 (perhaps extended with a country code drawn from ISO 3166, as en_US). Use it when you need to signal your application to change hyphenation and other display characteristics.

Name	Type	Default
Lang	CDATA	None

%remap.attrib;

Parameterizes the definition of the Remap attribute.

Remap contains an element name or similar semantic identifier assigned to the content in a previous markup scheme.

Name	Type	Default
Remap	CDATA	None

%xreflabel.attrib;

Parameterizes the definition of the XRefLabel attribute.

XRefLabel holds text to be used when a cross reference (e.g. XRef) is made to the element.

Name	Type	Default
XRefLabel	CDATA	None

%revisionflag.attrib;

Parameterizes the definition of the RevisionFlag attribute.

RevisionFlag indicates the revision status of element; the default is that the element hasn't been revised. RevisionFlag is intended only for simple revision management: to track the entire history of a document use a proper revision control system. Use RevisionFlag for indicating changes from one version to the next, no more.

Name	Type	Default
RevisionFlag	Changed Added Deleted Off	None

%arch.attrib;

Parameterizes the definition of the Arch attribute.

Arch designates the computer or chip architecture to which the element applies.

Name	Type	Default
Arch	CDATA	None

%conformance.attrib;

Parameterizes the definition of the Conformance attribute.

Conformance indicates standards conformance characteristics of the item contained in the element. These characteristics are application-specific. DocBook provides no defaults.

Name	Type	Default
Conformance	NMTOKENS	None

%os.attrib;

Parameterizes the definition of the OS attribute.

OS indicates the operating system to which the element is applicable.

Name	Type	Default
OS	CDATA	None

%revision.attrib;

Parameterizes the definition of the Revision attribute.

Revision indicates the editorial revision to which the element belongs.

Name	Type	Default
Revision	CDATA	None

%userlevel.attrib;

Parameterizes the definition of the UserLevel attribute.

UserLevel indicates the level of user experience to which element applies.

Name	Type	Default
UserLevel	CDATA	None

%vendor.attrib;

Parameterizes the definition of the Vendor attribute.

Vendor identifies the company or organization that owns or resells the things described in the element to which it applies.

Name	Type	Default
Vendor	CDATA	None

Back to: DocBook: The Definitive Guide