docbook:note

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
linkend xs:IDREF optional
os optional
remap optional
revision optional
revisionflag restriction of xs:token optional
role optional
security optional
userlevel optional
vendor optional
version 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="note">
  <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:sequence>
    <xs:attribute name="role"/>
    <xs:attributeGroup ref="docbook:db.common.attributes"/>
    <xs:attributeGroup ref="docbook:db.common.linking.attributes"/>
  </xs:complexType>
</xs:element>

Sample

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

[...]

< title>

Finally in a namespace

</ title>

< para>

All DocBook V5.0 elements are in the namespace

< uri>

http://docbook.org/ns/docbook

</ uri>

.

< acronym>

XML

< alt>

Extensible Markup Language

</ alt>

</ acronym>

namespaces are used to distinguish between different element sets. In the last few years, almost all new XML grammars have used their own namespace. It is easy to create compound documents that contain elements from different XML vocabularies. DocBook V5.0 is following this design rule. Using namespaces in your documents is very easy. Consider this simple article marked up in DocBook V4.5:

</ para>

< programlisting>

<article> <title>Sample article</title> <para>This is a really short article.</para></article>

</ programlisting>

< para>

The corresponding DocBook V5.0 article will look very similar:

</ para>

< programlisting>

<article xmlns="http://docbook.org/ns/docbook" …> <title>Sample article</title> <para>This is a really short article.</para></article>

</ programlisting>

< para>

The only change is the addition of a default namespace declaration (

< code>

xmlns="http://docbook.org/ns/docbook"

</ code>

) on the root element. This declaration applies the namespace to the root element and all nested elements. Each element is now uniquely identified by its local name and namespace.

</ para>

< note>

< para>

The namespace name

< uri>

http://docbook.org/ns/docbook

</ uri>

serves only as an identifier. This resource is not fetched during processing of DocBook documents, and you are not required to have an Internet connection during processing. If you access the namespace URI with a browser, you will find a short explanatory document about the namespace. In the future this document will probably conform to (some version of) RDDL and provide pointers to related resources.

</ para>

</ note>

</ section>