docbook:example

Element Information

Model

Attributes

QName Type Fixed Default Use Inheritable Annotation
annotations optional
arch optional
audience optional
condition optional
conformance optional
dir restriction of xs:token optional
floatstyle optional
label optional
linkend xs:IDREF optional
os optional
pgwide restriction of xs:token optional
remap optional
revision optional
revisionflag restriction of xs:token optional
role optional
security optional
userlevel optional
vendor optional
version optional
width xs:NMTOKEN optional
wordsize optional
xlink:actuate xlink:actuateType optional
xlink:arcrole xlink:arcroleType optional
xlink:href xlink:hrefType optional
xlink:role xlink:roleType optional
xlink:show xlink:showType optional
xlink:title xlink:titleAttrType optional
xlink:type xlink:typeType optional
xml:base xs:anyURI optional
See http://www.w3.org/TR/xmlbase/ for
information about this attribute.
xml:id xs:ID optional
See http://www.w3.org/TR/xml-id/ for
information about this attribute.
xml:lang union of(xs:language, restriction of xs:string) optional
Attempting to install the relevant ISO 2- and 3-letter
         codes as the enumerated possible values is probably never
         going to be a realistic possibility.  See
         RFC 3066 at http://www.ietf.org/rfc/rfc3066.txt and the IANA registry
         at http://www.iana.org/assignments/lang-tag-apps.htm for
         further information.

         The union allows for the 'un-declaration' of xml:lang with
         the empty string.
xreflabel optional

Used By

Source

<xs:element name="example">
  <xs:complexType>
    <xs:sequence>
      <xs:sequence>
        <xs:choice minOccurs="0" maxOccurs="unbounded">
          <xs:element ref="docbook:title"/>
          <xs:element ref="docbook:titleabbrev"/>
        </xs:choice>
        <xs:element minOccurs="0" ref="docbook:info"/>
      </xs:sequence>
      <xs:choice maxOccurs="unbounded">
        <xs:element ref="docbook:itemizedlist"/>
        <xs:element ref="docbook:orderedlist"/>
        <xs:element ref="docbook:procedure"/>
        <xs:element ref="docbook:simplelist"/>
        <xs:element ref="docbook:variablelist"/>
        <xs:element ref="docbook:segmentedlist"/>
        <xs:element ref="docbook:glosslist"/>
        <xs:element ref="docbook:bibliolist"/>
        <xs:element ref="docbook:calloutlist"/>
        <xs:element ref="docbook:qandaset"/>
        <xs:element ref="docbook:example"/>
        <xs:element ref="docbook:figure"/>
        <xs:element ref="docbook:table"/>
        <xs:element ref="docbook:equation"/>
        <xs:element ref="docbook:informalexample"/>
        <xs:element ref="docbook:informalfigure"/>
        <xs:element ref="docbook:informaltable"/>
        <xs:element ref="docbook:informalequation"/>
        <xs:element ref="docbook:sidebar"/>
        <xs:element ref="docbook:blockquote"/>
        <xs:element ref="docbook:address"/>
        <xs:element ref="docbook:epigraph"/>
        <xs:element ref="docbook:mediaobject"/>
        <xs:element ref="docbook:screenshot"/>
        <xs:element ref="docbook:task"/>
        <xs:element ref="docbook:productionset"/>
        <xs:element ref="docbook:constraintdef"/>
        <xs:element ref="docbook:msgset"/>
        <xs:element ref="docbook:screen"/>
        <xs:element ref="docbook:literallayout"/>
        <xs:element ref="docbook:programlistingco"/>
        <xs:element ref="docbook:screenco"/>
        <xs:element ref="docbook:programlisting"/>
        <xs:element ref="docbook:synopsis"/>
        <xs:element ref="docbook:bridgehead"/>
        <xs:element ref="docbook:remark"/>
        <xs:element ref="docbook:revhistory"/>
        <xs:element ref="docbook:indexterm"/>
        <xs:element ref="docbook:funcsynopsis"/>
        <xs:element ref="docbook:classsynopsis"/>
        <xs:element ref="docbook:methodsynopsis"/>
        <xs:element ref="docbook:constructorsynopsis"/>
        <xs:element ref="docbook:destructorsynopsis"/>
        <xs:element ref="docbook:fieldsynopsis"/>
        <xs:element ref="docbook:cmdsynopsis"/>
        <xs:element ref="docbook:caution"/>
        <xs:element ref="docbook:important"/>
        <xs:element ref="docbook:note"/>
        <xs:element ref="docbook:tip"/>
        <xs:element ref="docbook:warning"/>
        <xs:element ref="docbook:anchor"/>
        <xs:element ref="docbook:para"/>
        <xs:element ref="docbook:formalpara"/>
        <xs:element ref="docbook:simpara"/>
        <xs:element ref="docbook:annotation"/>
      </xs:choice>
      <xs:element minOccurs="0" ref="docbook:caption"/>
    </xs:sequence>
    <xs:attribute name="role"/>
    <xs:attributeGroup ref="docbook:db.common.attributes"/>
    <xs:attributeGroup ref="docbook:db.common.linking.attributes"/>
    <xs:attribute name="label"/>
    <xs:attribute name="floatstyle"/>
    <xs:attribute name="width" type="xs:NMTOKEN"/>
    <xs:attribute name="pgwide">
      <xs:simpleType>
        <xs:restriction base="xs:token">
          <xs:enumeration value="0"/>
          <xs:enumeration value="1"/>
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
  </xs:complexType>
</xs:element>

Sample

< section xmlns = "http://docbook.org/ns/docbook" xml:id = "introduction-rng" >

< title>

Relaxing with DocBook

</ title>

< para>

For more than a decade, the DocBook schema was defined using a DTD. However, DTDs have serious limitations, and DocBook V5.0 is thus defined using a very powerful schema language called RELAX NG. Thanks to RELAX NG, it is now much easier to create customized versions of DocBook, and some content models are now cleaner and more precise.

</ para>

< para>

Using RELAX NG has an impact on the document prolog. The following example shows the typical prolog of a DocBook V4.x document. The version of the DocBook DTD (in this case 4.5) is indicated in the document type declaration (!DOCTYPE) which points to a particular version of the DTD.

</ para>

< example xml:id = "ex.docbook45" >

< title>

DocBook V4.5 document

</ title>

< programlisting>

<?xml version="1.0" encoding="utf-8"?><!DOCTYPE article PUBLIC '-//OASIS//DTD DocBook XML V4.5//EN' 'http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd'><article lang="en"> <title>Sample article</title> <para>This is a very short article.</para></article>

</ programlisting>

</ example>

< para>

In contrast, DocBook V5.0 does not depend on DTDs anymore. This mean that there is no document type declaration and the version of DocBook used is indicated with the

< tag class = "attribute" >

version

</ tag>

attribute instead.

</ para>

< example xml:id = "ex.docbook5" >

< title>

DocBook V5.0 document

</ title>

< programlisting>

<?xml version="1.0" encoding="utf-8"?><article xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en"> <title>Sample article</title> <para>This is a very short article.</para></article>

</ programlisting>

</ example>