%*.attrib; Parameter Entities
Prev | DocBook Parameter Entity Reference | Next

This is an alpha version of this book.

# `%*.attrib;` Parameter Entities

## Name

`%*.attrib;` Parameter Entities — Define attributes on selected elements

##

# Synopsis

These entities parameterize the attribute declarations on selected elements.

## Description

Each of the following sections describes an individual parameter entity.

### %common.table.attribs;

Parameter entity content:

    label		CDATA		#IMPLIED
    	id		ID		#IMPLIED
    	lang		CDATA		#IMPLIED
    	remap		CDATA		#IMPLIED
    	xreflabel	CDATA		#IMPLIED
    	revisionflag	(changed
    			|added
    			|deleted
    			|off)		#IMPLIED
    	arch		CDATA		#IMPLIED
            condition	CDATA		#IMPLIED
    	conformance	NMTOKENS	#IMPLIED
    	os		CDATA		#IMPLIED
    	revision	CDATA		#IMPLIED
            security	CDATA		#IMPLIED
    	userlevel	CDATA		#IMPLIED
    	vendor		CDATA		#IMPLIED

    	role		CDATA		#IMPLIED

%common.table.attribs; appears in:

`informaltable` |  |

### %condition.attrib;

Parameter entity content:

Name | Type | Default
condition | CDATA | None

### %graphics.attrib;

Parameter entity content:

Name | Type | Default
entityref | ENTITY | None
fileref | CDATA | None
format | Enumerated:
BMP
CGM-CHAR
CGM-BINARY
CGM-CLEAR
DITROFF
DVI
EPS
EQN
FAX
GIF
GIF87a
GIF89a
JPG
JPEG
IGES
PCX
PIC
PNG
PS
SGML
TBL
TEX
TIFF
WMF
WPG
linespecific
| None
srccredit | CDATA | None
width | CDATA | None
depth | CDATA | None
align | Enumerated:
left
right
center
| None
scale | CDATA | None
scalefit | CDATA | None

%graphics.attrib; appears in:

`graphic` | `inlinegraphic` |

### %keyaction.attrib;

Parameter entity content:

Name | Type | Default
action | Enumerated:
click
double-click
press
seq
simul
other
| None
otheraction | CDATA | None

%keyaction.attrib; appears in:

`keycombo` | `shortcut` |

### %label.attrib;

Parameter entity content:

Name | Type | Default
label | CDATA | None

%label.attrib; appears in:

`appendix` | `area` | `areaset`
`book` | `chapter` | `cmdsynopsis`
`co` | `equation` | `example`
`figure` | `footnote` | `footnoteref`
`funcsynopsis` | `informalfigure` | `lot`
`part` | `partintro` | `reference`
`sect1` | `sect2` | `sect3`
`sect4` | `sect5` | `section`
`synopsis` | `tocback` | `tocchap`
`tocfront` |  |

### %linespecific.attrib;

Parameter entity content:

Name | Type | Default
format | Enumerated notation:
linespecific
| 'linespecific'
linenumbering | Enumerated:
numbered
unnumbered
| None

%linespecific.attrib; appears in:

`address` | `classsynopsisinfo` | `funcsynopsisinfo`
`literallayout` | `programlisting` | `screen`
`synopsis` |  |

### %linkend.attrib;

Parameter entity content:

Name | Type | Default
linkend | IDREF | None

%linkend.attrib; appears in:

`firstterm` | `glossterm` | `lotentry`
`seeie` | `tocback` | `tocentry`
`tocfront` |  |

### %linkendreq.attrib;

Parameter entity content:

Name | Type | Default
linkend | IDREF | Required

%linkendreq.attrib; appears in:

`footnoteref` | `link` | `synopfragmentref`
`xref` |  |

### %linkends.attrib;

Parameter entity content:

Name | Type | Default
linkends | IDREFS | None

%linkends.attrib; appears in:

`area` | `co` | `primaryie`
`secondaryie` | `seealsoie` | `tertiaryie`

### %mark.attrib;

Parameter entity content:

Name | Type | Default
mark | CDATA | None

%mark.attrib; appears in:

`itemizedlist` |  |

### %moreinfo.attrib;

Parameter entity content:

Name | Type | Default
moreinfo | Enumerated:
refentry
none
| 'none'

%moreinfo.attrib; appears in:

`action` | `application` | `command`
`computeroutput` | `database` | `errorcode`
`filename` | `function` | `guibutton`
`guiicon` | `guilabel` | `guimenu`
`guimenuitem` | `guisubmenu` | `hardware`
`interface` | `keycap` | `keycombo`
`literal` | `menuchoice` | `mousebutton`
`parameter` | `prompt` | `property`
`shortcut` | `systemitem` | `userinput`

### %objectdata.attrib;

Parameter entity content:

Name | Type | Default
entityref | ENTITY | None
fileref | CDATA | None
format | Enumerated:
BMP
CGM-CHAR
CGM-BINARY
CGM-CLEAR
DITROFF
DVI
EPS
EQN
FAX
GIF
GIF87a
GIF89a
JPG
JPEG
IGES
PCX
PIC
PNG
PS
SGML
TBL
TEX
TIFF
WMF
WPG
linespecific
| None
srccredit | CDATA | None

%objectdata.attrib; appears in:

`audiodata` | `imagedata` | `videodata`

### %pagenum.attrib;

Parameter entity content:

Name | Type | Default
pagenum | CDATA | None

%pagenum.attrib; appears in:

`anchor` | `beginpage` | `indexterm`
`lotentry` | `title` | `toc`
`tocback` | `tocentry` | `tocfront`

### %required-IDREF-to-constraintdef-ID;

Parameter entity content:

    linkend IDREF #REQUIRED

%required-IDREF-to-constraintdef-ID; appears in:

`constraint` |  |

### %required-IDREF-to-production-ID;

Parameter entity content:

    linkend IDREF #REQUIRED

%required-IDREF-to-production-ID; appears in:

`productionrecap` |  |

### %required-XLink-to-production-ID;

Parameter entity content:

    def CDATA #REQUIRED

%required-XLink-to-production-ID; appears in:

`nonterminal` |  |

### %role.attrib;

Parameter entity content:

Name | Type | Default
role | CDATA | None

%role.attrib; appears in:

`constraint` | `constraintdef` | `lhs`
`nonterminal` | `production` | `productionrecap`
`productionset` | `rhs` |

### %security.attrib;

Parameter entity content:

Name | Type | Default
security | CDATA | None

### %status.attrib;

Parameter entity content:

Name | Type | Default
status | CDATA | None

%status.attrib; appears in:

`appendix` | `article` | `bibliodiv`
`bibliography` | `book` | `chapter`
`colophon` | `dedication` | `glossary`
`glossdiv` | `part` | `preface`
`refentry` | `reference` | `refsect1`
`refsect2` | `refsect3` | `sect1`
`sect2` | `sect3` | `sect4`
`sect5` | `section` | `set`

### %width.attrib;

Parameter entity content:

Name | Type | Default
width | CDATA | None

%width.attrib; appears in:

`example` | `informalexample` | `literallayout`
`programlisting` | `screen` |

Prev | Home | Next
%*.attlist; Parameter Entities | Up | %*.attval; Parameter Entities

Copyright © 1999, 2000, 2001 O'Reilly & Associates, Inc.