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
|
<!-- -*- sgml -*- -->
----------------------------------------------
Docbook Reference Manual (1999):
- http://www.oreilly.com/catalog/docbook/
DocBook XSL: The Complete Guide (2002)
- http://www.sagehill.net/docbookxsl/index.html
DocBook elements (what tags are allowed where)
- http://www.oreilly.com/catalog/docbook/chapter/book/refelem.html
Catalogs:
- http://www.sagehill.net/docbookxsl/WriteCatalog.html
----------------------------------------------
xml to html markup transformations:
<programlisting> --> <pre class="programlisting">
<screen> --> <pre class="screen">
<option> --> <code class="option">
<filename> --> <code class="filename">
<function> --> <code class="function">
<literal> --> <code class="literal">
<varname> --> <code class="varname">
<computeroutput> --> <code class="computeroutput">
<emphasis> --> <i>
<command> --> <b class="command">
<blockquote> --> <div class="blockquote">
<blockquote class="blockquote">
Important: inside <screen> and <programlisting> blocks, do NOT
use 'html entities' in your markup, eg. '<' If you *do* use
them, they will be output verbatim, which is not what you want.
Instead, wrap the content with CDATA tags (see below).
----------------------------------------------
<ulink url="http://..">http://kcachegrind.sourceforge.net</ulink>
----------------------------------------------
<variablelist> --> <dl>
<varlistentry>
<term>TTF</term> --> <dt>
<listitem>TrueType fonts.</listitem> --> <dd>
</varlistentry>
</variablelist> --> <dl>
----------------------------------------------
<itemizedlist> --> <ul>
<listitem> --> <li>
<para>....</para>
<para>....</para>
</listitem> --> </li>
</itemizedlist> --> </ul>
----------------------------------------------
<orderedlist> --> <ol>
<listitem> --> <li>
<para>....</para>
<para>....</para>
</listitem> --> </li>
</orderedlist> --> </ol>
----------------------------------------------
To achieve this:
This is a paragraph of text before a list:
* some text
* some more text
and this is some more text after the list.
Do this:
<para>This is a paragraph of text before a list:</para>
<itemizedlist>
<listitem>
<para>some text</para>
</listitem>
<listitem>
<para>some more text</para>
</listitem>
</itemizedlist>
<para>and this is some more text after the list.</para>
----------------------------------------------
To achieve this:
For further details, see <a href="clientreq">The Mechanism</a>
Do this:
Given:
<sect1 id="clientreq" xreflabel="The Mechanism">
<title>The Mechanism</title>
<para>...</para>
</sect1>
Then do:
For further details, see <xref linkend="clientreq"/>.
----------------------------------------------
To achieve this:
<p><b>Warning:</b> Only do this if ...</p>
Do this:
<formalpara>
<title>Warning:</title>
<para>Only do this if ...</para>
</formalpara>
Or this:
<para><command>Warning:</command> Only do this if ... </para>
----------------------------------------------
To achieve this:
<p>It uses the Eraser algorithm described in:<br/>
<br/>
Eraser: A Dynamic Data Race Detector for Multithreaded Programs<br/>
Stefan Savage, Michael Burrows, Patrick Sobalvarro and Thomas Anderson<br/>
ACM Transactions on Computer Systems, 15(4):391-411<br/>
November 1997.<br/>
</p>
Do this:
<literallayout>
It uses the Eraser algorithm described in:
Eraser: A Dynamic Data Race Detector for Multithreaded Programs
Stefan Savage, Michael Burrows, Patrick Sobalvarro and Thomas Anderson
ACM Transactions on Computer Systems, 15(4):391-411
November 1997.
</literallayout>
----------------------------------------------
To achieve this:
<pre>
/* Hook to delay things long enough so we can get the pid
and attach GDB in another shell. */
if (0) {
Int p, q;
for ( p = 0; p < 50000; p++ )
for ( q = 0; q < 50000; q++ ) ;
</pre>
Do this:
<programlisting><![CDATA[
/* Hook to delay things long enough so we can get the pid
and attach GDB in another shell. */
if (0) {
Int p, q;
for ( p = 0; p < 50000; p++ )
for ( q = 0; q < 50000; q++ ) ;
}]]></programlisting>
(do the same thing for <screen> tag)
----------------------------------------------
To achieve this:
where <i><code>TAG</code></i> has the ...
Do this:
where <emphasis><computeroutput>TAG</computeroutput></emphasis> has the ...
Note: you cannot put <emphasis> inside <computeroutput>, unfortunately.
----------------------------------------------
Any other helpful hints? Please add to this.
|
