Contents[+]
  1. A docbook document[+]
    1. Lists[+]
      1. Itemized List
      2. Ordered List
      3. Variable List
    2. Simple text formatting
    3. Footnotes
    4. Quotes
    5. Trademarks and Copyrights
    6. Preformatted Data
    7. Tables
    8. Objects[+]
      1. Image embedded in a sentence
      2. Video with caption
      3. Audio with caption
      4. Invalid media format

A docbook document

This page shows the different features of our native DocBook support. A table of contents is automatically generated from section titles.

Lists

Itemized List

Markup:
<itemizedlist>
  <listitem>
    <para>Item 1
    </para>
  </listitem>
  <listitem>
    <para>Item 2
    </para>
  </listitem>
  <listitem>
    <para> Item 3
    </para>
  </listitem>
</itemizedlist>
Results:

  • Item 1

  • Item 2

  • Item 3

Ordered List

Markup:
<orderedlist numeration="lowerroman">
  <listitem>
    <para>One</para>
  </listitem>
  <listitem>
    <para>Two</para>
  </listitem>
  <listitem>
    <para>Three</para>
  </listitem>
  <listitem>
    <para>Four</para>
  </listitem>
</orderedlist>
Results:

  1. One

  2. Two

  3. Three

  4. Four

Variable List

Markup:
<variablelist><title>Font Filename Extensions</title>
  <varlistentry>
    <term><filename>TTF</filename></term>
    <listitem>
      <para>TrueType fonts.</para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><filename>PFA</filename></term>
    <term><filename>PFB</filename></term>
    <listitem>
      <para>
        PostScript fonts. <filename>PFA</filename> files are common
        on <acronym>UNIX</acronym> systems, <filename>PFB</filename>
        files are more common on Windows systems.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
Results:
TTF

TrueType fonts.

PFA
PFB

PostScript fonts. PFA files are common on UNIX systems, PFB files are more common on Windows systems.

Simple text formatting

Markup:
<para>
<emphasis role="bold">This</emphasis> paragraph contains
<emphasis>some <emphasis>emphasized</emphasis> text</emphasis>
and a <superscript>super</superscript>script
and a <subscript>sub</subscript>script.
</para>
Results:

This paragraph contains some emphasized text and a superscript and a subscript.

Footnotes

Markup:
<para>An annual percentage rate (<abbrev>APR</abbrev>) of 13.9%
<footnote>
The prime rate, as published in the Wall Street
Journal on the first business day of the month,
plus 7.0%.
</footnote>
will be charged on all balances carried forward.
</para>
Results:

An annual percentage rate (APR) of 13.9% 1 will be charged on all balances carried forward.

Quotes

Markup:
<para>This software is provided <quote>as is</quote>, without expressed
or implied warranty.
</para>
Results:

This software is provided as is, without expressed or implied warranty.

Trademarks and Copyrights

Markup:
<para><trademark class='registered'>Nutshell Handbook</trademark> is a
registered trademark of O'Reilly Media, Inc.
</para><para>
<trademark class="copyright">2014 Joe Doe</trademark>
</para><para>
<trademark class="trade">Foo Bar</trademark> is an unregistered trademark.
</para><para>
<trademark class="service">Foo Bar</trademark> is an unregistered servicemark.
</para>
Results:

Nutshell Handbook® is a registered trademark of O'Reilly Media, Inc.

© 2014 Joe Doe

Foo Bar™ is an unregistered trademark.

Foo BarSM is an unregistered servicemark.

Preformatted Data

Markup:
<screen><![CDATA[
<para>
My  preformatted      data.

Remove blanks from "] ] >" below:
</para>
] ] ></screen>
Results:
<para>
My  preformatted      data.

Remove blanks from "] ] >" below:
</para>
Markup:
<link xlink:href="http://moinmo.in/">MoinMoin rocks</link>
Results:

MoinMoin rocks

Markup:
<link xlink:href="../Sibling">Sibling of this page</link>
Results:

Sibling of this page

Markup:
<link xlink:href="/SubItem">SubItem of this page</link>
Results:

SubItem of this page

Markup:
<link xlink:href="../../Home">wiki_root based path to Home</link>
Results:

wiki_root based path to Home

linkend to anchor in this page

Markup:
<link linkend="Video_with_caption">linkend to Video with caption</link>
Results:

linkend to Video with caption

Tables

Markup:
<table frame='all'><title>Sample Table</title>
<tgroup cols='5' align='left' colsep='1' rowsep='1'>
<colspec colname='c1'/>
<colspec colname='c2'/>
<colspec colname='c3'/>
<colspec colnum='5' colname='c5'/>
<thead>
<row>
  <entry namest="c1" nameend="c2" morecols='1' align="center">Horizontal Span</entry>
  <entry>a3</entry>
  <entry>a4</entry>
  <entry>a5</entry>
</row>
</thead>
<tfoot>
<row>
  <entry>f1</entry>
  <entry>f2</entry>
  <entry>f3</entry>
  <entry>f4</entry>
  <entry>f5</entry>
</row>
</tfoot>
<tbody>
<row>
  <entry>b1</entry>
  <entry>b2</entry>
  <entry>b3</entry>
  <entry>b4</entry>
  <entry morerows='1' valign='middle'><para>  <!-- Pernicous Mixed Content -->
  Vertical Span</para></entry>
</row>
<row>
  <entry>c1</entry>
  <entry namest="c2" nameend="c3" morecols='1' align='center' morerows='1' valign='bottom'>Span Both</entry>
  <entry>c4</entry>
</row>
<row>
  <entry>d1</entry>
  <entry>d4</entry>
  <entry>d5</entry>
</row>
</tbody>
</tgroup>
</table>
Results:
Horizontal Spana3a4a5
f1f2f3f4f5
b1b2b3b4

Vertical Span

c1Span Bothc4
d1d4d5

Note: Moin2 does not support the "tgroup" or "title" tags within a table. Moin2 does not support the entry tag attributes of "namest" and "nameend". Use the "morecols" attribute as an alternative.

Objects

Image embedded in a sentence

An "inlinemediaobject" may be positioned within a paragraph and aligned to the text top, middle, or bottom through use of the align attribute.

Markup:
<para>
Here is an image
<inlinemediaobject>
  <imageobject>
    <imagedata format="png" align="middle" fileref="help-common/logo.png"/>
  </imageobject><caption>My Logo</caption>
</inlinemediaobject>
embedded in a sentence.
</para>
Results:

Here is an image help-common/logo.pngMy Logo embedded in a sentence.

Video with caption

A "mediaobject" is a block level element that may be positioned to the left, center, or right through use of the align attribute.

Here is a video courtesy of http://techslides.com/sample-webm-ogg-and-mp4-video-files-for-html5/. This video has a caption.

Markup:
<mediaobject>
  <videoobject>
    <videodata fileref="help-common/video.mp4" align="center"/>
  </videoobject>
  <caption>MY VIDEO</caption>
</mediaobject>
Results:
MY VIDEO

Audio with caption

Here is a sound, courtesy of http://www.mediacollege.com/audio/tone/download/. The align="center" attribute centers the object.

Markup:
<mediaobject>
  <audioobject>
    <audiodata align="center" fileref="help-common/audio.mp3"/>
  </audioobject>
  <caption>My Audio</caption>
</mediaobject>
Results:
My Audio

Invalid media format

Display textobject when an invalid format is specified.

Markup:
<mediaobject>
  <audioobject><audiodata format="qqq" fileref="audio.mp3"/>
  </audioobject>
  <textobject>The media format "qqq" is not supported!</textobject>
</mediaobject>
Results:

The media format "qqq" is not supported!

1 The prime rate, as published in the Wall Street Journal on the first business day of the month, plus 7.0%.