/[gentoo]/xml/htdocs/doc/en/xml-guide.xml
Gentoo

Diff of /xml/htdocs/doc/en/xml-guide.xml

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.36 Revision 1.37
1<?xml version='1.0' encoding="UTF-8"?> 1<?xml version='1.0' encoding="UTF-8"?>
2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.36 2005/02/14 16:14:46 swift Exp $ --> 2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.37 2005/04/06 10:59:55 neysx Exp $ -->
3<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> 3<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
4 4
5<guide link="/doc/en/xml-guide.xml"> 5<guide link="/doc/en/xml-guide.xml">
6<title>Gentoo Linux XML Guide</title> 6<title>Gentoo Linux XML Guide</title>
7 7
8<author title="Author"> 8<author title="Author">
9 <mail link="drobbins@gentoo.org">Daniel Robbins</mail> 9 <mail link="drobbins@gentoo.org">Daniel Robbins</mail>
10</author> 10</author>
11<author title="Author"><!-- zhen@gentoo.org --> 11<author title="Author"><!-- zhen@gentoo.org -->
12 John P. Davis 12 John P. Davis
13</author> 13</author>
14<author title="Editor"> 14<author title="Editor">
15 <mail link="peesh@gentoo.org">Jorge Paulo</mail> 15 <mail link="peesh@gentoo.org">Jorge Paulo</mail>
16</author> 16</author>
17<author title="Editor"> 17<author title="Editor">
20<author title="Editor"> 20<author title="Editor">
21 <mail link="neysx@gentoo.org">Xavier Neys</mail> 21 <mail link="neysx@gentoo.org">Xavier Neys</mail>
22</author> 22</author>
23 23
24<abstract> 24<abstract>
25This guide shows you how to compose web documentation using the new lightweight 25This guide shows you how to compose web documentation using the new lightweight
26Gentoo GuideXML syntax. This syntax is the official format for Gentoo Linux 26Gentoo GuideXML syntax. This syntax is the official format for Gentoo Linux
27documentation, and this document itself was created using GuideXML. This guide 27documentation, and this document itself was created using GuideXML. This guide
28assumes a basic working knowledge of XML and HTML. 28assumes a basic working knowledge of XML and HTML.
29</abstract> 29</abstract>
30 30
31<!-- The content of this document is licensed under the CC-BY-SA license --> 31<!-- The content of this document is licensed under the CC-BY-SA license -->
32<!-- See http://creativecommons.org/licenses/by-sa/2.0 --> 32<!-- See http://creativecommons.org/licenses/by-sa/2.0 -->
33<license/> 33<license/>
34 34
35<version>2.13</version> 35<version>2.14</version>
36<date>2005-02-14</date> 36<date>2005-04-06</date>
37 37
38<chapter> 38<chapter>
39<title>Guide basics</title> 39<title>Guide basics</title>
40<section> 40<section>
41<title>Guide XML design goals</title> 41<title>Guide XML design goals</title>
42<body> 42<body>
43 43
44<p> 44<p>
45The guide XML syntax is lightweight yet expressive, so that it is easy to 45The guide XML syntax is lightweight yet expressive, so that it is easy to
46learn yet also provides all the features we need for the creation of web 46learn yet also provides all the features we need for the creation of web
47documentation. The number of tags is kept to a minimum -- just those we need. 47documentation. The number of tags is kept to a minimum -- just those we need.
48This makes it easy to transform guide into other formats, such as DocBook 48This makes it easy to transform guide into other formats, such as DocBook
49XML/SGML or web-ready HTML. 49XML/SGML or web-ready HTML.
50</p> 50</p>
51 51
154 154
155<p> 155<p>
156Finally we have the <c>&lt;license/&gt;</c> tag, used to publish the 156Finally we have the <c>&lt;license/&gt;</c> tag, used to publish the
157document under the <uri link="http://creativecommons.org/licenses/by-sa/2.0/">Creative 157document under the <uri link="http://creativecommons.org/licenses/by-sa/2.0/">Creative
158Commons - Attribution / Share Alike</uri> license as required by the <uri 158Commons - Attribution / Share Alike</uri> license as required by the <uri
159link="/doc/en/doc-policy.xml">Documentation Policy</uri>. 159link="/doc/en/doc-policy.xml">Documentation Policy</uri>.
160</p> 160</p>
161 161
162</body> 162</body>
163</section> 163</section>
164<section> 164<section>
165<title>Chapters and sections</title> 165<title>Chapters and sections</title>
166<body> 166<body>
167 167
168<p> 168<p>
169Once the initial tags have been specified, you're ready to start adding 169Once the initial tags have been specified, you're ready to start adding the
170the structural elements of the document. Guide documents are divided into 170structural elements of the document. Guide documents are divided into
171chapters, and each chapter can hold one or more sections. Every chapter 171chapters, and each chapter can hold one or more sections. Every chapter and
172and section has a title. Here's an example chapter with a single section, 172section has a title. Here's an example chapter with a single section,
173consisting of a paragraph. If you append this XML to the XML in the <uri link="#doc_chap2_pre1">previous 173consisting of a paragraph. If you append this XML to the XML in the <uri
174link="#doc_chap2_pre1">previous excerpt</uri> and append a
174excerpt</uri> and append a <c>&lt;/guide&gt;</c> to the end of the file, you'll have a valid 175<c>&lt;/guide&gt;</c> to the end of the file, you'll have a valid (if minimal)
175(if minimal) guide document: 176guide document:
176</p> 177</p>
177 178
178<pre> 179<pre caption="Minimal guide example">
179&lt;chapter&gt; 180&lt;chapter&gt;
180&lt;title&gt;<i>This is my chapter</i>&lt;/title&gt; 181&lt;title&gt;<i>This is my chapter</i>&lt;/title&gt;
181&lt;section&gt; 182&lt;section&gt;
182&lt;title&gt;<i>This is section one of my chapter</i>&lt;/title&gt; 183&lt;title&gt;<i>This is section one of my chapter</i>&lt;/title&gt;
183&lt;body&gt; 184&lt;body&gt;
184 185
185&lt;p&gt; 186&lt;p&gt;
186<i>This is the actual text content of my section.</i> 187<i>This is the actual text content of my section.</i>
187&lt;/p&gt; 188&lt;/p&gt;
188 189
189&lt;/body&gt; 190&lt;/body&gt;
190&lt;/section&gt; 191&lt;/section&gt;
191&lt;/chapter&gt; 192&lt;/chapter&gt;
192</pre> 193</pre>
193 194
204 205
205<note> 206<note>
206A <c>&lt;guide&gt;</c> element can contain multiple <c>&lt;chapter&gt;</c> 207A <c>&lt;guide&gt;</c> element can contain multiple <c>&lt;chapter&gt;</c>
207elements, and a <c>&lt;chapter&gt;</c> can contain multiple 208elements, and a <c>&lt;chapter&gt;</c> can contain multiple
208<c>&lt;section&gt;</c> elements. However, a <c>&lt;section&gt;</c> 209<c>&lt;section&gt;</c> elements. However, a <c>&lt;section&gt;</c>
209element can only contain one <c>&lt;body&gt;</c> element. 210element can only contain one <c>&lt;body&gt;</c> element.
210</note> 211</note>
211 212
212</body> 213</body>
213</section> 214</section>
214<section> 215<section>
215<title>An example &lt;body&gt;</title> 216<title>An example &lt;body&gt;</title>
216<body> 217<body>
217 218
218<p> 219<p>
219Now, it's time to learn how to mark up actual content. Here's the XML code for an example <c>&lt;body&gt;</c> element: 220Now, it's time to learn how to mark up actual content. Here's the XML code for
221an example <c>&lt;body&gt;</c> element:
220</p> 222</p>
221 223
222<pre> 224<pre caption="Example of a body element">
223&lt;p&gt; 225&lt;p&gt;
224This is a paragraph. &lt;path&gt;/etc/passwd&lt;/path&gt; is a file. 226This is a paragraph. &lt;path&gt;/etc/passwd&lt;/path&gt; is a file.
225&lt;uri&gt;http://forums.gentoo.org&lt;/uri&gt; is my favorite website. 227&lt;uri&gt;http://forums.gentoo.org&lt;/uri&gt; is my favorite website.
226Type &lt;c&gt;ls&lt;/c&gt; if you feel like it. I &lt;e&gt;really&lt;/e&gt; want to go to sleep now. 228Type &lt;c&gt;ls&lt;/c&gt; if you feel like it. I &lt;e&gt;really&lt;/e&gt; want to go to sleep now.
227&lt;/p&gt; 229&lt;/p&gt;
228 230
229&lt;pre&gt; 231&lt;pre caption="Code Sample"&gt;
230This is text output or code. 232This is text output or code.
231# &lt;i&gt;this is user input&lt;/i&gt; 233# &lt;i&gt;this is user input&lt;/i&gt;
232 234
233Make HTML/XML easier to read by using selective emphasis: 235Make HTML/XML easier to read by using selective emphasis:
234&lt;foo&gt;&lt;i&gt;bar&lt;/i&gt;&lt;/foo&gt; 236&lt;foo&gt;&lt;i&gt;bar&lt;/i&gt;&lt;/foo&gt;
235 237
236&lt;codenote&gt;This is how to insert an inline note into the code block&lt;/codenote&gt; 238&lt;comment&gt;(This is how to insert an inline note into the code block)&lt;/comment&gt;
237&lt;/pre&gt; 239&lt;/pre&gt;
238 240
239&lt;note&gt; 241&lt;note&gt;
240This is a note. 242This is a note.
241&lt;/note&gt; 243&lt;/note&gt;
242 244
243&lt;warn&gt; 245&lt;warn&gt;
244This is a warning. 246This is a warning.
245&lt;/warn&gt; 247&lt;/warn&gt;
246 248
247&lt;impo&gt; 249&lt;impo&gt;
248This is important. 250This is important.
249&lt;/impo&gt; 251&lt;/impo&gt;
250</pre> 252</pre>
251 253
252<p> 254<p>
253Now, here's how this <c>&lt;body&gt;</c> element is rendered: 255Now, here's how the <c>&lt;body&gt;</c> element above is rendered:
254</p> 256</p>
255 257
256<p> 258<p>
257This is a paragraph. <path>/etc/passwd</path> is a file. 259This is a paragraph. <path>/etc/passwd</path> is a file.
258<uri>http://forums.gentoo.org</uri> is my favorite website. 260<uri>http://forums.gentoo.org</uri> is my favorite website.
259Type <c>ls</c> if you feel like it. I <e>really</e> want to go to sleep now. 261Type <c>ls</c> if you feel like it. I <e>really</e> want to go to sleep now.
260</p> 262</p>
261 263
262<pre> 264<pre caption="Code Sample">
263This is text output or code. 265This is text output or code.
264# <i>this is user input</i> 266# <i>this is user input</i>
265 267
266Make HTML/XML easier to read by using selective emphasis: 268Make HTML/XML easier to read by using selective emphasis:
267&lt;foo&gt;<i>bar</i>&lt;/foo&gt; 269&lt;foo&gt;<i>bar</i>&lt;/foo&gt;
268 270
269<codenote>This is how to insert an inline note into the code block</codenote> 271<comment>(This is how to insert an inline note into the code block)</comment>
270</pre> 272</pre>
271 273
272<note> 274<note>
273This is a note. 275This is a note.
274</note> 276</note>
275 277
276<warn> 278<warn>
277This is a warning. 279This is a warning.
278</warn> 280</warn>
279 281
280<impo> 282<impo>
281This is important. 283This is important.
282</impo> 284</impo>
283 285
284</body> 286</body>
289 291
290<p> 292<p>
291We introduced a lot of new tags in the previous section -- here's what you 293We introduced a lot of new tags in the previous section -- here's what you
292need to know. The <c>&lt;p&gt;</c> (paragraph), <c>&lt;pre&gt;</c> (code 294need to know. The <c>&lt;p&gt;</c> (paragraph), <c>&lt;pre&gt;</c> (code
293block), <c>&lt;note&gt;</c>, <c>&lt;warn&gt;</c> (warning) and 295block), <c>&lt;note&gt;</c>, <c>&lt;warn&gt;</c> (warning) and
294<c>&lt;impo&gt;</c> (important) tags all can contain one or more lines of text. 296<c>&lt;impo&gt;</c> (important) tags all can contain one or more lines of text.
295Besides the <c>&lt;table&gt;</c> element (which we'll cover in just a bit), 297Besides the <c>&lt;table&gt;</c> element (which we'll cover in just a bit),
296these are the only tags that should appear immediately inside a 298these are the only tags that should appear immediately inside a
297<c>&lt;body&gt;</c> element. Another thing -- these tags <e>should not</e> be 299<c>&lt;body&gt;</c> element. Another thing -- these tags <e>should not</e> be
298stacked -- in other words, don't put a <c>&lt;note&gt;</c> element inside a 300stacked -- in other words, don't put a <c>&lt;note&gt;</c> element inside a
299<c>&lt;p&gt;</c> element. As you might guess, the <c>&lt;pre&gt;</c> element 301<c>&lt;p&gt;</c> element. As you might guess, the <c>&lt;pre&gt;</c> element
300preserves its whitespace exactly, making it well-suited for code excerpts. 302preserves its whitespace exactly, making it well-suited for code excerpts.
301You can also name the <c>&lt;pre&gt;</c> tag: 303You can also name the <c>&lt;pre&gt;</c> tag:
302</p> 304</p>
303 305
304<pre caption = "Named &lt;pre&gt;"> 306<pre caption="Named &lt;pre&gt;">
305&lt;pre caption = "Output of uptime"&gt; 307&lt;pre caption = "Output of uptime"&gt;
306# &lt;i&gt;uptime&lt;/i&gt; 308# &lt;i&gt;uptime&lt;/i&gt;
30716:50:47 up 164 days, 2:06, 5 users, load average: 0.23, 0.20, 0.25 30916:50:47 up 164 days, 2:06, 5 users, load average: 0.23, 0.20, 0.25
308&lt;/pre&gt; 310&lt;/pre&gt;
309</pre> 311</pre>
310 312
311</body> 313</body>
312</section> 314</section>
313<section> 315<section>
314<title>&lt;path&gt;, &lt;c&gt; and &lt;e&gt;</title> 316<title>&lt;path&gt;, &lt;c&gt; and &lt;e&gt;</title>
315<body> 317<body>
316 318
317<p> 319<p>
318The <c>&lt;path&gt;</c>, <c>&lt;c&gt;</c> and <c>&lt;e&gt;</c> elements can 320The <c>&lt;path&gt;</c>, <c>&lt;c&gt;</c> and <c>&lt;e&gt;</c> elements can
319be used inside any child <c>&lt;body&gt;</c> tag, except for 321be used inside any child <c>&lt;body&gt;</c> tag, except for
370when you want to associate a URI with some other text -- for example, <uri 372when you want to associate a URI with some other text -- for example, <uri
371link="http://forums.gentoo.org">the Gentoo Forums</uri>. To create <e>this</e> 373link="http://forums.gentoo.org">the Gentoo Forums</uri>. To create <e>this</e>
372link, I typed <c>&lt;uri link="http://forums.gentoo.org"&gt;the Gentoo 374link, I typed <c>&lt;uri link="http://forums.gentoo.org"&gt;the Gentoo
373Forums&lt;/uri&gt;</c>. You don't need to write <c>http://www.gentoo.org/</c> 375Forums&lt;/uri&gt;</c>. You don't need to write <c>http://www.gentoo.org/</c>
374to link to other parts of the Gentoo website. For instance, a link to the <uri 376to link to other parts of the Gentoo website. For instance, a link to the <uri
375link="/doc/en/">documentation main index</uri> should be simply <c>&lt;uri 377link="/doc/en/">documentation main index</uri> should be simply <c>&lt;uri
376link="/doc/en/index.xml"&gt;documentation main index&lt;/uri&gt;</c>. You can 378link="/doc/en/index.xml"&gt;documentation main index&lt;/uri&gt;</c>. You can
377even omit <c>index.xml</c> when you link to a directory index, e.g. <c>&lt;uri 379even omit <c>index.xml</c> when you link to a directory index, e.g. <c>&lt;uri
378link="/doc/en/"&gt;documentation main index&lt;/uri&gt;</c>. 380link="/doc/en/"&gt;documentation main index&lt;/uri&gt;</c>.
379</p> 381</p>
380 382
381</body> 383</body>
382</section> 384</section>
383<section> 385<section>
384<title>Figures</title> 386<title>Figures</title>
385
386<body> 387<body>
387 388
388<p> 389<p>
389Here's how to insert a figure into a document -- <c>&lt;figure 390Here's how to insert a figure into a document -- <c>&lt;figure
390link="mygfx.png" short="my picture" caption="my favorite picture of all 391link="mygfx.png" short="my picture" caption="my favorite picture of all
391time"/&gt;</c>. The <c>link=</c> attribute points to the actual graphic image, 392time"/&gt;</c>. The <c>link=</c> attribute points to the actual graphic image,
392the <c>short=</c> attribute specifies a short description (currently used for 393the <c>short=</c> attribute specifies a short description (currently used for
393the image's HTML <c>alt=</c> attribute), and a caption. Not too difficult 394the image's HTML <c>alt=</c> attribute), and a caption. Not too difficult
394:) We also support the standard HTML-style &lt;img src="foo.gif"/&gt; tag 395:) We also support the standard HTML-style &lt;img src="foo.gif"/&gt; tag
395for adding images without captions, borders, etc. 396for adding images without captions, borders, etc.
396</p> 397</p>
397 398
398</body> 399</body>
399</section> 400</section>
400<section> 401<section>
478</p> 479</p>
479 480
480</body> 481</body>
481</section> 482</section>
482<section> 483<section>
483<title>Internal Coding Style</title> 484<title>Internal Coding Style</title>
484<body> 485<body>
485 486
486<p> 487<p>
487<b>Newlines</b> must be placed immediately after <e>every</e> 488<b>Newlines</b> must be placed immediately after <e>every</e>
488GuideXML-tag (both opening as closing), except for: 489GuideXML-tag (both opening as closing), except for:
489<c>&lt;version&gt;</c>, <c>&lt;date&gt;</c>, <c>&lt;title&gt;</c>, 490<c>&lt;version&gt;</c>, <c>&lt;date&gt;</c>, <c>&lt;title&gt;</c>,
490<c>&lt;th&gt;</c>, <c>&lt;ti&gt;</c>, 491<c>&lt;th&gt;</c>, <c>&lt;ti&gt;</c>,
491<c>&lt;li&gt;</c>, <c>&lt;i&gt;</c>, <c>&lt;e&gt;</c>, 492<c>&lt;li&gt;</c>, <c>&lt;i&gt;</c>, <c>&lt;e&gt;</c>,
492<c>&lt;uri&gt;</c>, <c>&lt;path&gt;</c>, <c>&lt;b&gt;</c>, 493<c>&lt;uri&gt;</c>, <c>&lt;path&gt;</c>, <c>&lt;b&gt;</c>,
493<c>&lt;comment&gt;</c>, <c>&lt;codenote&gt;</c>, <c>&lt;mail&gt;</c>. 494<c>&lt;comment&gt;</c>, <c>&lt;mail&gt;</c>.
494</p> 495</p>
495 496
496<p> 497<p>
497<b>Blank lines</b> must be placed immediately after <e>every</e> 498<b>Blank lines</b> must be placed immediately after <e>every</e>
498<c>&lt;body&gt;</c> (opening tag only) and before <e>every</e> 499<c>&lt;body&gt;</c> (opening tag only) and before <e>every</e>
499<c>&lt;chapter&gt;</c>, <c>&lt;p&gt;</c>, <c>&lt;table&gt;</c>, 500<c>&lt;chapter&gt;</c>, <c>&lt;p&gt;</c>, <c>&lt;table&gt;</c>,
500<c>&lt;author&gt;</c> (set), <c>&lt;pre&gt;</c>, <c>&lt;ul&gt;</c>, 501<c>&lt;author&gt;</c> (set), <c>&lt;pre&gt;</c>, <c>&lt;ul&gt;</c>,
501<c>&lt;ol&gt;</c>, <c>&lt;warn&gt;</c>, <c>&lt;note&gt;</c> and 502<c>&lt;ol&gt;</c>, <c>&lt;warn&gt;</c>, <c>&lt;note&gt;</c> and
502<c>&lt;impo&gt;</c> (opening tags only). 503<c>&lt;impo&gt;</c> (opening tags only).
503</p> 504</p>
504 505
505<p> 506<p>
506<b>Word-wrapping</b> must be applied at 80 characters except inside 507<b>Word-wrapping</b> must be applied at 80 characters except inside
507<c>&lt;pre&gt;</c>. Only when there is no other choice can be deviated from 508<c>&lt;pre&gt;</c>. Only when there is no other choice can be deviated from
508this rule (for instance when a URL exceeds the maximum amount of characters). 509this rule (for instance when a URL exceeds the maximum amount of characters).
514the parent XML-tags are <c>&lt;tr&gt;</c> (from <c>&lt;table&gt;</c>), 515the parent XML-tags are <c>&lt;tr&gt;</c> (from <c>&lt;table&gt;</c>),
515<c>&lt;ul&gt;</c>, <c>&lt;ol&gt;</c> and <c>&lt;author&gt;</c>. If indentation 516<c>&lt;ul&gt;</c>, <c>&lt;ol&gt;</c> and <c>&lt;author&gt;</c>. If indentation
516is used, it <e>must</e> be two spaces for each indentation. That means <e>no</e> 517is used, it <e>must</e> be two spaces for each indentation. That means <e>no</e>
517tabs and <e>not</e> more spaces. 518tabs and <e>not</e> more spaces.
518</p> 519</p>
519 520
520<p> 521<p>
521In case word-wrapping happens in <c>&lt;ti&gt;</c>, <c>&lt;th&gt;</c> or 522In case word-wrapping happens in <c>&lt;ti&gt;</c>, <c>&lt;th&gt;</c> or
522<c>&lt;li&gt;</c> constructs, indentation must be used for the content. 523<c>&lt;li&gt;</c> constructs, indentation must be used for the content.
523</p> 524</p>
524 525
525<p> 526<p>
526An example for indentation is: 527An example for indentation is:
527</p> 528</p>
528 529
529<pre caption = "Indentation Example"> 530<pre caption="Indentation Example">
530&lt;table&gt; 531&lt;table&gt;
531&lt;tr&gt; 532&lt;tr&gt;
532 &lt;th&gt;Foo&lt;/th&gt; 533 &lt;th&gt;Foo&lt;/th&gt;
533 &lt;th&gt;Bar&lt;/th&gt; 534 &lt;th&gt;Bar&lt;/th&gt;
534&lt;/tr&gt; 535&lt;/tr&gt;
535&lt;tr&gt; 536&lt;tr&gt;
536 &lt;ti&gt;This is an example for indentation.&lt;/ti&gt; 537 &lt;ti&gt;This is an example for indentation.&lt;/ti&gt;
537 &lt;ti&gt; 538 &lt;ti&gt;
538 In case text cannot be shown within an 80-character wide line, you 539 In case text cannot be shown within an 80-character wide line, you
539 must use indentation if the parent tag allows it. 540 must use indentation if the parent tag allows it.
540 &lt;/ti&gt; 541 &lt;/ti&gt;
541&lt;/tr&gt; 542&lt;/tr&gt;
542&lt;/table&gt; 543&lt;/table&gt;
543 544
544&lt;ul&gt; 545&lt;ul&gt;
581 &lt;li&gt;With period. Multiple sentences, remember?&lt;/li&gt; 582 &lt;li&gt;With period. Multiple sentences, remember?&lt;/li&gt;
582&lt;/ul&gt; 583&lt;/ul&gt;
583</pre> 584</pre>
584 585
585<p> 586<p>
586Code Listings should <e>always</e> have a <c>caption</c>. 587Code Listings should <e>always</e> have a <c>caption</c>.
587</p> 588</p>
588 589
589<p> 590<p>
590Try to use <c>&lt;uri&gt;</c> with the <c>link</c> attribute as much as 591Try to use <c>&lt;uri&gt;</c> with the <c>link</c> attribute as much as
591possible. In other words, the <uri link="http://forums.gentoo.org">Gentoo 592possible. In other words, the <uri link="http://forums.gentoo.org">Gentoo
592Forums</uri> is preferred over <uri>http://forums.gentoo.org</uri>. 593Forums</uri> is preferred over <uri>http://forums.gentoo.org</uri>.
593</p> 594</p>
594 595
595<p> 596<p>
596When you comment something inside a <c>&lt;pre&gt;</c> construct, only use 597When you comment something inside a <c>&lt;pre&gt;</c> construct, use
597<c>&lt;codenote&gt;</c> if the content is a C or C++ code snippet. Otherwise, 598<c>&lt;comment&gt;</c> and parentheses or the comment marker for the language
598use <c>&lt;comment&gt;</c> and parentheses. Also place the comment <e>before</e> 599that is being used (<c>#</c> for bash scripts and many other things, <c>//</c>
599the subject of the comment. 600for C code, etc.) Also place the comment <e>before</e> the subject of the
601comment.
600</p> 602</p>
601 603
602<pre caption="Comment example"> 604<pre caption="Comment example">
603<comment>(Substitute "john" with your user name)</comment> 605<comment>(Substitute "john" with your user name)</comment>
604# <i>id john</i> 606# <i>id john</i>
605</pre> 607</pre>
606 608
607</body> 609</body>
608</section> 610</section>
609</chapter> 611</chapter>
610 612
611<chapter> 613<chapter>
612<title>Handbook Format</title> 614<title>Handbook Format</title>
613<section> 615<section>
614<title>Guide vs Book</title> 616<title>Guide vs Book</title>

Legend:
Removed from v.1.36  
changed lines
  Added in v.1.37

  ViewVC Help
Powered by ViewVC 1.1.20