~ubuntu-branches/ubuntu/utopic/asciidoc/utopic

« back to all changes in this revision

Viewing changes to doc/book.html

  • Committer: Bazaar Package Importer
  • Author(s): Alexander Wirt
  • Date: 2010-11-27 23:19:57 UTC
  • mfrom: (1.1.12 upstream) (3.1.6 sid)
  • Revision ID: james.westby@ubuntu.com-20101127231957-jxdmrk7z7lkcqy3l
Tags: 8.6.3-1
* New upstream version (Closes: #595324)
* Support asciidoc API (Closes: #526351)
* Depend on python >= 2.4 (Closes: #571303)
* Do not compress .txt files (Closes: #592423)
* Enhance asciidoc manpage (Closes: #499497)
* Move some of the Recommends (vim-addon-manager, source-highlight) to 
  Suggests (Closes: #564015)
* Bump standards version (No changes)
* Add README.Source file

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<?xml version="1.0" encoding="UTF-8"?>
2
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
 
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Book Title Goes Here</title><link rel="stylesheet" href="./docbook-xsl.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div xml:lang="en" class="book" title="Book Title Goes Here" lang="en"><div class="titlepage"><div><div><h1 class="title"><a id="id2504367"></a>Book Title Goes Here</h1></div><div><div class="author"><h3 class="author"><span class="firstname">Author's</span> <span class="surname">Name</span></h3></div></div><div><div class="revhistory"><table border="1" width="100%" summary="Revision history"><tr><th align="left" valign="top" colspan="3"><b>Revision History</b></th></tr><tr><td align="left">Revision 8.5.2</td><td align="left">7 December 2009</td><td align="left">AN</td></tr></table></div></div></div><hr /></div><div class="dedication" title="Dedication"><div class="titlepage"><div><div><h2 class="title"><a id="_example_dedication"></a>Dedication</h2></div></div></div><p>Optional dedication.</p><p>This document is an AsciiDoc book skeleton containing briefly
4
 
annotated example elements plus a couple of example index entries and
5
 
footnotes.</p><p>Books are normally used to generate DocBook markup and the titles of
6
 
the preface, appendix, bibliography, glossary and index sections are
7
 
significant (<span class="emphasis"><em>specialsections</em></span>).</p></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="preface"><a href="#_example_preface">Example Preface</a></span></dt><dd><dl><dt><span class="section"><a href="#_preface_sub_section">1. Preface Sub-section</a></span></dt></dl></dd><dt><span class="chapter"><a href="#_the_first_chapter">1. The First Chapter</a></span></dt><dd><dl><dt><span class="section"><a href="#X1">1.1. Sub-section with Anchor</a></span></dt><dd><dl><dt><span class="section"><a href="#_chapter_sub_section">1.1.1. Chapter Sub-section</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#_the_second_chapter">2. The Second Chapter</a></span></dt><dt><span class="chapter"><a href="#_the_third_chapter">3. The Third Chapter</a></span></dt><dt><span class="appendix"><a href="#_example_appendix">A. Example Appendix</a></span></dt><dd><dl><dt><span class="section"><a href="#_appendix_sub_section">A.1. Appendix Sub-section</a></span></dt></dl></dd><dt><span class="bibliography"><a href="#_example_bibliography">Example Bibliography</a></span></dt><dt><span class="glossary"><a href="#_example_glossary">Example Glossary</a></span></dt><dt><span class="index"><a href="#_example_index">Example Index</a></span></dt></dl></div><div class="preface" title="Example Preface"><div class="titlepage"><div><div><h2 class="title"><a id="_example_preface"></a>Example Preface</h2></div></div></div><p>Optional preface.</p><div class="section" title="1.&#xA0;Preface Sub-section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_preface_sub_section"></a>1. Preface Sub-section</h2></div></div></div><p>Preface sub-section body.</p></div></div><div class="chapter" title="Chapter&#xA0;1.&#xA0;The First Chapter"><div class="titlepage"><div><div><h2 class="title"><a id="_the_first_chapter"></a>Chapter 1. The First Chapter</h2></div></div></div><p>Chapters can contain sub-sections nested up to three deep.
8
 
<sup>[<a id="id2518617" href="#ftn.id2518617" class="footnote">1</a>]</sup>
9
 
<a id="id2526140" class="indexterm"></a></p><p>Chapters can have their own bibliography, glossary and index.</p><p>And now for something completely different: <a id="id2507034" class="indexterm"></a>monkeys, lions and
10
 
tigers (Bengal and Siberian) using the alternative syntax index
11
 
entries.
12
 
<a id="id2503761" class="indexterm"></a>
13
 
<a id="id2538667" class="indexterm"></a>
14
 
<a id="id2507771" class="indexterm"></a>
15
 
<a id="id2525991" class="indexterm"></a>
16
 
<a id="id2523259" class="indexterm"></a>
17
 
<a id="id2522364" class="indexterm"></a>
18
 
<a id="id2535005" class="indexterm"></a>
19
 
<a id="id2509675" class="indexterm"></a>
20
 
Note that multi-entry terms generate separate index entries.</p><p>Here are a couple of image examples: an <span class="inlinemediaobject"><img src="images/smallnew.png" alt="images/smallnew.png" /></span>
21
 
example inline image followed by an example block image:</p><div class="figure"><a id="id2532707"></a><p class="title"><b>Figure 1.1. Tiger block image</b></p><div class="figure-contents"><div class="mediaobject"><img src="images/tiger.png" alt="Tiger image" /></div></div></div><br class="figure-break" /><p>Followed by an example table:</p><div class="table"><a id="id2517275"></a><p class="title"><b>Table 1.1. An example table</b></p><div class="table-contents"><table summary="An example table" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; border-left: 3px solid #527bbd; border-right: 3px solid #527bbd; " width="60%"><colgroup><col /><col /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"> Option          </th><th style="border-bottom: 1px solid #527bbd; " align="left" valign="top"> Description</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>-a <span class="emphasis"><em>USER GROUP</em></span></p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Add <span class="emphasis"><em>USER</em></span> to <span class="emphasis"><em>GROUP</em></span>.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; " align="left" valign="top"><p>-R <span class="emphasis"><em>GROUP</em></span></p></td><td style="" align="left" valign="top"><p>Disables access to <span class="emphasis"><em>GROUP</em></span>.</p></td></tr></tbody></table></div></div><br class="table-break" /><div class="section" title="1.1.&#xA0;Sub-section with Anchor"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X1"></a>1.1. Sub-section with Anchor</h2></div></div></div><p>Sub-section at level 2.</p><div class="section" title="1.1.1.&#xA0;Chapter Sub-section"><div class="titlepage"><div><div><h3 class="title"><a id="_chapter_sub_section"></a>1.1.1. Chapter Sub-section</h3></div></div></div><p>Sub-section at level 3.</p><div class="section" title="1.1.1.1.&#xA0;Chapter Sub-section"><div class="titlepage"><div><div><h4 class="title"><a id="_chapter_sub_section_2"></a>1.1.1.1. Chapter Sub-section</h4></div></div></div><p>Sub-section at level 4.</p><p>This is the maximum sub-section depth supported by the distributed
22
 
AsciiDoc configuration.
23
 
<sup>[<a id="id2516661" href="#ftn.id2516661" class="footnote">2</a>]</sup></p></div></div></div><div class="footnotes"><br /><hr width="100" align="left" /><div class="footnote"><p><sup>[<a id="ftn.id2518617" href="#id2518617" class="simpara">1</a>] </sup>An example footnote.</p></div><div class="footnote"><p><sup>[<a id="ftn.id2516661" href="#id2516661" class="simpara">2</a>] </sup>A second example footnote.</p></div></div></div><div class="chapter" title="Chapter&#xA0;2.&#xA0;The Second Chapter"><div class="titlepage"><div><div><h2 class="title"><a id="_the_second_chapter"></a>Chapter 2. The Second Chapter</h2></div></div></div><p>An example link to anchor at start of the <a class="link" href="#X1" title="1.1.&#xA0;Sub-section with Anchor">first sub-section</a>.
24
 
<a id="id2529304" class="indexterm"></a></p><p>An example link to a bibliography entry <a class="xref" href="#taoup">[taoup]</a>.</p></div><div class="chapter" title="Chapter&#xA0;3.&#xA0;The Third Chapter"><div class="titlepage"><div><div><h2 class="title"><a id="_the_third_chapter"></a>Chapter 3. The Third Chapter</h2></div></div></div><p>Book chapters are at level 1 and can contain sub-sections.</p></div><div class="appendix" title="Appendix&#xA0;A.&#xA0;Example Appendix"><div class="titlepage"><div><div><h2 class="title"><a id="_example_appendix"></a>Appendix A. Example Appendix</h2></div></div></div><p>One or more optional appendixes go here at section level 1.</p><div class="section" title="A.1.&#xA0;Appendix Sub-section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_appendix_sub_section"></a>A.1. Appendix Sub-section</h2></div></div></div><p>Sub-section body.</p></div></div><div class="bibliography" title="Example Bibliography"><div class="titlepage"><div><div><h2 class="title"><a id="_example_bibliography"></a>Example Bibliography</h2></div></div></div><p>The bibliography list is a style of AsciiDoc bulleted list.</p><div class="bibliomixed"><a id="id2507003"></a><p class="bibliomixed">
25
 
<span class="bibliomisc">
26
 
<a id="taoup"></a>[taoup] Eric Steven Raymond. <span class="emphasis"><em>The Art of Unix
27
 
  Programming</em></span>. Addison-Wesley. ISBN 0-13-142901-9.
28
 
</span>
29
 
</p></div><div class="bibliomixed"><a id="id2533178"></a><p class="bibliomixed">
30
 
<span class="bibliomisc">
31
 
<a id="walsh-muellner"></a>[walsh-muellner] Norman Walsh &amp; Leonard Muellner.
32
 
  <span class="emphasis"><em>DocBook - The Definitive Guide</em></span>. O’Reilly &amp; Associates. 1999.
33
 
  ISBN 1-56592-580-7.
34
 
</span>
35
 
</p></div></div><div class="glossary" title="Example Glossary"><div class="titlepage"><div><div><h2 class="title"><a id="_example_glossary"></a>Example Glossary</h2></div></div></div><p>Glossaries are optional. Glossaries entries are an example of a style
36
 
of AsciiDoc labeled lists.</p><dl><dt>
37
 
A glossary term
38
 
</dt><dd><p>
39
 
  The corresponding (indented) definition.
40
 
</p></dd><dt>
41
 
A second glossary term
42
 
</dt><dd><p>
43
 
  The corresponding (indented) definition.
44
 
</p></dd></dl></div><div class="colophon" title="Colophon"><h2 class="title"><a id="_example_colophon"></a>Colophon</h2><p>Text at the end of a book describing facts about its production.</p></div><div class="index" title="Example Index"><div class="titlepage"><div><div><h2 class="title"><a id="_example_index"></a>Example Index</h2></div></div></div><div class="index"><div class="indexdiv"><h3>B</h3><dl><dt>Bengal Tiger, <a class="indexterm" href="#_the_first_chapter">The First Chapter</a></dt><dt>Big cats</dt><dd><dl><dt>Lions, <a class="indexterm" href="#_the_first_chapter">The First Chapter</a></dt><dt>Tigers</dt><dd><dl><dt>Bengal Tiger, <a class="indexterm" href="#_the_first_chapter">The First Chapter</a></dt><dt>Siberian Tiger, <a class="indexterm" href="#_the_first_chapter">The First Chapter</a></dt></dl></dd></dl></dd></dl></div><div class="indexdiv"><h3>E</h3><dl><dt>Example index entry, <a class="indexterm" href="#_the_first_chapter">The First Chapter</a></dt></dl></div><div class="indexdiv"><h3>L</h3><dl><dt>Lions, <a class="indexterm" href="#_the_first_chapter">The First Chapter</a></dt></dl></div><div class="indexdiv"><h3>M</h3><dl><dt>monkeys, <a class="indexterm" href="#_the_first_chapter">The First Chapter</a></dt></dl></div><div class="indexdiv"><h3>S</h3><dl><dt>Second example index entry, <a class="indexterm" href="#_the_second_chapter">The Second Chapter</a></dt><dt>Siberian Tiger, <a class="indexterm" href="#_the_first_chapter">The First Chapter</a></dt></dl></div><div class="indexdiv"><h3>T</h3><dl><dt>Tigers</dt><dd><dl><dt>Bengal Tiger, <a class="indexterm" href="#_the_first_chapter">The First Chapter</a></dt><dt>Siberian Tiger, <a class="indexterm" href="#_the_first_chapter">The First Chapter</a></dt></dl></dd></dl></div></div></div></div></body></html>