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

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

Parent Directory | Revision Log | View Patch Patch

Revision 1.3		Revision 1.36
1	<?xml version='1.0' encoding="UTF-8"?>	1	<?xml version='1.0' encoding="UTF-8"?>
2	<?xml-stylesheet href="/xsl/guide.xsl" type="text/xsl"?>	2	<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.36 2005/02/14 16:14:46 swift Exp $ -->
3
4	<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">	3	<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
5		4
6	<guide link="/doc/en/xml-guide.xml">	5	<guide link="/doc/en/xml-guide.xml">
7	<title>Gentoo Linux Documentation Guide</title>	6	<title>Gentoo Linux XML Guide</title>
8	<author title="Chief Architect"><mail link="drobbins@gentoo.org">Daniel Robbins</mail></author>
9		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	<author title="Editor">
		18	<mail link="swift@gentoo.org">Sven Vermeulen</mail>
		19	</author>
		20	<author title="Editor">
		21	<mail link="neysx@gentoo.org">Xavier Neys</mail>
		22	</author>
		23
		24	<abstract>
10	<abstract>This guide shows you how to compose web documentation using the new lightweight Gentoo guide	25	This guide shows you how to compose web documentation using the new lightweight
11	XML syntax. This syntax is the official format for Gentoo Linux documentation, and this document	26	Gentoo GuideXML syntax. This syntax is the official format for Gentoo Linux
12	itself was created using guide XML. This guide assumes a basic working knowledge of XML and HTML.	27	documentation, and this document itself was created using GuideXML. This guide
		28	assumes a basic working knowledge of XML and HTML.
13	</abstract>	29	</abstract>
14		30
		31	<!-- The content of this document is licensed under the CC-BY-SA license -->
		32	<!-- See http://creativecommons.org/licenses/by-sa/2.0 -->
		33	<license/>
		34
15	<version>1.0</version>	35	<version>2.13</version>
16	<date>07 Mar 2002</date>	36	<date>2005-02-14</date>
17		37
18	<chapter>	38	<chapter>
19	<title>Guide basics</title>	39	<title>Guide basics</title>
20
21	<section>	40	<section>
22	<title>Guide XML design goals</title>	41	<title>Guide XML design goals</title>
23	<body>	42	<body>
24		43
		44	<p>
25	<p> The guide XML syntax is lightweight yet expressive, so that it is easy to	45	The guide XML syntax is lightweight yet expressive, so that it is easy to
26	learn yet also provides all the features we need for the creation of web	46	learn yet also provides all the features we need for the creation of web
27	documentation. The number of tags is kept to a minimum -- just those we need.	47	documentation. The number of tags is kept to a minimum -- just those we need.
28	This makes it easy to transform guide into other formats, such as DocBook	48	This makes it easy to transform guide into other formats, such as DocBook
29	XML/SGML or web-ready HTML. </p>	49	XML/SGML or web-ready HTML.
		50	</p>
30		51
		52	<p>
31	<p>The goal is to make it easy to <e>create</e> and <e>transform</e> guide XML	53	The goal is to make it easy to <e>create</e> and <e>transform</e> guide XML
32	documents.</p>	54	documents.
		55	</p>
33		56
34	</body>	57	</body>
35	</section>
36
37	<section>	58	</section>
38	<title>How to transform guide XML into HTML</title>	59	<section>
		60	<title>Further Resources</title>
39	<body>	61	<body>
40		62
41	<p> Before we take a look at the guide syntax itself, it's helpful to know how
42	guide XML is transformed into web-ready HTML. To do this, we use a special
43	file called <path>guide-main.xsl</path>, along with a command-line XSLT processing
44	tool (also called an "engine"). The <path>guide-main.xsl</path> file describes
45	exactly how to transform the contents of the source guide XML document to
46	create the target HTML file. Two popular XSLT processors are <c>sabcmd</c>
47	(included in the <path>app-text/sablotron</path> package) and <c>xsltproc</c>
48	(found in the <path>dev-libs/libxslt</path> package). From experience, we've
49	found that <c>xsltproc</c> is the higher-quality and more feature-rich XSLT
50	processor. </p>
51
52	<p> Once you have either <c>xsltproc</c> or <c>sabcmd</c> installed, you're
53	ready to convert guide XML into web-ready HTML. Here's how it works. First,
54	download the latest snapshot of our Web site from
55	<uri>http://www.gentoo.org/projects/xml.html</uri>, found in the <uri
56	link="http://www.gentoo.org/projects/guide-xml-latest.tar.gz">xml-guide-latest.tar.gz</uri>
57	file. Extract the tarball. Inside it, you'll find a <path>gentoo-src</path>
58	directory, as well as a <path>gentoo-src/xml</path> directory, etc. Now, find
59	<path>gentoo-src/xml/install.xml</path>. (The new user installation guide).
60	This will be our source XML guide document. The easiest way to perform the
61	transformation is to change directories to the location of the
62	<path>guide-main.xsl</path> file. Then, execute <c>xsltproc</c> as follows:
63	</p>	63	<p>
64		64	If you are planning on contributing documentation to Gentoo, or you want to
65	<pre>	65	test GuideXML, please read the <uri
66	# <i>cd gentoo-web/xsl</i>	66	link="/proj/en/gdp/doc/doc-tipsntricks.xml">Tips and Tricks</uri> which
67	# <i>xsltproc guide-main.xsl ../xml/install.xml > /tmp/install.html</i>	67	contains tips and tricks for documentation development.
68	</pre>
69
70	<p> If all went well, you should have a web-ready version of
71	<path>install.xml</path> at <path>/tmp/install.html</path>. For this document
72	to display properly in a web browser, you may have to copy some files from
73	<path>gentoo-web</path> to <path>/tmp</path>, such
74	as <path>css/main-new.css</path> and (to be safe) the entire <path>images</path>
75	directory.
76	</p>	68	</p>
77		69
78	</body>	70	</body>
79	</section>	71	</section>
80	</chapter>	72	</chapter>
		73
81	<chapter>	74	<chapter>
82	<title>Guide XML</title>	75	<title>Guide XML</title>
83	<section>	76	<section>
84	<title>Basic structure</title>	77	<title>Basic structure</title>
85	<body>	78	<body>
86		79
87	<p>Now that you know how to transform guide XML, you're ready to start learning	80	<p>
88	the guide XML syntax. We'll start with the the initial tags used in a guide	81	Let's start learning the GuideXML syntax. We'll start with the the initial
89	XML document: </p>	82	tags used in a GuideXML document:
		83	</p>
90		84
91	<pre caption="The initial part of a guide XML document">	85	<pre caption="The initial part of a guide XML document">
92	<?xml version='1.0'?>	86	<?xml version='1.0' encoding="UTF-8"?>
93	<guide>	87	<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
		88	<guide link="<i>relative/link/to/your/guide.xml</i>" lang="<i>en</i>">
94	<title><i>Gentoo Linux Documentation Guide</i></title>	89	<title><i>Gentoo Linux Documentation Guide</i></title>
95	<author title="<i>Chief Architect</i>"><mail link="<i>drobbins@gentoo.org</i>">	90	<author title="<i>Author</i>">
96	<i>Daniel Robbins</i></mail>	91	<mail link="<i>yourname@gentoo.org</i>"><i>Your Name</i></mail>
97	</author>	92	</author>
98	<author title="<i>Editor</i>"><mail link="<i>thomasfl@gentoo.org</i>">
99	<i>Thomas Flavel</i></mail>
100	</author>
101		93
		94	<abstract>
102	<abstract><i>This guide shows you how to compose web documentation using	95	<i>This guide shows you how to compose web documentation using
103	our new lightweight Gentoo guide XML syntax. This syntax is the official	96	our new lightweight Gentoo GuideXML syntax. This syntax is the official
104	format for Gentoo Linux web documentation, and this document itself was created	97	format for Gentoo Linux web documentation, and this document itself was created
105	using guide XML.</i> </abstract>	98	using GuideXML.</i>
		99	</abstract>
		100
		101	<!-- The content of this document is licensed under the CC-BY-SA license -->
		102	<!-- See http://creativecommons.org/licenses/by-sa/2.0 -->
		103	<license/>
106		104
107	<version><i>1.0</i></version>	105	<version><i>1.0</i></version>
108	<date><i>29 Mar 2001</i></date>	106	<date><i>2004-12-25</i></date>
109	</pre>	107	</pre>
110		108
		109	<p>
111	<p>On the first, line, we see the requisite tag that identifies this as an XML	110	On the first, line, we see the requisite tag that identifies this as an XML
112	document. Following it, there's a <c><guide></c> tag -- the entire	111	document. Following it, there's a <c><guide></c> tag -- the entire
113	guide document is enclosed within a <c><guide> </guide></c> pair.	112	guide document is enclosed within a <c><guide> </guide></c> pair.
		113	The <c>link</c> attribute is compulsory and should preferably contain the
		114	relative path to the document even though the file name alone will work. It is
		115	mainly used to generate a link to a printer-friendly version of your document.
		116	If you use a wrong value, the link to the printable version will either not
		117	work or point to a wrong document. The <c>lang</c> attribute can be used to
		118	specify the language code of your document. It is used to format the date and
		119	insert strings like "<e>Note</e>", "<e>Content</e>", etc. in the specified
		120	language. The default is English.
		121	</p>
		122
		123	<p>
114	Next, there's a <c><title></c> tag, used to set the title for the entire	124	Next, there's a <c><title></c> tag, used to set the title for the entire
115	guide document. </p>	125	guide document.
		126	</p>
116		127
		128	<p>
117	<p>Then, we come to the <c><author></c> tags, which contain information	129	Then, we come to the <c><author></c> tags, which contain information
118	about the various authors of the document. Each <c><author></c> tag	130	about the various authors of the document. Each <c><author></c> tag
119	allows for an optional <c>title=</c> element, used to specify the author's	131	allows for an optional <c>title=</c> element, used to specify the author's
120	relationship to the document (author, co-author, editor, etc.). In this	132	relationship to the document (author, co-author, editor, etc.). In this
121	particular example, the authors' names are enclosed in another tag -- a	133	particular example, the authors' names are enclosed in another tag -- a
122	<c><mail></c> tag, used to specify an email address for this particular	134	<c><mail></c> tag, used to specify an email address for this particular
123	person. The <c><mail></c> tag is optional and can be omitted, and no	135	person. The <c><mail></c> tag is optional and can be omitted, and no
124	more than one <c><author></c> element is required per guide document.	136	more than one <c><author></c> element is required per guide document.
125	</p>	137	</p>
126		138
		139	<p>
127	<p>Next, we come to the <c><abstract></c>, <c><version></c> and	140	Next, we come to the <c><abstract></c>, <c><version></c> and
128	<c><date></c> tags, used to specify a summary of the document, the	141	<c><date></c> tags, used to specify a summary of the document, the
129	current version number, and the current version date (in DD MMM YYYY format)	142	current version number, and the current version date (in YYYY-MM-DD format)
		143	respectively. Dates that are invalid or not in the YYYY-MM-DD format will
		144	appear verbatim in the rendered document.
		145	</p>
		146
		147	<p>
130	respectively. This rounds out the tags that should appear at the beginning of	148	This rounds out the tags that should appear at the beginning of a guide
131	a guide document. Besides the <c><title></c> and <c><mail></c>	149	document. Besides the <c><title></c> and <c><mail></c> tags, these
132	tags, these tags shouldn't appear anywhere else except immediately inside the	150	tags shouldn't appear anywhere else except immediately inside the
133	<c><guide></c> tag, and for consistency it's recommended (but not	151	<c><guide></c> tag, and for consistency it's recommended (but not
134	required) that these tags appear before the content of the document. </p>	152	required) that these tags appear before the content of the document.
		153	</p>
135		154
136	</body>	155	<p>
137	</section>	156	Finally we have the <c><license/></c> tag, used to publish the
		157	document under the <uri link="http://creativecommons.org/licenses/by-sa/2.0/">Creative
		158	Commons - Attribution / Share Alike</uri> license as required by the <uri
		159	link="/doc/en/doc-policy.xml">Documentation Policy</uri>.
		160	</p>
138		161
		162	</body>
		163	</section>
139	<section>	164	<section>
140	<title>Chapters and sections</title>	165	<title>Chapters and sections</title>
141	<body>	166	<body>
		167
		168	<p>
142	<p>Once the initial tags have been specified, you're ready to start adding	169	Once the initial tags have been specified, you're ready to start adding
143	the structural elements of the document. Guide documents are divided into	170	the structural elements of the document. Guide documents are divided into
144	chapters, and each chapter can hold one or more sections. Every chapter	171	chapters, and each chapter can hold one or more sections. Every chapter
145	and section has a title. Here's an example chapter with a single section,	172	and section has a title. Here's an example chapter with a single section,
146	consisting of a paragraph. If you append this XML to the XML in the <uri link="#doc_pre2">previous	173	consisting of a paragraph. If you append this XML to the XML in the <uri link="#doc_chap2_pre1">previous
147	excerpt</uri> and append a <c></guide></c> to the end of the file, you'll have a valid	174	excerpt</uri> and append a <c></guide></c> to the end of the file, you'll have a valid
148	(if minimal) guide document:	175	(if minimal) guide document:
149	</p>	176	</p>
150		177
151	<pre>	178	<pre>
152	<chapter>	179	<chapter>
153	<title><i>This is my chapter</i></title>	180	<title><i>This is my chapter</i></title>
154	<section>	181	<section>
155	<title><i>This is section one of my chapter</i></title>	182	<title><i>This is section one of my chapter</i></title>
156	<body>	183	<body>
		184
		185	<p>
157	<p><i>This is the actual text content of my section.</i></p>	186	<i>This is the actual text content of my section.</i>
		187	</p>
		188
158	</body>	189	</body>
159	</section>	190	</section>
160	</chapter>	191	</chapter>
161	</pre>	192	</pre>
162		193
		194	<p>
163	<p>Above, I set the chapter title by adding a child <c><title></c>	195	Above, I set the chapter title by adding a child <c><title></c>
164	element to the <c><chapter></c> element. Then, I created a section by	196	element to the <c><chapter></c> element. Then, I created a section by
165	adding a <c><section></c> element. If you look inside the	197	adding a <c><section></c> element. If you look inside the
166	<c><section></c> element, you'll see that it has two child elements -- a	198	<c><section></c> element, you'll see that it has two child elements -- a
167	<c><title></c> and a <c><body></c>. While the <c><title></c>	199	<c><title></c> and a <c><body></c>. While the <c><title></c>
168	is nothing new, the <c><body></c> is -- it contains the actual text	200	is nothing new, the <c><body></c> is -- it contains the actual text
169	content of this particular section. We'll look at the tags that are allowed	201	content of this particular section. We'll look at the tags that are allowed
170	inside a <c><body></c> element in a bit. </p>	202	inside a <c><body></c> element in a bit.
		203	</p>
171		204
		205	<note>
172	<note>A <c><guide></c> element can contain multiple	206	A <c><guide></c> element can contain multiple <c><chapter></c>
173	<c><chapter></c> elements, and a <c><chapter></c> can contain	207	elements, and a <c><chapter></c> can contain multiple
174	multiple <c><section></c> elements. However, a <c><section></c>	208	<c><section></c> elements. However, a <c><section></c>
175	element can only contain one <c><body></c> element. </note>	209	element can only contain one <c><body></c> element.
		210	</note>
176		211
177	</body>	212	</body>
178	</section>	213	</section>
179
180	<section>	214	<section>
181	<title>An example <body></title>	215	<title>An example <body></title>
182	<body>	216	<body>
		217
183	<p>	218	<p>
184	Now, it's time to learn how to mark up actual content. Here's the XML code for an example <c><body></c> element:	219	Now, it's time to learn how to mark up actual content. Here's the XML code for an example <c><body></c> element:
185	</p>	220	</p>
		221
186	<pre>	222	<pre>
187	<p>	223	<p>
188	This is a paragraph. <path>/etc/passwd</path> is a file.	224	This is a paragraph. <path>/etc/passwd</path> is a file.
189	<uri>http://www.gentoo.org</uri> is my favorite website.	225	<uri>http://forums.gentoo.org</uri> is my favorite website.
190	Type <c>ls</c> if you feel like it. I <e>really</e> want to go to sleep now.	226	Type <c>ls</c> if you feel like it. I <e>really</e> want to go to sleep now.
191	</p>	227	</p>
192		228
193	<pre>	229	<pre>
194	This is text output or code.	230	This is text output or code.
…		…
197	Make HTML/XML easier to read by using selective emphasis:	233	Make HTML/XML easier to read by using selective emphasis:
198	<foo><i>bar</i></foo>	234	<foo><i>bar</i></foo>
199		235
200	<codenote>This is how to insert an inline note into the code block</codenote>	236	<codenote>This is how to insert an inline note into the code block</codenote>
201	</pre>	237	</pre>
202	<note>This is a note.</note>	238
203	<warn>This is a warning.</warn>	239	<note>
204	<impo>This is important.</impo>	240	This is a note.
		241	</note>
		242
		243	<warn>
		244	This is a warning.
		245	</warn>
		246
		247	<impo>
		248	This is important.
		249	</impo>
205	</pre>	250	</pre>
		251
		252	<p>
206	<p>Now, here's how this <c><body></c> element is rendered:</p>	253	Now, here's how this <c><body></c> element is rendered:
		254	</p>
207		255
208	<p>	256	<p>
209	This is a paragraph. <path>/etc/passwd</path> is a file.	257	This is a paragraph. <path>/etc/passwd</path> is a file.
210	<uri>http://www.gentoo.org</uri> is my favorite website.	258	<uri>http://forums.gentoo.org</uri> is my favorite website.
211	Type <c>ls</c> if you feel like it. I <e>really</e> want to go to sleep now.	259	Type <c>ls</c> if you feel like it. I <e>really</e> want to go to sleep now.
212	</p>	260	</p>
213		261
214	<pre>	262	<pre>
215	This is text output or code.	263	This is text output or code.
…		…
218	Make HTML/XML easier to read by using selective emphasis:	266	Make HTML/XML easier to read by using selective emphasis:
219	<foo><i>bar</i></foo>	267	<foo><i>bar</i></foo>
220		268
221	<codenote>This is how to insert an inline note into the code block</codenote>	269	<codenote>This is how to insert an inline note into the code block</codenote>
222	</pre>	270	</pre>
223	<note>This is a note.</note>
224	<warn>This is a warning.</warn>
225	<impo>This is important.</impo>
226	</body>
227	</section>
228		271
		272	<note>
		273	This is a note.
		274	</note>
		275
		276	<warn>
		277	This is a warning.
		278	</warn>
		279
		280	<impo>
		281	This is important.
		282	</impo>
		283
		284	</body>
		285	</section>
229	<section>	286	<section>
230	<title>The <body> tags</title>	287	<title>The <body> tags</title>
231	<body>	288	<body>
232		289
		290	<p>
233	<p> We introduced a lot of new tags in the previous section -- here's what you	291	We introduced a lot of new tags in the previous section -- here's what you
234	need to know. The <c><p></c> (paragraph), <c><pre></c> (code	292	need to know. The <c><p></c> (paragraph), <c><pre></c> (code
235	block), <c><note></c>, <c><warn></c> (warning) and	293	block), <c><note></c>, <c><warn></c> (warning) and
236	<c><impo></c> (important) tags all can contain one or more lines of text.	294	<c><impo></c> (important) tags all can contain one or more lines of text.
237	Besides the <c><table></c> element (which we'll cover in just a bit),	295	Besides the <c><table></c> element (which we'll cover in just a bit),
238	these are the only tags that should appear immediately inside a	296	these are the only tags that should appear immediately inside a
239	<c><body></c> element. Another thing -- these tags <e>should not</e> be	297	<c><body></c> element. Another thing -- these tags <e>should not</e> be
240	stacked -- in other words, don't put a <c><note></c> element inside a	298	stacked -- in other words, don't put a <c><note></c> element inside a
241	<c><p></c> element. As you might guess, the <c><pre></c> element	299	<c><p></c> element. As you might guess, the <c><pre></c> element
242	preserves its whitespace exactly, making it well-suited for code excerpts.</p>	300	preserves its whitespace exactly, making it well-suited for code excerpts.
		301	You can also name the <c><pre></c> tag:
		302	</p>
		303
		304	<pre caption = "Named <pre>">
		305	<pre caption = "Output of uptime">
		306	# <i>uptime</i>
		307	16:50:47 up 164 days, 2:06, 5 users, load average: 0.23, 0.20, 0.25
		308	</pre>
		309	</pre>
243		310
244	</body>	311	</body>
245	</section>	312	</section>
246	<section>	313	<section>
247	<title><path>, <c> and <e></title>	314	<title><path>, <c> and <e></title>
248	<body>	315	<body>
249		316
		317	<p>
250	<p>The <c><path></c>, <c><c></c> and <c><e></c> elements can	318	The <c><path></c>, <c><c></c> and <c><e></c> elements can
251	be used inside any child <c><body></c> tag, except for	319	be used inside any child <c><body></c> tag, except for
252	<c><pre></c>. </p>	320	<c><pre></c>.
		321	</p>
253		322
		323	<p>
254	<p>The <c><path></c> element is used to mark text that refers to an	324	The <c><path></c> element is used to mark text that refers to an
255	<e>on-disk file</e> -- either an <e>absolute or relative path</e>, or a <e>simple filename</e>.	325	<e>on-disk file</e> -- either an <e>absolute or relative path</e>, or a
256	This element is generally rendered with a monospaced font to offset it from the	326	<e>simple filename</e>. This element is generally rendered with a monospaced
257	standard paragraph type. </p>	327	font to offset it from the standard paragraph type.
		328	</p>
258		329
		330	<p>
259	<p>The <c><c></c> element is used to mark up a <e>command</e> or <e>user	331	The <c><c></c> element is used to mark up a <e>command</e> or <e>user
260	input</e>. Think of <c><c></c> as a way to alert the reader to something	332	input</e>. Think of <c><c></c> as a way to alert the reader to something
261	that they can type in that will perform some kind of action. For example, all	333	that they can type in that will perform some kind of action. For example, all
262	the XML tags displayed in this document are enclosed in a <c><c></c>	334	the XML tags displayed in this document are enclosed in a <c><c></c>
263	element because they represent something that the user could type in that is	335	element because they represent something that the user could type in that is
264	not a path. By using <c><c></c> elements, you'll help your readers	336	not a path. By using <c><c></c> elements, you'll help your readers
265	quickly identify commands that they need to type in. Also, because	337	quickly identify commands that they need to type in. Also, because
266	<c><c></c> elements are already offset from regular text, <e>it is rarely	338	<c><c></c> elements are already offset from regular text, <e>it is rarely
267	necessary to surround user input with double-quotes</e>. For example, don't	339	necessary to surround user input with double-quotes</e>. For example, don't
268	refer to a "<c><c></c>" element like I did in this sentence. Avoiding	340	refer to a "<c><c></c>" element like I did in this sentence. Avoiding
269	the use of unnecessary double-quotes makes a document more readable -- and adorable!</p>	341	the use of unnecessary double-quotes makes a document more readable -- and
		342	adorable!
		343	</p>
270		344
		345	<p>
271	<p><c><e></c> is used to apply emphasis to a word or phrase; for example:	346	<c><e></c> is used to apply emphasis to a word or phrase; for example:
272	I <e>really</e> should use semicolons more often. As you can see, this text is	347	I <e>really</e> should use semicolons more often. As you can see, this text is
273	offset from the regular paragraph type for emphasis. This helps to give your	348	offset from the regular paragraph type for emphasis. This helps to give your
274	prose more <e>punch</e>!</p>	349	prose more <e>punch</e>!
		350	</p>
275		351
276	</body>	352	</body>
277	</section>	353	</section>
278
279	<section>	354	<section>
280	<title><mail> and <uri></title>	355	<title><mail> and <uri></title>
281	<body>	356	<body>
282		357
		358	<p>
283	<p>We've taken a look at the <c><mail></c> tag earlier; it's used to link some text	359	We've taken a look at the <c><mail></c> tag earlier; it's used to link
284	with a particular email address, and takes the form <c><mail link="foo@bar.com">Mr. Foo Bar</mail></c>.</p>	360	some text with a particular email address, and takes the form <c><mail
		361	link="foo@bar.com">Mr. Foo Bar</mail></c>.
		362	</p>
285		363
		364	<p>
286	<p>The <c><uri></c> tag is used to point to files/locations on the	365	The <c><uri></c> tag is used to point to files/locations on the Internet.
287	Internet. It has two forms -- the first can be used when you want to have the	366	It has two forms -- the first can be used when you want to have the actual URI
288	actual URI displayed in the body text, such as this link to	367	displayed in the body text, such as this link to
289	<uri>http://www.gentoo.org</uri>. To create this link, I typed	368	<uri>http://forums.gentoo.org</uri>. To create this link, I typed
290	<c><uri>http://www.gentoo.org</uri></c>. The alternate form is	369	<c><uri>http://forums.gentoo.org</uri></c>. The alternate form is
291	when you want to associate a URI with some other text -- for example, <uri	370	when you want to associate a URI with some other text -- for example, <uri
292	link="http://www.gentoo.org">the Gentoo Linux website</uri>. To create <e>this</e>	371	link="http://forums.gentoo.org">the Gentoo Forums</uri>. To create <e>this</e>
293	link, I typed <c><uri link="http://www.gentoo.org">the Gentoo Linux website</uri></c>.	372	link, I typed <c><uri link="http://forums.gentoo.org">the Gentoo
		373	Forums</uri></c>. You don't need to write <c>http://www.gentoo.org/</c>
		374	to link to other parts of the Gentoo website. For instance, a link to the <uri
		375	link="/doc/en/">documentation main index</uri> should be simply <c><uri
		376	link="/doc/en/index.xml">documentation main index</uri></c>. You can
		377	even omit <c>index.xml</c> when you link to a directory index, e.g. <c><uri
		378	link="/doc/en/">documentation main index</uri></c>.
294	</p>	379	</p>
295		380
296	</body>	381	</body>
297	</section>	382	</section>
298
299	<section>	383	<section>
300	<title>Figures</title>	384	<title>Figures</title>
301		385
302	<body>	386	<body>
303		387
		388	<p>
304	<p>Here's how to insert a figure into a document -- <c><figure	389	Here's how to insert a figure into a document -- <c><figure
305	link="mygfx.png" short="my picture" caption="my favorite picture of all	390	link="mygfx.png" short="my picture" caption="my favorite picture of all
306	time"/></c>. The <c>link=</c> attribute points to the actual graphic image,	391	time"/></c>. The <c>link=</c> attribute points to the actual graphic image,
307	the <c>short=</c> attribute specifies a short description (currently used for	392	the <c>short=</c> attribute specifies a short description (currently used for
308	the image's HTML <c>alt=</c> attribute), and a caption. Not too difficult	393	the image's HTML <c>alt=</c> attribute), and a caption. Not too difficult
309	:) We also support the standard HTML-style <img src="foo.gif"/> tag	394	:) We also support the standard HTML-style <img src="foo.gif"/> tag
310	for adding images without captions, borders, etc.</p>	395	for adding images without captions, borders, etc.
		396	</p>
311		397
312	</body>	398	</body>
313	</section>	399	</section>
314	<section>	400	<section>
315	<title>Tables and lists</title>	401	<title>Tables and lists</title>
316	<body>	402	<body>
317		403
		404	<p>
318	<p>Guide supports a simplified table syntax similar to that of HTML. To start	405	Guide supports a simplified table syntax similar to that of HTML. To start
319	a table, use a <c><table></c> tag. Start a row with a <c><tr></c>	406	a table, use a <c><table></c> tag. Start a row with a <c><tr></c>
320	tag. However, for inserting actual table data, we <e>don't</e> support the	407	tag. However, for inserting actual table data, we <e>don't</e> support the
321	HTML <td> tag; instead, use the <c><th></c> if you are inserting a	408	HTML <td> tag; instead, use the <c><th></c> if you are inserting a
322	header, and <c><ti></c> if you are inserting a normal informational	409	header, and <c><ti></c> if you are inserting a normal informational
323	block. You can use a <c><th></c> anywhere you can use a <c><ti></c> --	410	block. You can use a <c><th></c> anywhere you can use a <c><ti></c>
324	there's no requirement that <c><th></c> elements appear only in the	411	-- there's no requirement that <c><th></c> elements appear only in the
325	first row. Currently, these tags don't support any attributes, but some will	412	first row. Currently, these tags don't support any attributes, but some will
326	be added (such as a <c>caption=</c> attribute for <c><table></c>) soon.	413	be added (such as a <c>caption=</c> attribute for <c><table></c>) soon.
327	</p>	414	</p>
328		415
		416	<p>
329	<p> To create ordered or unordered lists, simply use the HTML-style	417	To create ordered or unordered lists, simply use the HTML-style
330	<c><ol></c>, <c><ul></c> and <c><li></c> tags. List tags	418	<c><ol></c>, <c><ul></c> and <c><li></c> tags. List tags
331	should only appear inside a <c><p></c>, <c><ti></c>,	419	should only appear inside a <c><body></c>, <c><ul></c> or
332	<c><note></c>, <c><warn></c> or <c><impo></c> tag. </p>	420	<c><ol></c> tag.
		421	</p>
333		422
334	</body>	423	</body>
335	</section>	424	</section>
336
337	<section>	425	<section>
338	<title>Intra-document references</title>	426	<title>Intra-document references</title>
339	<body>	427	<body>
340		428
		429	<p>
341	<p>Guide makes it really easy to reference other parts of the document using	430	Guide makes it really easy to reference other parts of the document using
342	hyperlinks. You can create a link pointing to <uri link="#doc_chap1">Chapter	431	hyperlinks. You can create a link pointing to <uri link="#doc_chap1">Chapter
343	One</uri> by typing <c><uri link="#doc_chap1">Chapter	432	One</uri> by typing <c><uri link="#doc_chap1">Chapter
344	One</uri></c>. To point to <uri link="#doc_chap1_sect2">section two of	433	One</uri></c>. To point to <uri link="#doc_chap1_sect2">section two of
345	Chapter One</uri>, type <c><uri link="#doc_chap1_sect2">section two of	434	Chapter One</uri>, type <c><uri link="#doc_chap1_sect2">section two of
346	Chapter One</uri></c>. To refer to figure 3 in chapter 1, type <c><uri	435	Chapter One</uri></c>. To refer to figure 3 in chapter 1, type <c><uri
347	link="doc_chap1_fig3">figure 1.3</uri></c>. Or, to refer to <uri link="#doc_chap2_pre2">code listing 2 in chapter 2</uri>,	436	link="doc_chap1_fig3">figure 1.3</uri></c>. Or, to refer to <uri
		437	link="#doc_chap2_pre2">code listing 2 in chapter 2</uri>, type <c><uri
348	type <c><uri link="doc_chap2_pre2">code listing 2.2</uri></c>. We'll be	438	link="doc_chap2_pre2">code listing 2.2</uri></c>. We'll be
349	adding other auto-link abilities (such as table support) soon.</p>	439	adding other auto-link abilities (such as table support) soon.
		440	</p>
		441
		442	<p>
		443	However, some guides change often and using such "counting" can lead to broken
		444	links. In order to cope with this, you can define a name for a
		445	<c><chapter></c> or <c><section></c> by using the <c>id</c>
		446	attribute, and then point to that attribute, like this:
		447	</p>
		448
		449	<pre caption="Using the id attribute">
		450	<chapter id="foo">
		451	<title>This is foo!</title>
		452	...
		453	<p>
		454	More information can be found in the <uri link="#foo">foo chapter</uri>
		455	</p>
		456	</pre>
350		457
351	</body>	458	</body>
352	</section>	459	</section>
353	</chapter>	460	</chapter>
		461
		462	<chapter>
		463	<title>Coding Style</title>
		464	<section>
		465	<title>Introduction</title>
		466	<body>
		467
		468	<p>
		469	Since all Gentoo Documentation is a joint effort and several people will
		470	most likely change existing documentation, a coding style is needed.
		471	A coding style contains two sections. The first one is regarding
		472	internal coding - how the xml-tags are placed. The second one is
		473	regarding the content - how not to confuse the reader.
		474	</p>
		475
		476	<p>
		477	Both sections are described next.
		478	</p>
		479
		480	</body>
		481	</section>
		482	<section>
		483	<title>Internal Coding Style</title>
		484	<body>
		485
		486	<p>
		487	<b>Newlines</b> must be placed immediately after <e>every</e>
		488	GuideXML-tag (both opening as closing), except for:
		489	<c><version></c>, <c><date></c>, <c><title></c>,
		490	<c><th></c>, <c><ti></c>,
		491	<c><li></c>, <c><i></c>, <c><e></c>,
		492	<c><uri></c>, <c><path></c>, <c><b></c>,
		493	<c><comment></c>, <c><codenote></c>, <c><mail></c>.
		494	</p>
		495
		496	<p>
		497	<b>Blank lines</b> must be placed immediately after <e>every</e>
		498	<c><body></c> (opening tag only) and before <e>every</e>
		499	<c><chapter></c>, <c><p></c>, <c><table></c>,
		500	<c><author></c> (set), <c><pre></c>, <c><ul></c>,
		501	<c><ol></c>, <c><warn></c>, <c><note></c> and
		502	<c><impo></c> (opening tags only).
		503	</p>
		504
		505	<p>
		506	<b>Word-wrapping</b> must be applied at 80 characters except inside
		507	<c><pre></c>. Only when there is no other choice can be deviated from
		508	this rule (for instance when a URL exceeds the maximum amount of characters).
		509	The editor must then wrap whenever the first whitespace occurs.
		510	</p>
		511
		512	<p>
		513	<b>Indentation</b> may not be used, except with the XML-constructs of which
		514	the parent XML-tags are <c><tr></c> (from <c><table></c>),
		515	<c><ul></c>, <c><ol></c> and <c><author></c>. If indentation
		516	is used, it <e>must</e> be two spaces for each indentation. That means <e>no</e>
		517	tabs and <e>not</e> more spaces.
		518	</p>
		519
		520	<p>
		521	In case word-wrapping happens in <c><ti></c>, <c><th></c> or
		522	<c><li></c> constructs, indentation must be used for the content.
		523	</p>
		524
		525	<p>
		526	An example for indentation is:
		527	</p>
		528
		529	<pre caption = "Indentation Example">
		530	<table>
		531	<tr>
		532	<th>Foo</th>
		533	<th>Bar</th>
		534	</tr>
		535	<tr>
		536	<ti>This is an example for indentation.</ti>
		537	<ti>
		538	In case text cannot be shown within an 80-character wide line, you
		539	must use indentation if the parent tag allows it.
		540	</ti>
		541	</tr>
		542	</table>
		543
		544	<ul>
		545	<li>First option</li>
		546	<li>Second option</li>
		547	</ul>
		548	</pre>
		549
		550	<p>
		551	<b>Attributes</b> may not have spaces in between the attribute, the
		552	"=" mark, and the attribute value. As an example:
		553	</p>
		554
		555	<pre caption="Attributes">
		556	<comment>Wrong :</comment> <pre caption = "Attributes">
		557	<comment>Correct:</comment> <pre caption="Attributes">
		558	</pre>
		559
		560	</body>
		561	</section>
		562	<section>
		563	<title>External Coding Style</title>
		564	<body>
		565
		566	<p>
		567	Inside tables (<c><table></c>) and listings (<c><ul></c> and
		568	<c><ol></c>), periods (".") should not be used unless multiple
		569	sentences are used. In that case, every sentence should end with a period (or
		570	other reading marks).
		571	</p>
		572
		573	<p>
		574	Every sentence, including those inside tables and listings, should start
		575	with a capital letter.
		576	</p>
		577
		578	<pre caption="Periods and capital letters">
		579	<ul>
		580	<li>No period</li>
		581	<li>With period. Multiple sentences, remember?</li>
		582	</ul>
		583	</pre>
		584
		585	<p>
		586	Code Listings should <e>always</e> have a <c>caption</c>.
		587	</p>
		588
		589	<p>
		590	Try to use <c><uri></c> with the <c>link</c> attribute as much as
		591	possible. In other words, the <uri link="http://forums.gentoo.org">Gentoo
		592	Forums</uri> is preferred over <uri>http://forums.gentoo.org</uri>.
		593	</p>
		594
		595	<p>
		596	When you comment something inside a <c><pre></c> construct, only use
		597	<c><codenote></c> if the content is a C or C++ code snippet. Otherwise,
		598	use <c><comment></c> and parentheses. Also place the comment <e>before</e>
		599	the subject of the comment.
		600	</p>
		601
		602	<pre caption="Comment example">
		603	<comment>(Substitute "john" with your user name)</comment>
		604	# <i>id john</i>
		605	</pre>
		606
		607	</body>
		608	</section>
		609	</chapter>
		610
		611	<chapter>
		612	<title>Handbook Format</title>
		613	<section>
		614	<title>Guide vs Book</title>
		615	<body>
		616
		617	<p>
		618	For high-volume documentation, such as the <uri
		619	link="/doc/en/handbook/handbook-x86.xml?part=1">Installation Instructions</uri>, a
		620	broader format was needed. We designed a GuideXML-compatible enhancement that
		621	allows us to write modular and multi-page documentation.
		622	</p>
		623
		624	</body>
		625	</section>
		626	<section>
		627	<title>Main File</title>
		628	<body>
		629
		630	<p>
		631	The first change is the need for a "master" document. This document contains no
		632	real content, but links to the individual documentation modules. The syntaxis
		633	doesn't differ much from GuideXML:
		634	</p>
		635
		636	<pre caption="Example book usage">
		637	<?xml version='1.0' encoding='UTF-8'?>
		638	<!DOCTYPE book SYSTEM "/dtd/book.dtd">
		639
		640	<<i>book</i> link="example.xml">
		641	<title>Example Book Usage</title>
		642
		643	<author...>
		644	...
		645	</author>
		646
		647	<abstract>
		648	...
		649	</abstract>
		650
		651	<!-- The content of this document is licensed under the CC-BY-SA license -->
		652	<!-- See http://creativecommons.org/licenses/by-sa/2.0 -->
		653	<license/>
		654
		655	<version>...</version>
		656	<date>...</date>
		657	</pre>
		658
		659	<p>
		660	So far no real differences (except for the <c><book></c> instead of
		661	<c><guide></c> tag). Instead of starting with the individual
		662	<c><chapter></c>'s, you define a <c><part></c>, which is the
		663	equivalent of a separate part in a book:
		664	</p>
		665
		666	<pre caption="Defining a part">
		667	<part>
		668	<title>Part One</title>
		669	<abstract>
		670	...
		671	</abstract>
		672
		673	<comment>(Defining the several chapters)</comment>
		674	</part>
		675	</pre>
		676
		677	<p>
		678	Each part is accompanied by a <c><title></c> and an
		679	<c><abstract></c> which gives a small introduction to the part.
		680	</p>
		681
		682	<p>
		683	Inside each part, you define the individual <c><chapter></c>'s. Each
		684	chapter <e>must</e> be a separate document. As a result it is no surprise that a
		685	special tag (<c><include></c>) is added to allow including the separate
		686	document.
		687	</p>
		688
		689	<pre caption="Defining a chapter">
		690	<chapter>
		691	<title>Chapter One</title>
		692	<abstract>
		693	This is a small explanation on chapter one.
		694	</abstract>
		695
		696	<include href="path/to/chapter-one.xml"/>
		697
		698	</chapter>
		699	</pre>
		700
		701	</body>
		702	</section>
		703	<section>
		704	<title>Designing the Individual Chapters</title>
		705	<body>
		706
		707	<p>
		708	The content of an individual chapter is structured as follows:
		709	</p>
		710
		711	<pre caption="Chapter Syntax">
		712	<?xml version='1.0' encoding='UTF-8'?>
		713	<!DOCTYPE sections SYSTEM "/dtd/book.dtd">
		714
		715	<!-- The content of this document is licensed under the CC-BY-SA license -->
		716	<!-- See http://creativecommons.org/licenses/by-sa/2.0 -->
		717
		718	<sections>
		719
		720	<version>...</version>
		721	<date>...</date>
		722
		723	<comment>(Define the several <section> and <subsection>)</comment>
		724
		725	</sections>
		726	</pre>
		727
		728	<p>
		729	Inside each chapter you can define <c><section></c>'s (equivalent of
		730	<c><chapter></c> in a Guide) and <c><subsection></c>'s (equivalent
		731	of <c><section></c> in a Guide).
		732	</p>
		733
		734	<p>
		735	Each individual chapter should have its own date and version elements. The
		736	latest date of all chapters and master document will be displayed when a user
		737	browses through all parts of the book.
		738	</p>
		739
		740	</body>
		741	</section>
		742	</chapter>
		743
354	<chapter>	744	<chapter>
355	<title>Resources</title>	745	<title>Resources</title>
356	<section>	746	<section>
357	<title>Start writing</title>	747	<title>Start writing</title>
358	<body>	748	<body>
		749
		750	<p>
359	<p>Guide has been specially designed to be "lean and mean" so that developers	751	Guide has been specially designed to be "lean and mean" so that developers can
360	can spend more time writing documentation and less time learning the actual XML	752	spend more time writing documentation and less time learning the actual XML
361	syntax. Hopefully, this will allow developers who aren't unusually "doc-savvy"	753	syntax. Hopefully, this will allow developers who aren't unusually "doc-savvy"
362	to start writing quality Gentoo Linux documentation. If you'd like to help (or have any questions about guide), please	754	to start writing quality Gentoo Linux documentation. You might be interested
363	post a message to <mail link="gentoo-dev@gentoo.org">the gentoo-dev mailing list</mail>	755	in our <uri link="/proj/en/gdp/doc/doc-tipsntricks.xml">Documentation
364	stating what you'd like to tackle.	756	Development Tips & Tricks</uri>. If you'd like to help (or have any
365	Have fun!</p>	757	questions about guide), please post a message to the <mail
		758	link="gentoo-doc@gentoo.org">gentoo-doc mailing list</mail> stating what you'd
		759	like to tackle. Have fun!
		760	</p>
		761
366	</body>	762	</body>
367	</section>	763	</section>
368	</chapter>	764	</chapter>
369	</guide>	765	</guide>
370

 Legend:



Removed from v.1.3
 


changed lines


 
Added in v.1.36
 Legend:



Removed from v.1.3
 


changed lines


 
Added in v.1.36
-Removed from v.1.3
+Added in v.1.36

	ViewVC Help
Powered by ViewVC 1.1.13