1 | Book Title Goes Here |
---|
2 | ==================== |
---|
3 | Author's Name |
---|
4 | v1.0, 2003-12 |
---|
5 | :doctype: book |
---|
6 | |
---|
7 | |
---|
8 | [dedication] |
---|
9 | Example Dedication |
---|
10 | ------------------ |
---|
11 | Optional dedication. |
---|
12 | |
---|
13 | This document is an AsciiDoc book skeleton containing briefly |
---|
14 | annotated example elements plus a couple of example index entries and |
---|
15 | footnotes. |
---|
16 | |
---|
17 | Books are normally used to generate DocBook markup and the titles of |
---|
18 | the preface, appendix, bibliography, glossary and index sections are |
---|
19 | significant ('specialsections'). |
---|
20 | |
---|
21 | |
---|
22 | [preface] |
---|
23 | Example Preface |
---|
24 | --------------- |
---|
25 | Optional preface. |
---|
26 | |
---|
27 | Preface Sub-section |
---|
28 | ~~~~~~~~~~~~~~~~~~~ |
---|
29 | Preface sub-section body. |
---|
30 | |
---|
31 | |
---|
32 | The First Chapter |
---|
33 | ----------------- |
---|
34 | Chapters can contain sub-sections nested up to three deep. |
---|
35 | footnote:[An example footnote.] |
---|
36 | indexterm:[Example index entry] |
---|
37 | |
---|
38 | Chapters can have their own bibliography, glossary and index. |
---|
39 | |
---|
40 | And now for something completely different: ((monkeys)), lions and |
---|
41 | tigers (Bengal and Siberian) using the alternative syntax index |
---|
42 | entries. |
---|
43 | (((Big cats,Lions))) |
---|
44 | (((Big cats,Tigers,Bengal Tiger))) |
---|
45 | (((Big cats,Tigers,Siberian Tiger))) |
---|
46 | Note that multi-entry terms generate separate index entries. |
---|
47 | |
---|
48 | Here are a couple of image examples: an image:images/smallnew.png[] |
---|
49 | example inline image followed by an example block image: |
---|
50 | |
---|
51 | .Tiger block image |
---|
52 | image::images/tiger.png[Tiger image] |
---|
53 | |
---|
54 | Followed 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 | =============================================== |
---|
66 | Lorum ipum... |
---|
67 | =============================================== |
---|
68 | |
---|
69 | [[X1]] |
---|
70 | Sub-section with Anchor |
---|
71 | ~~~~~~~~~~~~~~~~~~~~~~~ |
---|
72 | Sub-section at level 2. |
---|
73 | |
---|
74 | Chapter Sub-section |
---|
75 | ^^^^^^^^^^^^^^^^^^^ |
---|
76 | Sub-section at level 3. |
---|
77 | |
---|
78 | Chapter Sub-section |
---|
79 | +++++++++++++++++++ |
---|
80 | Sub-section at level 4. |
---|
81 | |
---|
82 | This is the maximum sub-section depth supported by the distributed |
---|
83 | AsciiDoc configuration. |
---|
84 | footnote:[A second example footnote.] |
---|
85 | |
---|
86 | |
---|
87 | The Second Chapter |
---|
88 | ------------------ |
---|
89 | An example link to anchor at start of the <<X1,first sub-section>>. |
---|
90 | indexterm:[Second example index entry] |
---|
91 | |
---|
92 | An example link to a bibliography entry <<taoup>>. |
---|
93 | |
---|
94 | |
---|
95 | The Third Chapter |
---|
96 | ----------------- |
---|
97 | Book chapters are at level 1 and can contain sub-sections. |
---|
98 | |
---|
99 | |
---|
100 | :numbered!: |
---|
101 | |
---|
102 | [appendix] |
---|
103 | Example Appendix |
---|
104 | ---------------- |
---|
105 | One or more optional appendixes go here at section level 1. |
---|
106 | |
---|
107 | Appendix Sub-section |
---|
108 | ~~~~~~~~~~~~~~~~~~~ |
---|
109 | Sub-section body. |
---|
110 | |
---|
111 | |
---|
112 | [bibliography] |
---|
113 | Example Bibliography |
---|
114 | -------------------- |
---|
115 | The 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] |
---|
131 | Example Glossary |
---|
132 | ---------------- |
---|
133 | Glossaries are optional. Glossaries entries are an example of a style |
---|
134 | of AsciiDoc labeled lists. |
---|
135 | |
---|
136 | [glossary] |
---|
137 | A glossary term:: |
---|
138 | The corresponding (indented) definition. |
---|
139 | |
---|
140 | A second glossary term:: |
---|
141 | The corresponding (indented) definition. |
---|
142 | |
---|
143 | |
---|
144 | [colophon] |
---|
145 | Example Colophon |
---|
146 | ---------------- |
---|
147 | Text at the end of a book describing facts about its production. |
---|
148 | |
---|
149 | |
---|
150 | [index] |
---|
151 | Example Index |
---|
152 | ------------- |
---|
153 | //////////////////////////////////////////////////////////////// |
---|
154 | The index is normally left completely empty, it's contents being |
---|
155 | generated automatically by the DocBook toolchain. |
---|
156 | //////////////////////////////////////////////////////////////// |
---|