1 |
<?xml version="1.0" encoding="utf-8" ?> |
2 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
3 |
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
4 |
<!-- |
5 |
This HTML is auto-generated. DO NOT EDIT THIS FILE! If you are writing a new |
6 |
PEP, see http://www.python.org/peps/pep-0001.html for instructions and links |
7 |
to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE! |
8 |
--> |
9 |
<head> |
10 |
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
11 |
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" /> |
12 |
<title>GLEP 13 -- Providing the users with a Gentoo Handbook</title> |
13 |
<style type="text/css"> |
14 |
|
15 |
/* |
16 |
:Author: David Goodger |
17 |
:Contact: goodger@users.sourceforge.net |
18 |
:date: $Date: 2003/06/02 17:03:08 $ |
19 |
:version: $Revision: 1.1 $ |
20 |
:copyright: This stylesheet has been placed in the public domain. |
21 |
|
22 |
Default cascading style sheet for the PEP HTML output of Docutils. |
23 |
*/ |
24 |
|
25 |
.first { |
26 |
margin-top: 0 } |
27 |
|
28 |
.last { |
29 |
margin-bottom: 0 } |
30 |
|
31 |
.navigation { |
32 |
width: 100% ; |
33 |
background: #cc99ff ; |
34 |
margin-top: 0px ; |
35 |
margin-bottom: 0px } |
36 |
|
37 |
.navigation .navicon { |
38 |
width: 150px ; |
39 |
height: 35px } |
40 |
|
41 |
.navigation .textlinks { |
42 |
padding-left: 1em ; |
43 |
text-align: left } |
44 |
|
45 |
.navigation td, .navigation th { |
46 |
padding-left: 0em ; |
47 |
padding-right: 0em ; |
48 |
vertical-align: middle } |
49 |
|
50 |
.rfc2822 { |
51 |
margin-top: 0.5em ; |
52 |
margin-left: 0.5em ; |
53 |
margin-right: 0.5em ; |
54 |
margin-bottom: 0em } |
55 |
|
56 |
.rfc2822 td { |
57 |
text-align: left } |
58 |
|
59 |
.rfc2822 th.field-name { |
60 |
text-align: right ; |
61 |
font-family: sans-serif ; |
62 |
padding-right: 0.5em ; |
63 |
font-weight: bold ; |
64 |
margin-bottom: 0em } |
65 |
|
66 |
a.toc-backref { |
67 |
text-decoration: none ; |
68 |
color: black } |
69 |
|
70 |
body { |
71 |
margin: 0px ; |
72 |
margin-bottom: 1em ; |
73 |
padding: 0px } |
74 |
|
75 |
dd { |
76 |
margin-bottom: 0.5em } |
77 |
|
78 |
div.section { |
79 |
margin-left: 1em ; |
80 |
margin-right: 1em ; |
81 |
margin-bottom: 1.5em } |
82 |
|
83 |
div.section div.section { |
84 |
margin-left: 0em ; |
85 |
margin-right: 0em ; |
86 |
margin-top: 1.5em } |
87 |
|
88 |
div.abstract { |
89 |
margin: 2em 5em } |
90 |
|
91 |
div.abstract p.topic-title { |
92 |
font-weight: bold ; |
93 |
text-align: center } |
94 |
|
95 |
div.attention, div.caution, div.danger, div.error, div.hint, |
96 |
div.important, div.note, div.tip, div.warning { |
97 |
margin: 2em ; |
98 |
border: medium outset ; |
99 |
padding: 1em } |
100 |
|
101 |
div.attention p.admonition-title, div.caution p.admonition-title, |
102 |
div.danger p.admonition-title, div.error p.admonition-title, |
103 |
div.warning p.admonition-title { |
104 |
color: red ; |
105 |
font-weight: bold ; |
106 |
font-family: sans-serif } |
107 |
|
108 |
div.hint p.admonition-title, div.important p.admonition-title, |
109 |
div.note p.admonition-title, div.tip p.admonition-title { |
110 |
font-weight: bold ; |
111 |
font-family: sans-serif } |
112 |
|
113 |
div.figure { |
114 |
margin-left: 2em } |
115 |
|
116 |
div.footer, div.header { |
117 |
font-size: smaller } |
118 |
|
119 |
div.footer { |
120 |
margin-left: 1em ; |
121 |
margin-right: 1em } |
122 |
|
123 |
div.system-messages { |
124 |
margin: 5em } |
125 |
|
126 |
div.system-messages h1 { |
127 |
color: red } |
128 |
|
129 |
div.system-message { |
130 |
border: medium outset ; |
131 |
padding: 1em } |
132 |
|
133 |
div.system-message p.system-message-title { |
134 |
color: red ; |
135 |
font-weight: bold } |
136 |
|
137 |
div.topic { |
138 |
margin: 2em } |
139 |
|
140 |
h1 { |
141 |
font-family: sans-serif ; |
142 |
font-size: large } |
143 |
|
144 |
h2 { |
145 |
font-family: sans-serif ; |
146 |
font-size: medium } |
147 |
|
148 |
h3 { |
149 |
font-family: sans-serif ; |
150 |
font-size: small } |
151 |
|
152 |
h4 { |
153 |
font-family: sans-serif ; |
154 |
font-style: italic ; |
155 |
font-size: small } |
156 |
|
157 |
h5 { |
158 |
font-family: sans-serif; |
159 |
font-size: x-small } |
160 |
|
161 |
h6 { |
162 |
font-family: sans-serif; |
163 |
font-style: italic ; |
164 |
font-size: x-small } |
165 |
|
166 |
.section hr { |
167 |
width: 75% } |
168 |
|
169 |
ol.simple, ul.simple { |
170 |
margin-bottom: 1em } |
171 |
|
172 |
ol.arabic { |
173 |
list-style: decimal } |
174 |
|
175 |
ol.loweralpha { |
176 |
list-style: lower-alpha } |
177 |
|
178 |
ol.upperalpha { |
179 |
list-style: upper-alpha } |
180 |
|
181 |
ol.lowerroman { |
182 |
list-style: lower-roman } |
183 |
|
184 |
ol.upperroman { |
185 |
list-style: upper-roman } |
186 |
|
187 |
p.caption { |
188 |
font-style: italic } |
189 |
|
190 |
p.credits { |
191 |
font-style: italic ; |
192 |
font-size: smaller } |
193 |
|
194 |
p.label { |
195 |
white-space: nowrap } |
196 |
|
197 |
p.topic-title { |
198 |
font-family: sans-serif ; |
199 |
font-weight: bold } |
200 |
|
201 |
pre.line-block { |
202 |
font-family: serif ; |
203 |
font-size: 100% } |
204 |
|
205 |
pre.literal-block, pre.doctest-block { |
206 |
margin-left: 2em ; |
207 |
margin-right: 2em ; |
208 |
background-color: #eeeeee } |
209 |
|
210 |
span.classifier { |
211 |
font-family: sans-serif ; |
212 |
font-style: oblique } |
213 |
|
214 |
span.classifier-delimiter { |
215 |
font-family: sans-serif ; |
216 |
font-weight: bold } |
217 |
|
218 |
span.interpreted { |
219 |
font-family: sans-serif } |
220 |
|
221 |
span.option-argument { |
222 |
font-style: italic } |
223 |
|
224 |
span.pre { |
225 |
white-space: pre } |
226 |
|
227 |
span.problematic { |
228 |
color: red } |
229 |
|
230 |
table { |
231 |
margin-top: 0.5em ; |
232 |
margin-bottom: 0.5em } |
233 |
|
234 |
td, th { |
235 |
padding-left: 0.5em ; |
236 |
padding-right: 0.5em ; |
237 |
vertical-align: top } |
238 |
|
239 |
td.num { |
240 |
text-align: right } |
241 |
|
242 |
th.field-name { |
243 |
font-weight: bold ; |
244 |
text-align: left ; |
245 |
white-space: nowrap } |
246 |
|
247 |
h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { |
248 |
font-size: 100% } |
249 |
|
250 |
tt { |
251 |
background-color: #eeeeee } |
252 |
|
253 |
ul.auto-toc { |
254 |
list-style-type: none } |
255 |
|
256 |
</style> |
257 |
</head> |
258 |
<body bgcolor="white"> |
259 |
<table class="navigation" cellpadding="0" cellspacing="0" |
260 |
width="100%" border="0"> |
261 |
<tr><td class="navicon" width="150" height="35"> |
262 |
<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page"> |
263 |
<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" |
264 |
border="0" width="150" height="35" /></a></td> |
265 |
<td class="textlinks" align="left"> |
266 |
[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] |
267 |
[<b><a href="http://www.gentoo.org/peps">GLEP Index</a></b>] |
268 |
[<b><a href="http://www.gentoo.org/proj/en/glep/glep-0013.txt">GLEP Source</a></b>] |
269 |
</td></tr></table> |
270 |
<table class="rfc2822 docutils field-list" frame="void" rules="none"> |
271 |
<col class="field-name" /> |
272 |
<col class="field-body" /> |
273 |
<tbody valign="top"> |
274 |
<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">13</td> |
275 |
</tr> |
276 |
<tr class="field"><th class="field-name">Title:</th><td class="field-body">Providing the users with a Gentoo Handbook</td> |
277 |
</tr> |
278 |
<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.2</td> |
279 |
</tr> |
280 |
<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/glep/glep-0013.txt?cvsroot=gentoo">2004/10/26 00:21:28</a></td> |
281 |
</tr> |
282 |
<tr class="field"><th class="field-name">Author:</th><td class="field-body">Sven Vermeulen <swift at gentoo.org></td> |
283 |
</tr> |
284 |
<tr class="field"><th class="field-name">Status:</th><td class="field-body">Final</td> |
285 |
</tr> |
286 |
<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> |
287 |
</tr> |
288 |
<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0002.html">text/x-rst</a></td> |
289 |
</tr> |
290 |
<tr class="field"><th class="field-name">Created:</th><td class="field-body">15 Aug 2003</td> |
291 |
</tr> |
292 |
<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">19-Aug-2003 25-Oct-2004</td> |
293 |
</tr> |
294 |
</tbody> |
295 |
</table> |
296 |
<hr /> |
297 |
<div class="contents topic"> |
298 |
<p class="topic-title first"><a id="contents" name="contents">Contents</a></p> |
299 |
<ul class="simple"> |
300 |
<li><a class="reference" href="#abstract" id="id9" name="id9">Abstract</a></li> |
301 |
<li><a class="reference" href="#motivation" id="id10" name="id10">Motivation</a></li> |
302 |
<li><a class="reference" href="#rationale" id="id11" name="id11">Rationale</a></li> |
303 |
<li><a class="reference" href="#implementation" id="id12" name="id12">Implementation</a><ul> |
304 |
<li><a class="reference" href="#extending-guidexml" id="id13" name="id13">Extending GuideXML</a></li> |
305 |
<li><a class="reference" href="#installation-instructions" id="id14" name="id14">Installation Instructions</a></li> |
306 |
<li><a class="reference" href="#system-administration" id="id15" name="id15">System Administration</a></li> |
307 |
<li><a class="reference" href="#gentoo-development" id="id16" name="id16">Gentoo Development</a></li> |
308 |
<li><a class="reference" href="#user-applications" id="id17" name="id17">User Applications</a></li> |
309 |
</ul> |
310 |
</li> |
311 |
<li><a class="reference" href="#backwards-compatibility" id="id18" name="id18">Backwards Compatibility</a></li> |
312 |
<li><a class="reference" href="#reference-implementation" id="id19" name="id19">Reference Implementation</a></li> |
313 |
<li><a class="reference" href="#references" id="id20" name="id20">References</a></li> |
314 |
<li><a class="reference" href="#copyright" id="id21" name="id21">Copyright</a></li> |
315 |
</ul> |
316 |
</div> |
317 |
<div class="section"> |
318 |
<h1><a class="toc-backref" href="#id9" id="abstract" name="abstract">Abstract</a></h1> |
319 |
<p>This GLEP provides a vision on the evolution of the Gentoo Documentation, |
320 |
namely a handbook-like document that provides its readers documentation about |
321 |
every aspect of the Gentoo distribution: installation, administration, |
322 |
application usage, development etc.</p> |
323 |
</div> |
324 |
<div class="section"> |
325 |
<h1><a class="toc-backref" href="#id10" id="motivation" name="motivation">Motivation</a></h1> |
326 |
<p>Gentoo's current Installation Guide <a class="footnote-reference" href="#instguide" id="id1" name="id1">[1]</a> is rapidly growing, being |
327 |
extended with more and more features that the Gentoo users can help with their |
328 |
quest for the perfect installation. This increase is needed and a Good Thing, |
329 |
but it makes the guide less easy to read or use as reference.</p> |
330 |
<p>There is no reason whatsoever that this evolution will stagnate, on the |
331 |
contrary: people start asking why the Alternative Installation Guide |
332 |
<a class="footnote-reference" href="#altinst" id="id2" name="id2">[2]</a> isn't merged into the Gentoo Installation Guide, or why the |
333 |
platform-specific installation guides can't be merged as they all use the same |
334 |
steps (with a few differences). I myself even hope to merge our LVM Guide |
335 |
<a class="footnote-reference" href="#lvm" id="id3" name="id3">[3]</a> into the Installation Guide as I believe several of our users would |
336 |
love to use LVM on their machines, but currently don't because they don't know |
337 |
how handy and easy it is -- you all know this feeling :)</p> |
338 |
</div> |
339 |
<div class="section"> |
340 |
<h1><a class="toc-backref" href="#id11" id="rationale" name="rationale">Rationale</a></h1> |
341 |
<p>To address the beforementioned problem, there are two ideas:</p> |
342 |
<ul class="simple"> |
343 |
<li>Split the Installation Guide into several independent guides. For instance, |
344 |
we can move the information regarding the kernelconfiguration into the |
345 |
Kernel Guide, create a partitioning-howto that decribes the fdisk (and |
346 |
possibly others) steps users need to go through, etc.</li> |
347 |
<li>Merge all information into one Big Handbook. This is ofcourse an idea that |
348 |
we borrow from our FreeBSD friends <a class="footnote-reference" href="#fbsdhandbook" id="id4" name="id4">[4]</a> who already have an |
349 |
extensive handbook related to their BSD-distribution.</li> |
350 |
</ul> |
351 |
<p>It is this second idea that this GLEP describes.</p> |
352 |
<p>This handbook-idea doesn't decrease the installation instructions, on the |
353 |
contrary, it extends them. However, by choosing a multiple-page handbook-like |
354 |
document, our users receive a fully integrated document that embraces |
355 |
everything he or she wants to know. It will also make it more easy to provide |
356 |
printable documentation (in PDF or other form) without loosing the comfort of |
357 |
having the installation documents online and on the LiveCDs.</p> |
358 |
</div> |
359 |
<div class="section"> |
360 |
<h1><a class="toc-backref" href="#id12" id="implementation" name="implementation">Implementation</a></h1> |
361 |
<p>To implement such a handbook, the Gentoo Documentation Project <a class="footnote-reference" href="#gdp" id="id5" name="id5">[5]</a> needs a |
362 |
rewritten stylesheet for its GuideXML <a class="footnote-reference" href="#guidexml" id="id6" name="id6">[6]</a> format. Since there are no |
363 |
problems with GuideXML itself, and since it is very flexible in its use, the |
364 |
recommendation to stick with GuideXML is clear. We do need some extra features |
365 |
in GuideXML, without breaking the current GuideXML implementation.</p> |
366 |
<p>This last thing is important, since implementing this handbook-like document |
367 |
should be done parallel to the development of our current documentation: |
368 |
developing the Gentoo Handbook takes a long time and we don't want to force |
369 |
our users to use a non-usable document.</p> |
370 |
<p>After improving the GuideXML format, the first things that need to be |
371 |
addressed are the installation instructions. They should be merged with other, |
372 |
existing guides that inform the user with installation-specific items (such as |
373 |
the Aternative Installation Guide, LVM Guide, Platform-specific Installation |
374 |
Guides, etc.</p> |
375 |
<p>Other chapters that need to be put in place are:</p> |
376 |
<ul class="simple"> |
377 |
<li>A chapter on Gentoo Development, which embraces all current |
378 |
development-specific guides, such as the Gentoo Developer HOWTO, the Gentoo |
379 |
Policy, the Ebuild HOWTO, the Eclass HOWTO, etc. This has already been |
380 |
frequently asked by the Gentoo ebuild maintainers and several other Gentoo |
381 |
Developers.</li> |
382 |
<li>A chapter specific to System Administration, such as Mailserver |
383 |
Administration, User Administration, Printing Administration etc. We already |
384 |
have several guides that describe parts of these items.</li> |
385 |
<li>A chapter specific to Gentoo Usage, including our popular Desktop |
386 |
Configuration Guide <a class="footnote-reference" href="#desktop" id="id7" name="id7">[7]</a> and several Application-specific guides.</li> |
387 |
</ul> |
388 |
<p>The following sections describe these steps more in detail...</p> |
389 |
<div class="section"> |
390 |
<h2><a class="toc-backref" href="#id13" id="extending-guidexml" name="extending-guidexml">Extending GuideXML</a></h2> |
391 |
<p>The GuideXML format should be extended with the following items:</p> |
392 |
<ul class="simple"> |
393 |
<li>More depth regarding information-divisions.</li> |
394 |
<li>"Including" external sourcecode</li> |
395 |
<li>Easier in-document references</li> |
396 |
</ul> |
397 |
<p>Our current GuideXML format provides us the following depth regarding |
398 |
information-division:</p> |
399 |
<pre class="literal-block"> |
400 |
<guide> |
401 |
<chapter> |
402 |
<section> |
403 |
</pre> |
404 |
<p>The <tt class="docutils literal"><span class="pre"><guide></span></tt> tag is currently a one-time tag: it defines the start of the |
405 |
guide, and ofcourse the guide ends with <tt class="docutils literal"><span class="pre"></guide></span></tt>. |
406 |
The <tt class="docutils literal"><span class="pre"><chapter></span></tt> tag divides the document into seperate chapters. However, |
407 |
most of our documents have small chapters, whereas normal books and documents |
408 |
have chapters that encompasses several pages. |
409 |
The <tt class="docutils literal"><span class="pre"><section></span></tt> tag further divides the chapter in which it resides.</p> |
410 |
<p>This means that our current installation guides have a division-depth of 2: |
411 |
you can define a chapter, and in that chapter make subdivisions with |
412 |
<tt class="docutils literal"><span class="pre"><section></span></tt>. This is however insufficient for a handbook-like document. To |
413 |
improve the GuideXML, we can add <tt class="docutils literal"><span class="pre"><subsection></span></tt> and, if needed, |
414 |
<tt class="docutils literal"><span class="pre"><subsubsection></span></tt>, based on LaTeX's divisions.</p> |
415 |
<p>Another requisite is to be able to include external documents. Without this |
416 |
possibility, maintaining the handbook would be cumbersome to say the least. |
417 |
XSLT (which is used to process the GuideXML files) can easily provide this, so |
418 |
there are no specific needs to include this feature.</p> |
419 |
<p>A possible tag would be <tt class="docutils literal"><span class="pre"><include</span> <span class="pre">file="foobar.xml"</span> <span class="pre">/></span></tt>.</p> |
420 |
<p>With such a division, we could have each chapter inside its own document, |
421 |
making maintenance far more easy.</p> |
422 |
<p>The final implementation is in-document references. Currently, the Gentoo |
423 |
Documentation Developers have so guess in what chapter a certain section |
424 |
resides, and what section we are actually discussing: <tt class="docutils literal"><span class="pre">#doc_chap4_sect3</span></tt> |
425 |
provides us with a link to chapter 4, section 3. This is a workable |
426 |
implementation for small documents, but impossible for handbooks.</p> |
427 |
<p>Implementing a more HTML-alike reference inside the division-tags would be |
428 |
preferable: <tt class="docutils literal"><span class="pre"><chapter</span> <span class="pre">name="installation"></span></tt>, <tt class="docutils literal"><span class="pre"><section</span> |
429 |
<span class="pre">name="partitioning"></span></tt> etc. Refering would then be <tt class="docutils literal"><span class="pre">#installation</span></tt> and |
430 |
<tt class="docutils literal"><span class="pre">#partitioning</span></tt> respectively.</p> |
431 |
</div> |
432 |
<div class="section"> |
433 |
<h2><a class="toc-backref" href="#id14" id="installation-instructions" name="installation-instructions">Installation Instructions</a></h2> |
434 |
<p>The first real chapter (after some introduction) would be one about the Gentoo |
435 |
Installation. This chapter could then include all information regarding |
436 |
alternative installation instructions, architecture specific instructions, |
437 |
partitioning schemes, RAID installations and more without continuously |
438 |
referring to other sections throughout the handbook.</p> |
439 |
<p>In other words, a user that wants to install Gentoo Linux on his SPARC with |
440 |
ATA RAID should be able to do so following the instructions in the chapter |
441 |
<em>without</em> having to go forth and back between several pages. Creating such a |
442 |
chapter is not that easy just because we don't want our users to be sent from |
443 |
left to right and over again.</p> |
444 |
<p>Developing this chapter should be done in parallel with the development of the |
445 |
current guides (who still have a higher priority since these are still the |
446 |
official installation instructions as long as the chapter in the handbook |
447 |
isn't finished and reviewed for accuracy).</p> |
448 |
</div> |
449 |
<div class="section"> |
450 |
<h2><a class="toc-backref" href="#id15" id="system-administration" name="system-administration">System Administration</a></h2> |
451 |
<p>This chapter, which bases its content on an existing base installation of |
452 |
Gentoo, described in the previous chapter, contains sections for several |
453 |
important administration items. This is a chapter that currently doesn't have |
454 |
many affected guides, but is very important to make Gentoo work (and be |
455 |
documented) in server-environments.</p> |
456 |
<p>The sections contain information on, but not limited to:</p> |
457 |
<pre class="literal-block"> |
458 |
- Software Administration |
459 |
|
460 |
- User Administration |
461 |
|
462 |
- Mail Administration |
463 |
|
464 |
- Print Services |
465 |
|
466 |
- Network Administration |
467 |
|
468 |
- Storage Management |
469 |
|
470 |
- Security |
471 |
|
472 |
- Clustering |
473 |
</pre> |
474 |
</div> |
475 |
<div class="section"> |
476 |
<h2><a class="toc-backref" href="#id16" id="gentoo-development" name="gentoo-development">Gentoo Development</a></h2> |
477 |
<p>As previously explained, this chapter would contain all the information needed |
478 |
to help the Gentoo development. It would embrace all the current existing |
479 |
guides regarding Ebuild and Eclass development, Stage Creation, Gentoo Policy |
480 |
etc.</p> |
481 |
</div> |
482 |
<div class="section"> |
483 |
<h2><a class="toc-backref" href="#id17" id="user-applications" name="user-applications">User Applications</a></h2> |
484 |
<p>Whereas the System Administration chapter contains the information on how to |
485 |
install software and services (such as XFree), this chapter would contain |
486 |
information for the users (not the administrators) on how they can use |
487 |
software installed by the system administrator.</p> |
488 |
<p>Gentoo currently has several guides that describe such user applications |
489 |
<a class="footnote-reference" href="#gendoc" id="id8" name="id8">[8]</a> and it seems that these are guides that our users really |
490 |
appreciate, so neglecting them would be signing our own death wish :)</p> |
491 |
<p>Due to the nature of these documents, the User Applications chapter will exist |
492 |
of independent sections.</p> |
493 |
</div> |
494 |
</div> |
495 |
<div class="section"> |
496 |
<h1><a class="toc-backref" href="#id18" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1> |
497 |
<p>By making only small changes (actually extending) the GuideXML format, it is |
498 |
possible (and even adviseable) to develop each chapter on its own parallel |
499 |
with the guides that are involved.</p> |
500 |
<p>By developing the handbook in a subdirectory of the current documentation |
501 |
directory (for instance <tt class="docutils literal"><span class="pre">http://www.gentoo.org/doc/en/handbook</span></tt>) we maintain |
502 |
the current documentation. When a chapter on the handbook is finished, the |
503 |
involved documents can contain a big note on top, declaring that they are now |
504 |
obsoleted by the handbook's chapter.</p> |
505 |
<p>However, note that this handbook does <strong>not</strong> and will <strong>not</strong> embrace all |
506 |
documents that the Gentoo Documentation Project produces. It is very likely |
507 |
that there are guides that don't have a clear position inside this handbook. |
508 |
Instead of forcing the guide somewhere, we should leave the guide as a |
509 |
stand-alone document.</p> |
510 |
</div> |
511 |
<div class="section"> |
512 |
<h1><a class="toc-backref" href="#id19" id="reference-implementation" name="reference-implementation">Reference Implementation</a></h1> |
513 |
<p>This is a possible roadmap for the Gentoo Handbook:</p> |
514 |
<pre class="literal-block"> |
515 |
- Improve the GuideXML format, possibly creating a handbook.xsl stylesheet |
516 |
(and leave the guide.xsl as it is now). |
517 |
|
518 |
- Implement the Installation Instructions |
519 |
|
520 |
- Develop a consistent layout, keeping the guides that are to be implemented |
521 |
in mind. |
522 |
|
523 |
- Include all referenced guides. Do *not* extend it yet. |
524 |
|
525 |
- Review the installation instructions and make them official |
526 |
|
527 |
- Extend at will :) |
528 |
|
529 |
- Implement the Gentoo Development Instructions |
530 |
|
531 |
- Implement the User Application Instructions |
532 |
|
533 |
- Implement the System Administration Instructions |
534 |
</pre> |
535 |
</div> |
536 |
<div class="section"> |
537 |
<h1><a class="toc-backref" href="#id20" id="references" name="references">References</a></h1> |
538 |
<table class="docutils footnote" frame="void" id="instguide" rules="none"> |
539 |
<colgroup><col class="label" /><col /></colgroup> |
540 |
<tbody valign="top"> |
541 |
<tr><td class="label"><a class="fn-backref" href="#id1" name="instguide">[1]</a></td><td><a class="reference" href="http://www.gentoo.org/doc/en/gentoo-x86-install.xml">http://www.gentoo.org/doc/en/gentoo-x86-install.xml</a></td></tr> |
542 |
</tbody> |
543 |
</table> |
544 |
<table class="docutils footnote" frame="void" id="altinst" rules="none"> |
545 |
<colgroup><col class="label" /><col /></colgroup> |
546 |
<tbody valign="top"> |
547 |
<tr><td class="label"><a class="fn-backref" href="#id2" name="altinst">[2]</a></td><td><a class="reference" href="http://www.gentoo.org/doc/en/altinstall.xml">http://www.gentoo.org/doc/en/altinstall.xml</a></td></tr> |
548 |
</tbody> |
549 |
</table> |
550 |
<table class="docutils footnote" frame="void" id="lvm" rules="none"> |
551 |
<colgroup><col class="label" /><col /></colgroup> |
552 |
<tbody valign="top"> |
553 |
<tr><td class="label"><a class="fn-backref" href="#id3" name="lvm">[3]</a></td><td><a class="reference" href="http://www.gentoo.org/doc/en/lvm.xml">http://www.gentoo.org/doc/en/lvm.xml</a></td></tr> |
554 |
</tbody> |
555 |
</table> |
556 |
<table class="docutils footnote" frame="void" id="fbsdhandbook" rules="none"> |
557 |
<colgroup><col class="label" /><col /></colgroup> |
558 |
<tbody valign="top"> |
559 |
<tr><td class="label"><a class="fn-backref" href="#id4" name="fbsdhandbook">[4]</a></td><td><a class="reference" href="http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/index.html">http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/index.html</a></td></tr> |
560 |
</tbody> |
561 |
</table> |
562 |
<table class="docutils footnote" frame="void" id="gdp" rules="none"> |
563 |
<colgroup><col class="label" /><col /></colgroup> |
564 |
<tbody valign="top"> |
565 |
<tr><td class="label"><a class="fn-backref" href="#id5" name="gdp">[5]</a></td><td><a class="reference" href="http://www.gentoo.org/proj/en/gdp">http://www.gentoo.org/proj/en/gdp</a></td></tr> |
566 |
</tbody> |
567 |
</table> |
568 |
<table class="docutils footnote" frame="void" id="guidexml" rules="none"> |
569 |
<colgroup><col class="label" /><col /></colgroup> |
570 |
<tbody valign="top"> |
571 |
<tr><td class="label"><a class="fn-backref" href="#id6" name="guidexml">[6]</a></td><td><a class="reference" href="http://www.gentoo.org/doc/en/xml-guide.xml">http://www.gentoo.org/doc/en/xml-guide.xml</a></td></tr> |
572 |
</tbody> |
573 |
</table> |
574 |
<table class="docutils footnote" frame="void" id="desktop" rules="none"> |
575 |
<colgroup><col class="label" /><col /></colgroup> |
576 |
<tbody valign="top"> |
577 |
<tr><td class="label"><a class="fn-backref" href="#id7" name="desktop">[7]</a></td><td><a class="reference" href="http://www.gentoo.org/doc/en/desktop.xml">http://www.gentoo.org/doc/en/desktop.xml</a></td></tr> |
578 |
</tbody> |
579 |
</table> |
580 |
<table class="docutils footnote" frame="void" id="gendoc" rules="none"> |
581 |
<colgroup><col class="label" /><col /></colgroup> |
582 |
<tbody valign="top"> |
583 |
<tr><td class="label"><a class="fn-backref" href="#id8" name="gendoc">[8]</a></td><td><a class="reference" href="http://www.gentoo.org/main/en/docs.xml#doc_chap1_sect5">http://www.gentoo.org/main/en/docs.xml#doc_chap1_sect5</a></td></tr> |
584 |
</tbody> |
585 |
</table> |
586 |
</div> |
587 |
<div class="section"> |
588 |
<h1><a class="toc-backref" href="#id21" id="copyright" name="copyright">Copyright</a></h1> |
589 |
<p>This document has been placed in the public domain.</p> |
590 |
</div> |
591 |
|
592 |
</div> |
593 |
<div class="footer"> |
594 |
<hr class="footer" /> |
595 |
<a class="reference" href="glep-0013.txt">View document source</a>. |
596 |
Generated on: 2006-10-10 20:23 UTC. |
597 |
Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source. |
598 |
|
599 |
</div> |
600 |
</body> |
601 |
</html> |
602 |
|