source: rtems-tools/doc/asciidoc/doc/book.txt @ f91e023

4.104.115
Last change on this file since f91e023 was f91e023, checked in by Chris Johns <chrisj@…>, on 02/17/14 at 07:04:46

Add the documentation.

  • Property mode set to 100644
File size: 3.6 KB
Line 
1Book Title Goes Here
2====================
3Author's Name
4v1.0, 2003-12
5:doctype: book
6
7
8[dedication]
9Example Dedication
10------------------
11Optional dedication.
12
13This document is an AsciiDoc book skeleton containing briefly
14annotated example elements plus a couple of example index entries and
15footnotes.
16
17Books are normally used to generate DocBook markup and the titles of
18the preface, appendix, bibliography, glossary and index sections are
19significant ('specialsections').
20
21
22[preface]
23Example Preface
24---------------
25Optional preface.
26
27Preface Sub-section
28~~~~~~~~~~~~~~~~~~~
29Preface sub-section body.
30
31
32The First Chapter
33-----------------
34Chapters can contain sub-sections nested up to three deep.
35footnote:[An example footnote.]
36indexterm:[Example index entry]
37
38Chapters can have their own bibliography, glossary and index.
39
40And now for something completely different: ((monkeys)), lions and
41tigers (Bengal and Siberian) using the alternative syntax index
42entries.
43(((Big cats,Lions)))
44(((Big cats,Tigers,Bengal Tiger)))
45(((Big cats,Tigers,Siberian Tiger)))
46Note that multi-entry terms generate separate index entries.
47
48Here are a couple of image examples: an image:images/smallnew.png[]
49example inline image followed by an example block image:
50
51.Tiger block image
52image::images/tiger.png[Tiger image]
53
54Followed by an example table:
55
56.An example table
57[width="60%",options="header"]
58|==============================================
59| Option          | Description
60| -a 'USER GROUP' | Add 'USER' to 'GROUP'.
61| -R 'GROUP'      | Disables access to 'GROUP'.
62|==============================================
63
64.An example example
65===============================================
66Lorum ipum...
67===============================================
68
69[[X1]]
70Sub-section with Anchor
71~~~~~~~~~~~~~~~~~~~~~~~
72Sub-section at level 2.
73
74Chapter Sub-section
75^^^^^^^^^^^^^^^^^^^
76Sub-section at level 3.
77
78Chapter Sub-section
79+++++++++++++++++++
80Sub-section at level 4.
81
82This is the maximum sub-section depth supported by the distributed
83AsciiDoc configuration.
84footnote:[A second example footnote.]
85
86
87The Second Chapter
88------------------
89An example link to anchor at start of the <<X1,first sub-section>>.
90indexterm:[Second example index entry]
91
92An example link to a bibliography entry <<taoup>>.
93
94
95The Third Chapter
96-----------------
97Book chapters are at level 1 and can contain sub-sections.
98
99
100:numbered!:
101
102[appendix]
103Example Appendix
104----------------
105One or more optional appendixes go here at section level 1.
106
107Appendix Sub-section
108~~~~~~~~~~~~~~~~~~~
109Sub-section body.
110
111
112[bibliography]
113Example Bibliography
114--------------------
115The bibliography list is a style of AsciiDoc bulleted list.
116
117[bibliography]
118.Books
119- [[[taoup]]] Eric Steven Raymond. 'The Art of Unix
120  Programming'. Addison-Wesley. ISBN 0-13-142901-9.
121- [[[walsh-muellner]]] Norman Walsh & Leonard Muellner.
122  'DocBook - The Definitive Guide'. O'Reilly & Associates. 1999.
123  ISBN 1-56592-580-7.
124
125[bibliography]
126.Articles
127- [[[abc2003]]] Gall Anonim. 'An article', Whatever. 2003.
128
129
130[glossary]
131Example Glossary
132----------------
133Glossaries are optional. Glossaries entries are an example of a style
134of AsciiDoc labeled lists.
135
136[glossary]
137A glossary term::
138  The corresponding (indented) definition.
139
140A second glossary term::
141  The corresponding (indented) definition.
142
143
144[colophon]
145Example Colophon
146----------------
147Text at the end of a book describing facts about its production.
148
149
150[index]
151Example Index
152-------------
153////////////////////////////////////////////////////////////////
154The index is normally left completely empty, it's contents being
155generated automatically by the DocBook toolchain.
156////////////////////////////////////////////////////////////////
Note: See TracBrowser for help on using the repository browser.