1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
|
<?xml version="1.0"
encoding="utf-8"
?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "docbook/dtd/xml/4.5/docbookx.dtd">
<article lang="en">
<articleinfo>
<title>TXT2TAGS SAMPLE</title>
<authorgroup>
<author><othername>Aurelio Jargas</othername></author>
</authorgroup>
</articleinfo>
<sect1><title>Introduction</title>
<para>
Welcome to the txt2tags sample file.
</para>
<para>
Here you have examples and a brief explanation of all
marks.
</para>
<para>
The first 3 lines of the this file are used as headers,
on the following format:
</para>
<programlisting>
line1: document title
line2: author name, email
line3: date, version
</programlisting>
<para>
Lines with balanced equal signs = around are titles.
</para>
</sect1>
<sect1><title>Fonts and Beautifiers</title>
<para>
We have two sets of fonts:
</para>
<para>
The NORMAL type that can be improved with beautifiers.
</para>
<para>
The TYPEWRITER type that uses monospaced font for
pre-formatted text.
</para>
<para>
We will now enter on a subtitle...
</para>
<sect2><title>Beautifiers</title>
<para>
The text marks for beautifiers are simple, just as you
type on a plain text email message.
</para>
<para>
We use double *, /, - and _ to represent <emphasis role="bold">bold</emphasis>,
<emphasis>italic</emphasis>, strike and <emphasis role="underline">underline</emphasis>.
</para>
<para>
The <emphasis role="bold"><emphasis>bold italic</emphasis></emphasis> style is also supported as a
combination.
</para>
</sect2>
<sect2><title>Pre-Formatted Text</title>
<para>
We can put a code sample or other pre-formatted text:
</para>
<programlisting>
here is pre-formatted
//marks// are **not** ``interpreted``
</programlisting>
<para>
And also, it's easy to put a one line pre-formatted
text:
</para>
<programlisting>
prompt$ ls /etc
</programlisting>
<para>
Or use <code>pre-formatted</code> inside sentences.
</para>
</sect2>
<sect2><title>More Cosmetics</title>
<para>
Special entities like email (<email>duh@somewhere.com</email>) and
URL (<ulink url="http://www.duh.com">http://www.duh.com</ulink>) are detected automagically,
as well as horizontal lines:
</para>
<para>
You can also specify an <ulink url="http://duh.org">explicit link</ulink>
with label.
</para>
<para>
And remember,
</para>
<blockquote><para>
A TAB in front of the line does a quotation.
<blockquote><para>
More TABs, more depth (if allowed).
</para></blockquote>
</para></blockquote>
<para>
Nice.
</para>
</sect2>
</sect1>
<sect1><title>Lists</title>
<para>
A list of items is natural, just putting a <emphasis role="bold">dash</emphasis> or
a <emphasis role="bold">plus</emphasis> at the beginning of the line.
</para>
<sect2><title>Plain List</title>
<para>
The dash is the default list identifier. For sublists,
just add <emphasis role="bold">spaces</emphasis> at the beginning of the line. More
spaces, more sublists.
</para>
<itemizedlist>
<listitem><para>earth
<itemizedlist>
<listitem><para>america
<itemizedlist>
<listitem><para>south america
<itemizedlist>
<listitem><para>brazil
<itemizedlist>
<listitem><para>how deep can i go?
</para></listitem>
</itemizedlist>
</para></listitem>
</itemizedlist>
</para></listitem>
</itemizedlist>
</para></listitem>
<listitem><para>europe
<itemizedlist>
<listitem><para>lots of countries
</para></listitem>
</itemizedlist>
</para></listitem>
</itemizedlist>
</para></listitem>
<listitem><para>mars
<itemizedlist>
<listitem><para>who knows?
</para></listitem>
</itemizedlist>
</para></listitem>
</itemizedlist>
<para>
The list ends with <emphasis role="bold">two</emphasis> consecutive blank lines.
</para>
</sect2>
<sect2><title>Numbered List</title>
<para>
The same rules as the plain list, just a different
identifier (plus).
</para>
<orderedlist numeration="arabic">
<listitem><para>one
</para></listitem>
<listitem><para>two
</para></listitem>
<listitem><para>three
<itemizedlist>
<listitem><para>mixed lists!
</para></listitem>
<listitem><para>what a mess
<orderedlist numeration="arabic">
<listitem><para>counting again
</para></listitem>
<listitem><para>...
</para></listitem>
</orderedlist>
</para></listitem>
</itemizedlist>
</para></listitem>
<listitem><para>four
</para></listitem>
</orderedlist>
</sect2>
<sect2><title>Definition List</title>
<para>
The definition list identifier is a colon, followed by
the term. The term contents is placed on the next line.
</para>
<variablelist>
<varlistentry><term>orange</term><listitem><para>
a yellow fruit
</para></listitem></varlistentry>
<varlistentry><term>apple</term><listitem><para>
a green or red fruit
</para></listitem></varlistentry>
<varlistentry><term>other fruits</term><listitem><para>
<itemizedlist>
<listitem><para>wee!
</para></listitem>
<listitem><para>mixing lists
<orderedlist numeration="arabic">
<listitem><para>again!
</para></listitem>
<listitem><para>and again!
</para></listitem>
</orderedlist>
</para></listitem>
</itemizedlist>
</para></listitem></varlistentry>
</variablelist>
</sect2>
</sect1>
<sect1><title>Tables</title>
<para>
Use pipes to compose table rows and cells.
Double pipe at the line beginning starts a heading row.
Natural spaces specify each cell alignment.
</para>
<programlisting>
|| heading 1 | heading 2 | heading 3 |
| cell 1.1 | cell 1.2 | cell 1.3 |
| cell 2.1 | cell 2.2 | cell 2.3 |
</programlisting>
<para>
Without the last pipe, no border:
</para>
<programlisting>
|| heading 1 | heading 2 | heading 3
| cell 1.1 | cell 1.2 | cell 1.3
| cell 2.1 | cell 2.2 | cell 2.3
</programlisting>
</sect1>
<sect1><title>Special Entities</title>
<para>
Because things were too simple.
</para>
<sect2><title>Images</title>
<para>
The image mark is as simple as it can be: <code>[filename]</code>.
</para>
<para>
<mediaobject><imageobject><imagedata fileref="img/photo.jpg"/></imageobject></mediaobject>
</para>
<itemizedlist>
<listitem><para>The filename must end in PNG, JPG, GIF, or similar.
</para></listitem>
<listitem><para>No spaces inside the brackets!
</para></listitem>
</itemizedlist>
<para>
<mediaobject><imageobject><imagedata fileref="img/t2tpowered.png"/></imageobject></mediaobject>
</para>
</sect2>
</sect1>
</article>
|