beginpage
Prev | DocBook Element Reference | Next

This is an alpha version of this book.

# beginpage

## Name

beginpage — The location of a page break in a print version of the document

##

# Synopsis

### Content Model

    beginpage ::=
    EMPTY

### Attributes

Common attributes

Name | Type | Default
pagenum | CDATA | None

### Parameter Entities

The following parameter entities contain beginpage:

Parameter Entities
`%admon.mix;` | `%bookcomponent.content;` | `%component.mix;`
`%cptr.char.mix;` | `%divcomponent.mix;` | `%example.mix;`
`%figure.mix;` | `%glossdef.mix;` | `%indexdivcomponent.mix;`
`%legalnotice.mix;` | `%para.char.mix;` | `%refcomponent.mix;`
`%refinline.char.mix;` | `%sidebar.mix;` | `%smallcptr.char.mix;`
`%tbl.entry.mdl;` | `%word.char.mix;` |

## Description

The `BeginPage` element marks the location of an actual page break in a print version of the document, as opposed to where a page break might appear in a further rendition of the document. This information may be used, for example, to allow support staff using an online system to coordinate with a user referring to a page number in a printed manual.

### Processing expectations

The break identified by `BeginPage` may be displayed in an online version of the document or used for legacy purposes, but it is not expected to cause a page break when the document is processed by an SGML system.

### Parents

These elements contain beginpage: `abbrev`, `accel`, `acronym`, `action`, `appendix`, `application`, `article`, `attribution`, `bibliodiv`, `bibliography`, `bibliomisc`, `blockquote`, `callout`, `caution`, `chapter`, `citation`, `citetitle`, `classname`, `classsynopsisinfo`, `command`, `computeroutput`, `constant`, `constraintdef`, `database`, `dedication`, `emphasis`, `entry`, `envar`, `errorcode`, `errorname`, `errortype`, `example`, `exceptionname`, `figure`, `filename`, `firstterm`, `foreignphrase`, `funcparams`, `funcsynopsisinfo`, `function`, `glossary`, `glossdef`, `glossdiv`, `glosssee`, `glossseealso`, `glossterm`, `guibutton`, `guiicon`, `guilabel`, `guimenu`, `guimenuitem`, `guisubmenu`, `hardware`, `important`, `index`, `indexdiv`, `informalexample`, `informalfigure`, `initializer`, `interface`, `interfacename`, `keycap`, `keycode`, `keysym`, `label`, `legalnotice`, `lineannotation`, `link`, `listitem`, `literal`, `literallayout`, `lot`, `lotentry`, `manvolnum`, `markup`, `medialabel`, `member`, `methodname`, `modifier`, `mousebutton`, `msgaud`, `msgexplan`, `msglevel`, `msgorig`, `msgtext`, `note`, `olink`, `option`, `optional`, `para`, `parameter`, `part`, `partintro`, `phrase`, `preface`, `procedure`, `productname`, `programlisting`, `prompt`, `property`, `quote`, `refentry`, `refentrytitle`, `reference`, `refpurpose`, `refsect1`, `refsect2`, `refsect3`, `refsynopsisdiv`, `remark`, `returnvalue`, `screen`, `screeninfo`, `sect1`, `sect2`, `sect3`, `sect4`, `sect5`, `section`, `seg`, `setindex`, `sgmltag`, `sidebar`, `simpara`, `simplesect`, `step`, `structfield`, `structname`, `symbol`, `synopsis`, `systemitem`, `term`, `tip`, `toc`, `tocback`, `tocentry`, `tocfront`, `token`, `type`, `ulink`, `userinput`, `varname`, `warning`, `wordasword`.

## Attributes

pagenum

  `PageNum` contains the page number of the page in the printed document which begins at the location of the `BeginPage` element.

## Examples

For examples, see `chapter` .

Prev | Home | Next
authorinitials | Up | bibliodiv

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