| 1 |
<?xml version='1.0' encoding="UTF-8"?> |
| 2 |
<!-- $Header$ --> |
| 3 |
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> |
| 4 |
|
| 5 |
<guide link="/doc/en/xml-guide.xml"> |
| 6 |
<title>Gentoo Linux XML Guide</title> |
| 7 |
|
| 8 |
<author title="Author"> |
| 9 |
<mail link="drobbins@gentoo.org">Daniel Robbins</mail> |
| 10 |
</author> |
| 11 |
<author title="Author"><!-- zhen@gentoo.org --> |
| 12 |
John P. Davis |
| 13 |
</author> |
| 14 |
<author title="Editor"> |
| 15 |
<mail link="peesh@gentoo.org">Jorge Paulo</mail> |
| 16 |
</author> |
| 17 |
|
| 18 |
<license/> |
| 19 |
<abstract> |
| 20 |
This guide shows you how to compose web documentation using the new lightweight |
| 21 |
Gentoo GuideXML syntax. This syntax is the official format for Gentoo Linux |
| 22 |
documentation, and this document itself was created using GuideXML. This guide |
| 23 |
assumes a basic working knowledge of XML and HTML. |
| 24 |
</abstract> |
| 25 |
|
| 26 |
<version>2.4</version> |
| 27 |
<date>November 5, 2003</date> |
| 28 |
|
| 29 |
<chapter> |
| 30 |
<title>Guide basics</title> |
| 31 |
<section> |
| 32 |
<title>Guide XML design goals</title> |
| 33 |
<body> |
| 34 |
|
| 35 |
<p> |
| 36 |
The guide XML syntax is lightweight yet expressive, so that it is easy to |
| 37 |
learn yet also provides all the features we need for the creation of web |
| 38 |
documentation. The number of tags is kept to a minimum -- just those we need. |
| 39 |
This makes it easy to transform guide into other formats, such as DocBook |
| 40 |
XML/SGML or web-ready HTML. |
| 41 |
</p> |
| 42 |
|
| 43 |
<p> |
| 44 |
The goal is to make it easy to <e>create</e> and <e>transform</e> guide XML |
| 45 |
documents. |
| 46 |
</p> |
| 47 |
|
| 48 |
</body> |
| 49 |
</section> |
| 50 |
<section> |
| 51 |
<title>Further Resources</title> |
| 52 |
<body> |
| 53 |
|
| 54 |
<p> |
| 55 |
If you are planning on contributing documentation to Gentoo, or you want to test |
| 56 |
GuideXML, please read the <uri |
| 57 |
link="http://www.gentoo.org/proj/en/gdp/doc/en/docdev.xml">Documentation |
| 58 |
Developer Guide</uri> which contains tips and tricks for documentation |
| 59 |
development. |
| 60 |
</p> |
| 61 |
|
| 62 |
</body> |
| 63 |
</section> |
| 64 |
</chapter> |
| 65 |
|
| 66 |
<chapter> |
| 67 |
<title>Guide XML</title> |
| 68 |
<section> |
| 69 |
<title>Basic structure</title> |
| 70 |
<body> |
| 71 |
|
| 72 |
<p> |
| 73 |
Now that you know how to transform guide XML, you're ready to start learning |
| 74 |
the GuideXML syntax. We'll start with the the initial tags used in a guide |
| 75 |
XML document: |
| 76 |
</p> |
| 77 |
|
| 78 |
<pre caption="The initial part of a guide XML document"> |
| 79 |
<?xml version='1.0' encoding="UTF-8"?> |
| 80 |
<guide link="relative_link_to_your_guide"> |
| 81 |
<title><i>Gentoo Linux Documentation Guide</i></title> |
| 82 |
<author title="<i>Chief Architect</i>"> |
| 83 |
<mail link="<i>drobbins@gentoo.org</i>"><i>Daniel Robbins</i></mail> |
| 84 |
</author> |
| 85 |
<author title="<i>Editor</i>"> |
| 86 |
<mail link="<i>thomasfl@gentoo.org</i>"><i>Thomas Flavel</i></mail> |
| 87 |
</author> |
| 88 |
|
| 89 |
<abstract> |
| 90 |
<i>This guide shows you how to compose web documentation using |
| 91 |
our new lightweight Gentoo GuideXML syntax. This syntax is the official |
| 92 |
format for Gentoo Linux web documentation, and this document itself was created |
| 93 |
using GuideXML.</i> |
| 94 |
</abstract> |
| 95 |
|
| 96 |
<license/> |
| 97 |
|
| 98 |
<version><i>1.0</i></version> |
| 99 |
<date><i>29 Mar 2001</i></date> |
| 100 |
</pre> |
| 101 |
|
| 102 |
<p> |
| 103 |
On the first, line, we see the requisite tag that identifies this as an XML |
| 104 |
document. Following it, there's a <c><guide></c> tag -- the entire |
| 105 |
guide document is enclosed within a <c><guide> </guide></c> pair. |
| 106 |
Next, there's a <c><title></c> tag, used to set the title for the entire |
| 107 |
guide document. |
| 108 |
</p> |
| 109 |
|
| 110 |
<p> |
| 111 |
Then, we come to the <c><author></c> tags, which contain information |
| 112 |
about the various authors of the document. Each <c><author></c> tag |
| 113 |
allows for an optional <c>title=</c> element, used to specify the author's |
| 114 |
relationship to the document (author, co-author, editor, etc.). In this |
| 115 |
particular example, the authors' names are enclosed in another tag -- a |
| 116 |
<c><mail></c> tag, used to specify an email address for this particular |
| 117 |
person. The <c><mail></c> tag is optional and can be omitted, and no |
| 118 |
more than one <c><author></c> element is required per guide document. |
| 119 |
</p> |
| 120 |
|
| 121 |
<p> |
| 122 |
Next, we come to the <c><abstract></c>, <c><version></c> and |
| 123 |
<c><date></c> tags, used to specify a summary of the document, the |
| 124 |
current version number, and the current version date (in DD MMM YYYY format) |
| 125 |
respectively. This rounds out the tags that should appear at the beginning of |
| 126 |
a guide document. Besides the <c><title></c> and <c><mail></c> |
| 127 |
tags, these tags shouldn't appear anywhere else except immediately inside the |
| 128 |
<c><guide></c> tag, and for consistency it's recommended (but not |
| 129 |
required) that these tags appear before the content of the document. |
| 130 |
</p> |
| 131 |
|
| 132 |
<p> |
| 133 |
Finally we have the <c><license/></c> tag, used to publish the |
| 134 |
document under the <uri link="http://creativecommons.org/licenses/by-sa/1.0/">Creative |
| 135 |
Commons - Attribution / Share Alike</uri> license as required by the <uri |
| 136 |
link="/doc/en/doc-policy.xml">Documentation Policy</uri>. |
| 137 |
</p> |
| 138 |
|
| 139 |
</body> |
| 140 |
</section> |
| 141 |
<section> |
| 142 |
<title>Chapters and sections</title> |
| 143 |
<body> |
| 144 |
|
| 145 |
<p> |
| 146 |
Once the initial tags have been specified, you're ready to start adding |
| 147 |
the structural elements of the document. Guide documents are divided into |
| 148 |
chapters, and each chapter can hold one or more sections. Every chapter |
| 149 |
and section has a title. Here's an example chapter with a single section, |
| 150 |
consisting of a paragraph. If you append this XML to the XML in the <uri link="#doc_chap2_pre1">previous |
| 151 |
excerpt</uri> and append a <c></guide></c> to the end of the file, you'll have a valid |
| 152 |
(if minimal) guide document: |
| 153 |
</p> |
| 154 |
|
| 155 |
<pre> |
| 156 |
<chapter> |
| 157 |
<title><i>This is my chapter</i></title> |
| 158 |
<section> |
| 159 |
<title><i>This is section one of my chapter</i></title> |
| 160 |
<body> |
| 161 |
|
| 162 |
<p> |
| 163 |
<i>This is the actual text content of my section.</i> |
| 164 |
</p> |
| 165 |
|
| 166 |
</body> |
| 167 |
</section> |
| 168 |
</chapter> |
| 169 |
</pre> |
| 170 |
|
| 171 |
<p> |
| 172 |
Above, I set the chapter title by adding a child <c><title></c> |
| 173 |
element to the <c><chapter></c> element. Then, I created a section by |
| 174 |
adding a <c><section></c> element. If you look inside the |
| 175 |
<c><section></c> element, you'll see that it has two child elements -- a |
| 176 |
<c><title></c> and a <c><body></c>. While the <c><title></c> |
| 177 |
is nothing new, the <c><body></c> is -- it contains the actual text |
| 178 |
content of this particular section. We'll look at the tags that are allowed |
| 179 |
inside a <c><body></c> element in a bit. |
| 180 |
</p> |
| 181 |
|
| 182 |
<note> |
| 183 |
A <c><guide></c> element can contain multiple <c><chapter></c> |
| 184 |
elements, and a <c><chapter></c> can contain multiple |
| 185 |
<c><section></c> elements. However, a <c><section></c> |
| 186 |
element can only contain one <c><body></c> element. |
| 187 |
</note> |
| 188 |
|
| 189 |
</body> |
| 190 |
</section> |
| 191 |
<section> |
| 192 |
<title>An example <body></title> |
| 193 |
<body> |
| 194 |
|
| 195 |
<p> |
| 196 |
Now, it's time to learn how to mark up actual content. Here's the XML code for an example <c><body></c> element: |
| 197 |
</p> |
| 198 |
|
| 199 |
<pre> |
| 200 |
<p> |
| 201 |
This is a paragraph. <path>/etc/passwd</path> is a file. |
| 202 |
<uri>http://www.gentoo.org</uri> is my favorite website. |
| 203 |
Type <c>ls</c> if you feel like it. I <e>really</e> want to go to sleep now. |
| 204 |
</p> |
| 205 |
|
| 206 |
<pre> |
| 207 |
This is text output or code. |
| 208 |
# <i>this is user input</i> |
| 209 |
|
| 210 |
Make HTML/XML easier to read by using selective emphasis: |
| 211 |
<foo><i>bar</i></foo> |
| 212 |
|
| 213 |
<codenote>This is how to insert an inline note into the code block</codenote> |
| 214 |
</pre> |
| 215 |
|
| 216 |
<note> |
| 217 |
This is a note. |
| 218 |
</note> |
| 219 |
|
| 220 |
<warn> |
| 221 |
This is a warning. |
| 222 |
</warn> |
| 223 |
|
| 224 |
<impo> |
| 225 |
This is important. |
| 226 |
</impo> |
| 227 |
</pre> |
| 228 |
|
| 229 |
<p> |
| 230 |
Now, here's how this <c><body></c> element is rendered: |
| 231 |
</p> |
| 232 |
|
| 233 |
<p> |
| 234 |
This is a paragraph. <path>/etc/passwd</path> is a file. |
| 235 |
<uri>http://www.gentoo.org</uri> is my favorite website. |
| 236 |
Type <c>ls</c> if you feel like it. I <e>really</e> want to go to sleep now. |
| 237 |
</p> |
| 238 |
|
| 239 |
<pre> |
| 240 |
This is text output or code. |
| 241 |
# <i>this is user input</i> |
| 242 |
|
| 243 |
Make HTML/XML easier to read by using selective emphasis: |
| 244 |
<foo><i>bar</i></foo> |
| 245 |
|
| 246 |
<codenote>This is how to insert an inline note into the code block</codenote> |
| 247 |
</pre> |
| 248 |
|
| 249 |
<note> |
| 250 |
This is a note. |
| 251 |
</note> |
| 252 |
|
| 253 |
<warn> |
| 254 |
This is a warning. |
| 255 |
</warn> |
| 256 |
|
| 257 |
<impo> |
| 258 |
This is important. |
| 259 |
</impo> |
| 260 |
|
| 261 |
</body> |
| 262 |
</section> |
| 263 |
<section> |
| 264 |
<title>The <body> tags</title> |
| 265 |
<body> |
| 266 |
|
| 267 |
<p> |
| 268 |
We introduced a lot of new tags in the previous section -- here's what you |
| 269 |
need to know. The <c><p></c> (paragraph), <c><pre></c> (code |
| 270 |
block), <c><note></c>, <c><warn></c> (warning) and |
| 271 |
<c><impo></c> (important) tags all can contain one or more lines of text. |
| 272 |
Besides the <c><table></c> element (which we'll cover in just a bit), |
| 273 |
these are the only tags that should appear immediately inside a |
| 274 |
<c><body></c> element. Another thing -- these tags <e>should not</e> be |
| 275 |
stacked -- in other words, don't put a <c><note></c> element inside a |
| 276 |
<c><p></c> element. As you might guess, the <c><pre></c> element |
| 277 |
preserves its whitespace exactly, making it well-suited for code excerpts. |
| 278 |
You can also name the <c><pre></c> tag: |
| 279 |
</p> |
| 280 |
|
| 281 |
<pre caption = "Named <pre>"> |
| 282 |
<pre caption = "Output of uptime"> |
| 283 |
# <i>uptime</i> |
| 284 |
16:50:47 up 164 days, 2:06, 5 users, load average: 0.23, 0.20, 0.25 |
| 285 |
</pre> |
| 286 |
</pre> |
| 287 |
|
| 288 |
</body> |
| 289 |
</section> |
| 290 |
<section> |
| 291 |
<title><path>, <c> and <e></title> |
| 292 |
<body> |
| 293 |
|
| 294 |
<p> |
| 295 |
The <c><path></c>, <c><c></c> and <c><e></c> elements can |
| 296 |
be used inside any child <c><body></c> tag, except for |
| 297 |
<c><pre></c>. |
| 298 |
</p> |
| 299 |
|
| 300 |
<p> |
| 301 |
The <c><path></c> element is used to mark text that refers to an |
| 302 |
<e>on-disk file</e> -- either an <e>absolute or relative path</e>, or a |
| 303 |
<e>simple filename</e>. This element is generally rendered with a monospaced |
| 304 |
font to offset it from the standard paragraph type. |
| 305 |
</p> |
| 306 |
|
| 307 |
<p> |
| 308 |
The <c><c></c> element is used to mark up a <e>command</e> or <e>user |
| 309 |
input</e>. Think of <c><c></c> as a way to alert the reader to something |
| 310 |
that they can type in that will perform some kind of action. For example, all |
| 311 |
the XML tags displayed in this document are enclosed in a <c><c></c> |
| 312 |
element because they represent something that the user could type in that is |
| 313 |
not a path. By using <c><c></c> elements, you'll help your readers |
| 314 |
quickly identify commands that they need to type in. Also, because |
| 315 |
<c><c></c> elements are already offset from regular text, <e>it is rarely |
| 316 |
necessary to surround user input with double-quotes</e>. For example, don't |
| 317 |
refer to a "<c><c></c>" element like I did in this sentence. Avoiding |
| 318 |
the use of unnecessary double-quotes makes a document more readable -- and |
| 319 |
adorable! |
| 320 |
</p> |
| 321 |
|
| 322 |
<p> |
| 323 |
<c><e></c> is used to apply emphasis to a word or phrase; for example: |
| 324 |
I <e>really</e> should use semicolons more often. As you can see, this text is |
| 325 |
offset from the regular paragraph type for emphasis. This helps to give your |
| 326 |
prose more <e>punch</e>! |
| 327 |
</p> |
| 328 |
|
| 329 |
</body> |
| 330 |
</section> |
| 331 |
<section> |
| 332 |
<title><mail> and <uri></title> |
| 333 |
<body> |
| 334 |
|
| 335 |
<p> |
| 336 |
We've taken a look at the <c><mail></c> tag earlier; it's used to link |
| 337 |
some text with a particular email address, and takes the form <c><mail |
| 338 |
link="foo@bar.com">Mr. Foo Bar</mail></c>. |
| 339 |
</p> |
| 340 |
|
| 341 |
<p> |
| 342 |
The <c><uri></c> tag is used to point to files/locations on the |
| 343 |
Internet. It has two forms -- the first can be used when you want to have the |
| 344 |
actual URI displayed in the body text, such as this link to |
| 345 |
<uri>http://www.gentoo.org</uri>. To create this link, I typed |
| 346 |
<c><uri>http://www.gentoo.org</uri></c>. The alternate form is |
| 347 |
when you want to associate a URI with some other text -- for example, <uri |
| 348 |
link="http://www.gentoo.org">the Gentoo Linux website</uri>. To create |
| 349 |
<e>this</e> link, I typed <c><uri link="http://www.gentoo.org">the |
| 350 |
Gentoo Linux website</uri></c>. |
| 351 |
</p> |
| 352 |
|
| 353 |
</body> |
| 354 |
</section> |
| 355 |
<section> |
| 356 |
<title>Figures</title> |
| 357 |
|
| 358 |
<body> |
| 359 |
|
| 360 |
<p> |
| 361 |
Here's how to insert a figure into a document -- <c><figure |
| 362 |
link="mygfx.png" short="my picture" caption="my favorite picture of all |
| 363 |
time"/></c>. The <c>link=</c> attribute points to the actual graphic image, |
| 364 |
the <c>short=</c> attribute specifies a short description (currently used for |
| 365 |
the image's HTML <c>alt=</c> attribute), and a caption. Not too difficult |
| 366 |
:) We also support the standard HTML-style <img src="foo.gif"/> tag |
| 367 |
for adding images without captions, borders, etc. |
| 368 |
</p> |
| 369 |
|
| 370 |
</body> |
| 371 |
</section> |
| 372 |
<section> |
| 373 |
<title>Tables and lists</title> |
| 374 |
<body> |
| 375 |
|
| 376 |
<p> |
| 377 |
Guide supports a simplified table syntax similar to that of HTML. To start |
| 378 |
a table, use a <c><table></c> tag. Start a row with a <c><tr></c> |
| 379 |
tag. However, for inserting actual table data, we <e>don't</e> support the |
| 380 |
HTML <td> tag; instead, use the <c><th></c> if you are inserting a |
| 381 |
header, and <c><ti></c> if you are inserting a normal informational |
| 382 |
block. You can use a <c><th></c> anywhere you can use a <c><ti></c> |
| 383 |
-- there's no requirement that <c><th></c> elements appear only in the |
| 384 |
first row. Currently, these tags don't support any attributes, but some will |
| 385 |
be added (such as a <c>caption=</c> attribute for <c><table></c>) soon. |
| 386 |
</p> |
| 387 |
|
| 388 |
<p> |
| 389 |
To create ordered or unordered lists, simply use the HTML-style |
| 390 |
<c><ol></c>, <c><ul></c> and <c><li></c> tags. List tags |
| 391 |
should only appear inside a <c><p></c>, <c><ti></c>, |
| 392 |
<c><note></c>, <c><warn></c> or <c><impo></c> tag. |
| 393 |
</p> |
| 394 |
|
| 395 |
</body> |
| 396 |
</section> |
| 397 |
<section> |
| 398 |
<title>Intra-document references</title> |
| 399 |
<body> |
| 400 |
|
| 401 |
<p> |
| 402 |
Guide makes it really easy to reference other parts of the document using |
| 403 |
hyperlinks. You can create a link pointing to <uri link="#doc_chap1">Chapter |
| 404 |
One</uri> by typing <c><uri link="#doc_chap1">Chapter |
| 405 |
One</uri></c>. To point to <uri link="#doc_chap1_sect2">section two of |
| 406 |
Chapter One</uri>, type <c><uri link="#doc_chap1_sect2">section two of |
| 407 |
Chapter One</uri></c>. To refer to figure 3 in chapter 1, type <c><uri |
| 408 |
link="doc_chap1_fig3">figure 1.3</uri></c>. Or, to refer to <uri |
| 409 |
link="#doc_chap2_pre2">code listing 2 in chapter 2</uri>, type <c><uri |
| 410 |
link="doc_chap2_pre2">code listing 2.2</uri></c>. We'll be |
| 411 |
adding other auto-link abilities (such as table support) soon. |
| 412 |
</p> |
| 413 |
|
| 414 |
</body> |
| 415 |
</section> |
| 416 |
</chapter> |
| 417 |
|
| 418 |
<chapter> |
| 419 |
<title>Coding Style</title> |
| 420 |
<section> |
| 421 |
<title>Introduction</title> |
| 422 |
<body> |
| 423 |
|
| 424 |
<p> |
| 425 |
Since all Gentoo Documentation is a joint effort and several people will |
| 426 |
most likely change existing documentation, a coding style is needed. |
| 427 |
A coding style contains two sections. The first one is regarding |
| 428 |
internal coding - how the xml-tags are placed. The second one is |
| 429 |
regarding the content - how not to confuse the reader. |
| 430 |
</p> |
| 431 |
|
| 432 |
<p> |
| 433 |
Both sections are described next. |
| 434 |
</p> |
| 435 |
|
| 436 |
</body> |
| 437 |
</section> |
| 438 |
<section> |
| 439 |
<title>Internal Coding Style</title> |
| 440 |
<body> |
| 441 |
|
| 442 |
<p> |
| 443 |
<b>Newlines</b> must be placed immediately after <e>every</e> |
| 444 |
GuideXML-tag (both opening as closing), except for: |
| 445 |
<c><version></c>, <c><date></c>, <c><title></c>, |
| 446 |
<c><th></c>, <c><ti></c>, |
| 447 |
<c><li></c>, <c><i></c>, <c><e></c>, |
| 448 |
<c><uri></c>, <c><path></c>, <c><b></c>, |
| 449 |
<c><comment></c>, <c><codenote></c>, <c><mail></c>. |
| 450 |
</p> |
| 451 |
|
| 452 |
<p> |
| 453 |
<b>Blank lines</b> must be placed immediately after <e>every</e> |
| 454 |
<c><body></c> (opening tag only) and before <e>every</e> |
| 455 |
<c><chapter></c>, <c><p></c>, <c><table></c>, |
| 456 |
<c><author></c> (set), <c><pre></c>, <c><ul></c>, |
| 457 |
<c><ol></c>, <c><warn></c>, <c><note></c> and |
| 458 |
<c><impo></c> (opening tags only). |
| 459 |
</p> |
| 460 |
|
| 461 |
<p> |
| 462 |
<b>Word-wrapping</b> must be applied at 80 characters except inside |
| 463 |
<c><pre></c>. Only when there is no other choice can be deviated from |
| 464 |
this rule (for instance when a URL exceeds the maximum amount of characters). |
| 465 |
The editor must then wrap whenever the first whitespace occurs. |
| 466 |
</p> |
| 467 |
|
| 468 |
<p> |
| 469 |
<b>Indentation</b> may not be used, except with the XML-constructs of which |
| 470 |
the parent XML-tags are <c><tr></c> (from <c><table></c>), |
| 471 |
<c><ul></c>, <c><ol></c> and <c><author></c>. If indentation |
| 472 |
is used, it <e>must</e> be two spaces for each indentation. That means <e>no</e> |
| 473 |
tabs and <e>not</e> more spaces. |
| 474 |
</p> |
| 475 |
|
| 476 |
<p> |
| 477 |
In case word-wrapping happens in <c><ti></c>, <c><th></c> or |
| 478 |
<c><li></c> constructs, indentation must be used for the content. |
| 479 |
</p> |
| 480 |
|
| 481 |
<p> |
| 482 |
An example for indentation is: |
| 483 |
</p> |
| 484 |
|
| 485 |
<pre caption = "Indentation Example"> |
| 486 |
<table> |
| 487 |
<tr> |
| 488 |
<th>Foo</th> |
| 489 |
<th>Bar</th> |
| 490 |
</tr> |
| 491 |
<tr> |
| 492 |
<ti>This is an example for indentation.</ti> |
| 493 |
<ti> |
| 494 |
In case text cannot be shown within an 80-character wide line, you |
| 495 |
must use indentation if the parent tag allows it. |
| 496 |
</ti> |
| 497 |
</tr> |
| 498 |
</table> |
| 499 |
|
| 500 |
<ul> |
| 501 |
<li>First option</li> |
| 502 |
<li>Second option</li> |
| 503 |
</ul> |
| 504 |
</pre> |
| 505 |
|
| 506 |
<p> |
| 507 |
<b>Attributes</b> may not have spaces in between the attribute, the |
| 508 |
"=" mark, and the attribute value. As an example: |
| 509 |
</p> |
| 510 |
|
| 511 |
<pre caption="Attributes"> |
| 512 |
<comment>Wrong :</comment> <pre caption = "Attributes"> |
| 513 |
<comment>Correct:</comment> <pre caption="Attributes"> |
| 514 |
</pre> |
| 515 |
|
| 516 |
</body> |
| 517 |
</section> |
| 518 |
<section> |
| 519 |
<title>External Coding Style</title> |
| 520 |
<body> |
| 521 |
|
| 522 |
<p> |
| 523 |
Inside tables (<c><table></c>) and listings (<c><ul></c> and |
| 524 |
<c><ol></c>), periods (".") should not be used unless multiple |
| 525 |
sentences are used. In that case, every sentence should end with a period (or |
| 526 |
other reading marks). |
| 527 |
</p> |
| 528 |
|
| 529 |
<p> |
| 530 |
Every sentence, including those inside tables and listings, should start |
| 531 |
with a capital letter. |
| 532 |
</p> |
| 533 |
|
| 534 |
<pre caption="Periods and capital letters"> |
| 535 |
<ul> |
| 536 |
<li>No period</li> |
| 537 |
<li>With period. Multiple sentences, remember?</li> |
| 538 |
</ul> |
| 539 |
</pre> |
| 540 |
|
| 541 |
<p> |
| 542 |
Code Listings should <e>always</e> have a <c>caption</c>. |
| 543 |
</p> |
| 544 |
|
| 545 |
<p> |
| 546 |
Try to use <c><uri></c> with the <c>link</c> attribute as much as |
| 547 |
possible. In other words, the <uri link="http://www.gentoo.org">Gentoo |
| 548 |
Website</uri> is preferred over <uri>http://www.gentoo.org</uri>. |
| 549 |
</p> |
| 550 |
|
| 551 |
<p> |
| 552 |
When you comment something inside a <c><pre></c> construct, only use |
| 553 |
<c><codenote></c> if the content is a C or C++ code snippet. Otherwise, |
| 554 |
use <c><comment></c> and parantheses. Also place the comment <e>before</e> |
| 555 |
the subject of the comment. |
| 556 |
</p> |
| 557 |
|
| 558 |
<pre caption="Comment example"> |
| 559 |
<comment>(Substitute "john" with your user name)</comment> |
| 560 |
# <i>id john</i> |
| 561 |
</pre> |
| 562 |
|
| 563 |
</body> |
| 564 |
</section> |
| 565 |
</chapter> |
| 566 |
|
| 567 |
<chapter> |
| 568 |
<title>Resources</title> |
| 569 |
<section> |
| 570 |
<title>Start writing</title> |
| 571 |
<body> |
| 572 |
|
| 573 |
<p> |
| 574 |
Guide has been specially designed to be "lean and mean" so that developers |
| 575 |
can spend more time writing documentation and less time learning the actual XML |
| 576 |
syntax. Hopefully, this will allow developers who aren't unusually "doc-savvy" |
| 577 |
to start writing quality Gentoo Linux documentation. If you'd like to help (or |
| 578 |
have any questions about guide), please post a message to the <mail |
| 579 |
link="gentoo-doc@gentoo.org">gentoo-doc mailing list</mail> stating what you'd |
| 580 |
like to tackle. Have fun! |
| 581 |
</p> |
| 582 |
|
| 583 |
</body> |
| 584 |
</section> |
| 585 |
</chapter> |
| 586 |
</guide> |
Parent Directory
| 
Revision Log