/[gentoo]/xml/htdocs/proj/en/glep/glep-0013.html
Gentoo

Diff of /xml/htdocs/proj/en/glep/glep-0013.html

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

Revision 1.2 Revision 1.5
1<?xml version="1.0" encoding="utf-8" ?> 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"> 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"> 3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<!-- 4
5This HTML is auto-generated. DO NOT EDIT THIS FILE! If you are writing a new
6PEP, see http://www.python.org/peps/pep-0001.html for instructions and links
7to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE!
8-->
9<head> 5<head>
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 6 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 <meta name="generator" content="Docutils 0.3.3: http://docutils.sourceforge.net/" /> 7 <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
12 <title>GLEP 13 -- Providing the users with a Gentoo Handbook</title> 8 <title>GLEP 13 -- Providing the users with a Gentoo Handbook</title>
13 <link rel="stylesheet" href="tools/glep.css" type="text/css" /> 9 <link rel="stylesheet" href="tools/glep.css" type="text/css" />
14</head> 10</head>
15<body bgcolor="white"> 11<body bgcolor="white">
16<table class="navigation" cellpadding="0" cellspacing="0" 12<table class="navigation" cellpadding="0" cellspacing="0"
20<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" 16<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
21 border="0" width="150" height="35" /></a></td> 17 border="0" width="150" height="35" /></a></td>
22<td class="textlinks" align="left"> 18<td class="textlinks" align="left">
23[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] 19[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>]
24[<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>] 20[<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>]
25[<b><a href="./glep-0013.txt">GLEP Source</a></b>] 21[<b><a href="http://www.gentoo.org/proj/en/glep/glep-0013.txt">GLEP Source</a></b>]
26</td></tr></table> 22</td></tr></table>
27<div class="document">
28<table class="rfc2822 field-list" frame="void" rules="none"> 23<table class="rfc2822 docutils field-list" frame="void" rules="none">
29<col class="field-name" /> 24<col class="field-name" />
30<col class="field-body" /> 25<col class="field-body" />
31<tbody valign="top"> 26<tbody valign="top">
32<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">13</td> 27<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">13</td>
33</tr> 28</tr>
34<tr class="field"><th class="field-name">Title:</th><td class="field-body">Providing the users with a Gentoo Handbook</td> 29<tr class="field"><th class="field-name">Title:</th><td class="field-body">Providing the users with a Gentoo Handbook</td>
35</tr> 30</tr>
36<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.1</td> 31<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.2</td>
37</tr> 32</tr>
38<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/xml/htdocs/proj/en/glep/glep-0013.txt?cvsroot=gentoo">2003/08/20 02:28:47</a></td> 33<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>
39</tr> 34</tr>
40<tr class="field"><th class="field-name">Author:</th><td class="field-body">Sven Vermeulen &lt;swift&#32;&#97;t&#32;gentoo.org&gt;</td> 35<tr class="field"><th class="field-name">Author:</th><td class="field-body">Sven Vermeulen &lt;swift&#32;&#97;t&#32;gentoo.org&gt;</td>
41</tr> 36</tr>
42<tr class="field"><th class="field-name">Status:</th><td class="field-body">Final</td> 37<tr class="field"><th class="field-name">Status:</th><td class="field-body">Final</td>
43</tr> 38</tr>
44<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> 39<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
45</tr> 40</tr>
46<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0012.html">text/x-rst</a></td> 41<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>
47</tr> 42</tr>
48<tr class="field"><th class="field-name">Created:</th><td class="field-body">15 Aug 2003</td> 43<tr class="field"><th class="field-name">Created:</th><td class="field-body">15 Aug 2003</td>
49</tr> 44</tr>
50<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">19-Aug-2003 25-Oct-2004</td> 45<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">19-Aug-2003 25-Oct-2004</td>
51</tr> 46</tr>
52</tbody> 47</tbody>
53</table> 48</table>
54<hr /> 49<hr />
55<div class="contents topic" id="contents"> 50<div class="contents topic">
56<p class="topic-title first"><a name="contents">Contents</a></p> 51<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
57<ul class="simple"> 52<ul class="simple">
58<li><a class="reference" href="#abstract" id="id9" name="id9">Abstract</a></li> 53<li><a class="reference" href="#abstract" id="id9" name="id9">Abstract</a></li>
59<li><a class="reference" href="#motivation" id="id10" name="id10">Motivation</a></li> 54<li><a class="reference" href="#motivation" id="id10" name="id10">Motivation</a></li>
60<li><a class="reference" href="#rationale" id="id11" name="id11">Rationale</a></li> 55<li><a class="reference" href="#rationale" id="id11" name="id11">Rationale</a></li>
61<li><a class="reference" href="#implementation" id="id12" name="id12">Implementation</a><ul> 56<li><a class="reference" href="#implementation" id="id12" name="id12">Implementation</a><ul>
70<li><a class="reference" href="#reference-implementation" id="id19" name="id19">Reference Implementation</a></li> 65<li><a class="reference" href="#reference-implementation" id="id19" name="id19">Reference Implementation</a></li>
71<li><a class="reference" href="#references" id="id20" name="id20">References</a></li> 66<li><a class="reference" href="#references" id="id20" name="id20">References</a></li>
72<li><a class="reference" href="#copyright" id="id21" name="id21">Copyright</a></li> 67<li><a class="reference" href="#copyright" id="id21" name="id21">Copyright</a></li>
73</ul> 68</ul>
74</div> 69</div>
75<div class="section" id="abstract"> 70<div class="section">
76<h1><a class="toc-backref" href="#id9" name="abstract">Abstract</a></h1> 71<h1><a class="toc-backref" href="#id9" id="abstract" name="abstract">Abstract</a></h1>
77<p>This GLEP provides a vision on the evolution of the Gentoo Documentation, 72<p>This GLEP provides a vision on the evolution of the Gentoo Documentation,
78namely a handbook-like document that provides its readers documentation about 73namely a handbook-like document that provides its readers documentation about
79every aspect of the Gentoo distribution: installation, administration, 74every aspect of the Gentoo distribution: installation, administration,
80application usage, development etc.</p> 75application usage, development etc.</p>
81</div> 76</div>
82<div class="section" id="motivation"> 77<div class="section">
83<h1><a class="toc-backref" href="#id10" name="motivation">Motivation</a></h1> 78<h1><a class="toc-backref" href="#id10" id="motivation" name="motivation">Motivation</a></h1>
84<p>Gentoo's current Installation Guide <a class="footnote-reference" href="#instguide" id="id1" name="id1">[1]</a> is rapidly growing, being 79<p>Gentoo's current Installation Guide <a class="footnote-reference" href="#instguide" id="id1" name="id1">[1]</a> is rapidly growing, being
85extended with more and more features that the Gentoo users can help with their 80extended with more and more features that the Gentoo users can help with their
86quest for the perfect installation. This increase is needed and a Good Thing, 81quest for the perfect installation. This increase is needed and a Good Thing,
87but it makes the guide less easy to read or use as reference.</p> 82but it makes the guide less easy to read or use as reference.</p>
88<p>There is no reason whatsoever that this evolution will stagnate, on the 83<p>There is no reason whatsoever that this evolution will stagnate, on the
92steps (with a few differences). I myself even hope to merge our LVM Guide 87steps (with a few differences). I myself even hope to merge our LVM Guide
93<a class="footnote-reference" href="#lvm" id="id3" name="id3">[3]</a> into the Installation Guide as I believe several of our users would 88<a class="footnote-reference" href="#lvm" id="id3" name="id3">[3]</a> into the Installation Guide as I believe several of our users would
94love to use LVM on their machines, but currently don't because they don't know 89love to use LVM on their machines, but currently don't because they don't know
95how handy and easy it is -- you all know this feeling :)</p> 90how handy and easy it is -- you all know this feeling :)</p>
96</div> 91</div>
97<div class="section" id="rationale"> 92<div class="section">
98<h1><a class="toc-backref" href="#id11" name="rationale">Rationale</a></h1> 93<h1><a class="toc-backref" href="#id11" id="rationale" name="rationale">Rationale</a></h1>
99<p>To address the beforementioned problem, there are two ideas:</p> 94<p>To address the beforementioned problem, there are two ideas:</p>
100<ul class="simple"> 95<ul class="simple">
101<li>Split the Installation Guide into several independent guides. For instance, 96<li>Split the Installation Guide into several independent guides. For instance,
102we can move the information regarding the kernelconfiguration into the 97we can move the information regarding the kernelconfiguration into the
103Kernel Guide, create a partitioning-howto that decribes the fdisk (and 98Kernel Guide, create a partitioning-howto that decribes the fdisk (and
112document, our users receive a fully integrated document that embraces 107document, our users receive a fully integrated document that embraces
113everything he or she wants to know. It will also make it more easy to provide 108everything he or she wants to know. It will also make it more easy to provide
114printable documentation (in PDF or other form) without loosing the comfort of 109printable documentation (in PDF or other form) without loosing the comfort of
115having the installation documents online and on the LiveCDs.</p> 110having the installation documents online and on the LiveCDs.</p>
116</div> 111</div>
117<div class="section" id="implementation"> 112<div class="section">
118<h1><a class="toc-backref" href="#id12" name="implementation">Implementation</a></h1> 113<h1><a class="toc-backref" href="#id12" id="implementation" name="implementation">Implementation</a></h1>
119<p>To implement such a handbook, the Gentoo Documentation Project <a class="footnote-reference" href="#gdp" id="id5" name="id5">[5]</a> needs a 114<p>To implement such a handbook, the Gentoo Documentation Project <a class="footnote-reference" href="#gdp" id="id5" name="id5">[5]</a> needs a
120rewritten stylesheet for its GuideXML <a class="footnote-reference" href="#guidexml" id="id6" name="id6">[6]</a> format. Since there are no 115rewritten stylesheet for its GuideXML <a class="footnote-reference" href="#guidexml" id="id6" name="id6">[6]</a> format. Since there are no
121problems with GuideXML itself, and since it is very flexible in its use, the 116problems with GuideXML itself, and since it is very flexible in its use, the
122recommendation to stick with GuideXML is clear. We do need some extra features 117recommendation to stick with GuideXML is clear. We do need some extra features
123in GuideXML, without breaking the current GuideXML implementation.</p> 118in GuideXML, without breaking the current GuideXML implementation.</p>
124<p>This last thing is important, since implementing this handbook-like document 119<p>This last thing is important, since implementing this handbook-like document
125should be done parallel to the development of our current documentation: 120should be done parallel to the development of our current documentation:
126developing the Gentoo Handbook takes a long time and we don't want to force 121developing the Gentoo Handbook takes a long time and we don't want to force
127our users to use a non-usable document.</p> 122our users to use a non-usable document.</p>
128<p>After improving the GuideXML format, the first things that need to be 123<p>After improving the GuideXML format, the first things that need to be
129addressed are the installation instructions. They should be merged with other, 124addressed are the installation instructions. They should be merged with other,
130existing guides that inform the user with installation-specific items (such as 125existing guides that inform the user with installation-specific items (such as
131the Aternative Installation Guide, LVM Guide, Platform-specific Installation 126the Aternative Installation Guide, LVM Guide, Platform-specific Installation
132Guides, etc.</p> 127Guides, etc.</p>
133<p>Other chapters that need to be put in place are:</p> 128<p>Other chapters that need to be put in place are:</p>
134<ul class="simple"> 129<ul class="simple">
135<li>A chapter on Gentoo Development, which embraces all current 130<li>A chapter on Gentoo Development, which embraces all current
136development-specific guides, such as the Gentoo Developer HOWTO, the Gentoo 131development-specific guides, such as the Gentoo Developer HOWTO, the Gentoo
137Policy, the Ebuild HOWTO, the Eclass HOWTO, etc. This has already been 132Policy, the Ebuild HOWTO, the Eclass HOWTO, etc. This has already been
138frequently asked by the Gentoo ebuild maintainers and several other Gentoo 133frequently asked by the Gentoo ebuild maintainers and several other Gentoo
139Developers.</li> 134Developers.</li>
140<li>A chapter specific to System Administration, such as Mailserver 135<li>A chapter specific to System Administration, such as Mailserver
141Administration, User Administration, Printing Administration etc. We already 136Administration, User Administration, Printing Administration etc. We already
142have several guides that describe parts of these items.</li> 137have several guides that describe parts of these items.</li>
143<li>A chapter specific to Gentoo Usage, including our popular Desktop 138<li>A chapter specific to Gentoo Usage, including our popular Desktop
144Configuration Guide <a class="footnote-reference" href="#desktop" id="id7" name="id7">[7]</a> and several Application-specific guides.</li> 139Configuration Guide <a class="footnote-reference" href="#desktop" id="id7" name="id7">[7]</a> and several Application-specific guides.</li>
145</ul> 140</ul>
146<p>The following sections describe these steps more in detail...</p> 141<p>The following sections describe these steps more in detail...</p>
147<div class="section" id="extending-guidexml"> 142<div class="section">
148<h2><a class="toc-backref" href="#id13" name="extending-guidexml">Extending GuideXML</a></h2> 143<h2><a class="toc-backref" href="#id13" id="extending-guidexml" name="extending-guidexml">Extending GuideXML</a></h2>
149<p>The GuideXML format should be extended with the following items:</p> 144<p>The GuideXML format should be extended with the following items:</p>
150<ul class="simple"> 145<ul class="simple">
151<li>More depth regarding information-divisions.</li> 146<li>More depth regarding information-divisions.</li>
152<li>&quot;Including&quot; external sourcecode</li> 147<li>&quot;Including&quot; external sourcecode</li>
153<li>Easier in-document references</li> 148<li>Easier in-document references</li>
157<pre class="literal-block"> 152<pre class="literal-block">
158&lt;guide&gt; 153&lt;guide&gt;
159 &lt;chapter&gt; 154 &lt;chapter&gt;
160 &lt;section&gt; 155 &lt;section&gt;
161</pre> 156</pre>
162<p>The <tt class="literal"><span class="pre">&lt;guide&gt;</span></tt> tag is currently a one-time tag: it defines the start of the 157<p>The <tt class="docutils literal"><span class="pre">&lt;guide&gt;</span></tt> tag is currently a one-time tag: it defines the start of the
163guide, and ofcourse the guide ends with <tt class="literal"><span class="pre">&lt;/guide&gt;</span></tt>. 158guide, and ofcourse the guide ends with <tt class="docutils literal"><span class="pre">&lt;/guide&gt;</span></tt>.
164The <tt class="literal"><span class="pre">&lt;chapter&gt;</span></tt> tag divides the document into seperate chapters. However, 159The <tt class="docutils literal"><span class="pre">&lt;chapter&gt;</span></tt> tag divides the document into seperate chapters. However,
165most of our documents have small chapters, whereas normal books and documents 160most of our documents have small chapters, whereas normal books and documents
166have chapters that encompasses several pages. 161have chapters that encompasses several pages.
167The <tt class="literal"><span class="pre">&lt;section&gt;</span></tt> tag further divides the chapter in which it resides.</p> 162The <tt class="docutils literal"><span class="pre">&lt;section&gt;</span></tt> tag further divides the chapter in which it resides.</p>
168<p>This means that our current installation guides have a division-depth of 2: 163<p>This means that our current installation guides have a division-depth of 2:
169you can define a chapter, and in that chapter make subdivisions with 164you can define a chapter, and in that chapter make subdivisions with
170<tt class="literal"><span class="pre">&lt;section&gt;</span></tt>. This is however insufficient for a handbook-like document. To 165<tt class="docutils literal"><span class="pre">&lt;section&gt;</span></tt>. This is however insufficient for a handbook-like document. To
171improve the GuideXML, we can add <tt class="literal"><span class="pre">&lt;subsection&gt;</span></tt> and, if needed, 166improve the GuideXML, we can add <tt class="docutils literal"><span class="pre">&lt;subsection&gt;</span></tt> and, if needed,
172<tt class="literal"><span class="pre">&lt;subsubsection&gt;</span></tt>, based on LaTeX's divisions.</p> 167<tt class="docutils literal"><span class="pre">&lt;subsubsection&gt;</span></tt>, based on LaTeX's divisions.</p>
173<p>Another requisite is to be able to include external documents. Without this 168<p>Another requisite is to be able to include external documents. Without this
174possibility, maintaining the handbook would be cumbersome to say the least. 169possibility, maintaining the handbook would be cumbersome to say the least.
175XSLT (which is used to process the GuideXML files) can easily provide this, so 170XSLT (which is used to process the GuideXML files) can easily provide this, so
176there are no specific needs to include this feature.</p> 171there are no specific needs to include this feature.</p>
177<p>A possible tag would be <tt class="literal"><span class="pre">&lt;include</span> <span class="pre">file=&quot;foobar.xml&quot;</span> <span class="pre">/&gt;</span></tt>.</p> 172<p>A possible tag would be <tt class="docutils literal"><span class="pre">&lt;include</span> <span class="pre">file=&quot;foobar.xml&quot;</span> <span class="pre">/&gt;</span></tt>.</p>
178<p>With such a division, we could have each chapter inside its own document, 173<p>With such a division, we could have each chapter inside its own document,
179making maintenance far more easy.</p> 174making maintenance far more easy.</p>
180<p>The final implementation is in-document references. Currently, the Gentoo 175<p>The final implementation is in-document references. Currently, the Gentoo
181Documentation Developers have so guess in what chapter a certain section 176Documentation Developers have so guess in what chapter a certain section
182resides, and what section we are actually discussing: <tt class="literal"><span class="pre">#doc_chap4_sect3</span></tt> 177resides, and what section we are actually discussing: <tt class="docutils literal"><span class="pre">#doc_chap4_sect3</span></tt>
183provides us with a link to chapter 4, section 3. This is a workable 178provides us with a link to chapter 4, section 3. This is a workable
184implementation for small documents, but impossible for handbooks.</p> 179implementation for small documents, but impossible for handbooks.</p>
185<p>Implementing a more HTML-alike reference inside the division-tags would be 180<p>Implementing a more HTML-alike reference inside the division-tags would be
186preferable: <tt class="literal"><span class="pre">&lt;chapter</span> <span class="pre">name=&quot;installation&quot;&gt;</span></tt>, <tt class="literal"><span class="pre">&lt;section</span> 181preferable: <tt class="docutils literal"><span class="pre">&lt;chapter</span> <span class="pre">name=&quot;installation&quot;&gt;</span></tt>, <tt class="docutils literal"><span class="pre">&lt;section</span>
187<span class="pre">name=&quot;partitioning&quot;&gt;</span></tt> etc. Refering would then be <tt class="literal"><span class="pre">#installation</span></tt> and 182<span class="pre">name=&quot;partitioning&quot;&gt;</span></tt> etc. Refering would then be <tt class="docutils literal"><span class="pre">#installation</span></tt> and
188<tt class="literal"><span class="pre">#partitioning</span></tt> respectively.</p> 183<tt class="docutils literal"><span class="pre">#partitioning</span></tt> respectively.</p>
189</div> 184</div>
190<div class="section" id="installation-instructions"> 185<div class="section">
191<h2><a class="toc-backref" href="#id14" name="installation-instructions">Installation Instructions</a></h2> 186<h2><a class="toc-backref" href="#id14" id="installation-instructions" name="installation-instructions">Installation Instructions</a></h2>
192<p>The first real chapter (after some introduction) would be one about the Gentoo 187<p>The first real chapter (after some introduction) would be one about the Gentoo
193Installation. This chapter could then include all information regarding 188Installation. This chapter could then include all information regarding
194alternative installation instructions, architecture specific instructions, 189alternative installation instructions, architecture specific instructions,
195partitioning schemes, RAID installations and more without continuously 190partitioning schemes, RAID installations and more without continuously
196referring to other sections throughout the handbook.</p> 191referring to other sections throughout the handbook.</p>
197<p>In other words, a user that wants to install Gentoo Linux on his SPARC with 192<p>In other words, a user that wants to install Gentoo Linux on his SPARC with
198ATA RAID should be able to do so following the instructions in the chapter 193ATA RAID should be able to do so following the instructions in the chapter
199<em>without</em> having to go forth and back between several pages. Creating such a 194<em>without</em> having to go forth and back between several pages. Creating such a
200chapter is not that easy just because we don't want our users to be sent from 195chapter is not that easy just because we don't want our users to be sent from
201left to right and over again.</p> 196left to right and over again.</p>
202<p>Developing this chapter should be done in parallel with the development of the 197<p>Developing this chapter should be done in parallel with the development of the
203current guides (who still have a higher priority since these are still the 198current guides (who still have a higher priority since these are still the
204official installation instructions as long as the chapter in the handbook 199official installation instructions as long as the chapter in the handbook
205isn't finished and reviewed for accuracy).</p> 200isn't finished and reviewed for accuracy).</p>
206</div> 201</div>
207<div class="section" id="system-administration"> 202<div class="section">
208<h2><a class="toc-backref" href="#id15" name="system-administration">System Administration</a></h2> 203<h2><a class="toc-backref" href="#id15" id="system-administration" name="system-administration">System Administration</a></h2>
209<p>This chapter, which bases its content on an existing base installation of 204<p>This chapter, which bases its content on an existing base installation of
210Gentoo, described in the previous chapter, contains sections for several 205Gentoo, described in the previous chapter, contains sections for several
211important administration items. This is a chapter that currently doesn't have 206important administration items. This is a chapter that currently doesn't have
212many affected guides, but is very important to make Gentoo work (and be 207many affected guides, but is very important to make Gentoo work (and be
213documented) in server-environments.</p> 208documented) in server-environments.</p>
228- Security 223- Security
229 224
230- Clustering 225- Clustering
231</pre> 226</pre>
232</div> 227</div>
233<div class="section" id="gentoo-development"> 228<div class="section">
234<h2><a class="toc-backref" href="#id16" name="gentoo-development">Gentoo Development</a></h2> 229<h2><a class="toc-backref" href="#id16" id="gentoo-development" name="gentoo-development">Gentoo Development</a></h2>
235<p>As previously explained, this chapter would contain all the information needed 230<p>As previously explained, this chapter would contain all the information needed
236to help the Gentoo development. It would embrace all the current existing 231to help the Gentoo development. It would embrace all the current existing
237guides regarding Ebuild and Eclass development, Stage Creation, Gentoo Policy 232guides regarding Ebuild and Eclass development, Stage Creation, Gentoo Policy
238etc.</p> 233etc.</p>
239</div> 234</div>
240<div class="section" id="user-applications"> 235<div class="section">
241<h2><a class="toc-backref" href="#id17" name="user-applications">User Applications</a></h2> 236<h2><a class="toc-backref" href="#id17" id="user-applications" name="user-applications">User Applications</a></h2>
242<p>Whereas the System Administration chapter contains the information on how to 237<p>Whereas the System Administration chapter contains the information on how to
243install software and services (such as XFree), this chapter would contain 238install software and services (such as XFree), this chapter would contain
244information for the users (not the administrators) on how they can use 239information for the users (not the administrators) on how they can use
245software installed by the system administrator.</p> 240software installed by the system administrator.</p>
246<p>Gentoo currently has several guides that describe such user applications 241<p>Gentoo currently has several guides that describe such user applications
248appreciate, so neglecting them would be signing our own death wish :)</p> 243appreciate, so neglecting them would be signing our own death wish :)</p>
249<p>Due to the nature of these documents, the User Applications chapter will exist 244<p>Due to the nature of these documents, the User Applications chapter will exist
250of independent sections.</p> 245of independent sections.</p>
251</div> 246</div>
252</div> 247</div>
253<div class="section" id="backwards-compatibility"> 248<div class="section">
254<h1><a class="toc-backref" href="#id18" name="backwards-compatibility">Backwards Compatibility</a></h1> 249<h1><a class="toc-backref" href="#id18" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1>
255<p>By making only small changes (actually extending) the GuideXML format, it is 250<p>By making only small changes (actually extending) the GuideXML format, it is
256possible (and even adviseable) to develop each chapter on its own parallel 251possible (and even adviseable) to develop each chapter on its own parallel
257with the guides that are involved.</p> 252with the guides that are involved.</p>
258<p>By developing the handbook in a subdirectory of the current documentation 253<p>By developing the handbook in a subdirectory of the current documentation
259directory (for instance <tt class="literal"><span class="pre">http://www.gentoo.org/doc/en/handbook</span></tt>) we maintain 254directory (for instance <tt class="docutils literal"><span class="pre">http://www.gentoo.org/doc/en/handbook</span></tt>) we maintain
260the current documentation. When a chapter on the handbook is finished, the 255the current documentation. When a chapter on the handbook is finished, the
261involved documents can contain a big note on top, declaring that they are now 256involved documents can contain a big note on top, declaring that they are now
262obsoleted by the handbook's chapter.</p> 257obsoleted by the handbook's chapter.</p>
263<p>However, note that this handbook does <strong>not</strong> and will <strong>not</strong> embrace all 258<p>However, note that this handbook does <strong>not</strong> and will <strong>not</strong> embrace all
264documents that the Gentoo Documentation Project produces. It is very likely 259documents that the Gentoo Documentation Project produces. It is very likely
265that there are guides that don't have a clear position inside this handbook. 260that there are guides that don't have a clear position inside this handbook.
266Instead of forcing the guide somewhere, we should leave the guide as a 261Instead of forcing the guide somewhere, we should leave the guide as a
267stand-alone document.</p> 262stand-alone document.</p>
268</div> 263</div>
269<div class="section" id="reference-implementation"> 264<div class="section">
270<h1><a class="toc-backref" href="#id19" name="reference-implementation">Reference Implementation</a></h1> 265<h1><a class="toc-backref" href="#id19" id="reference-implementation" name="reference-implementation">Reference Implementation</a></h1>
271<p>This is a possible roadmap for the Gentoo Handbook:</p> 266<p>This is a possible roadmap for the Gentoo Handbook:</p>
272<pre class="literal-block"> 267<pre class="literal-block">
273- Improve the GuideXML format, possibly creating a handbook.xsl stylesheet 268- Improve the GuideXML format, possibly creating a handbook.xsl stylesheet
274(and leave the guide.xsl as it is now). 269(and leave the guide.xsl as it is now).
275 270
276- Implement the Installation Instructions 271- Implement the Installation Instructions
277 272
278- Develop a consistent layout, keeping the guides that are to be implemented 273- Develop a consistent layout, keeping the guides that are to be implemented
279 in mind. 274 in mind.
280 275
281- Include all referenced guides. Do *not* extend it yet. 276- Include all referenced guides. Do *not* extend it yet.
282 277
283- Review the installation instructions and make them official 278- Review the installation instructions and make them official
289- Implement the User Application Instructions 284- Implement the User Application Instructions
290 285
291- Implement the System Administration Instructions 286- Implement the System Administration Instructions
292</pre> 287</pre>
293</div> 288</div>
294<div class="section" id="references"> 289<div class="section">
295<h1><a class="toc-backref" href="#id20" name="references">References</a></h1> 290<h1><a class="toc-backref" href="#id20" id="references" name="references">References</a></h1>
296<table class="footnote" frame="void" id="instguide" rules="none"> 291<table class="docutils footnote" frame="void" id="instguide" rules="none">
297<colgroup><col class="label" /><col /></colgroup> 292<colgroup><col class="label" /><col /></colgroup>
298<tbody valign="top"> 293<tbody valign="top">
299<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> 294<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>
300</tbody> 295</tbody>
301</table> 296</table>
302<table class="footnote" frame="void" id="altinst" rules="none"> 297<table class="docutils footnote" frame="void" id="altinst" rules="none">
303<colgroup><col class="label" /><col /></colgroup> 298<colgroup><col class="label" /><col /></colgroup>
304<tbody valign="top"> 299<tbody valign="top">
305<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> 300<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>
306</tbody> 301</tbody>
307</table> 302</table>
308<table class="footnote" frame="void" id="lvm" rules="none"> 303<table class="docutils footnote" frame="void" id="lvm" rules="none">
309<colgroup><col class="label" /><col /></colgroup> 304<colgroup><col class="label" /><col /></colgroup>
310<tbody valign="top"> 305<tbody valign="top">
311<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> 306<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>
312</tbody> 307</tbody>
313</table> 308</table>
314<table class="footnote" frame="void" id="fbsdhandbook" rules="none"> 309<table class="docutils footnote" frame="void" id="fbsdhandbook" rules="none">
315<colgroup><col class="label" /><col /></colgroup> 310<colgroup><col class="label" /><col /></colgroup>
316<tbody valign="top"> 311<tbody valign="top">
317<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> 312<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>
318</tbody> 313</tbody>
319</table> 314</table>
320<table class="footnote" frame="void" id="gdp" rules="none"> 315<table class="docutils footnote" frame="void" id="gdp" rules="none">
321<colgroup><col class="label" /><col /></colgroup> 316<colgroup><col class="label" /><col /></colgroup>
322<tbody valign="top"> 317<tbody valign="top">
323<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> 318<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>
324</tbody> 319</tbody>
325</table> 320</table>
326<table class="footnote" frame="void" id="guidexml" rules="none"> 321<table class="docutils footnote" frame="void" id="guidexml" rules="none">
327<colgroup><col class="label" /><col /></colgroup> 322<colgroup><col class="label" /><col /></colgroup>
328<tbody valign="top"> 323<tbody valign="top">
329<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> 324<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>
330</tbody> 325</tbody>
331</table> 326</table>
332<table class="footnote" frame="void" id="desktop" rules="none"> 327<table class="docutils footnote" frame="void" id="desktop" rules="none">
333<colgroup><col class="label" /><col /></colgroup> 328<colgroup><col class="label" /><col /></colgroup>
334<tbody valign="top"> 329<tbody valign="top">
335<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> 330<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>
336</tbody> 331</tbody>
337</table> 332</table>
338<table class="footnote" frame="void" id="gendoc" rules="none"> 333<table class="docutils footnote" frame="void" id="gendoc" rules="none">
339<colgroup><col class="label" /><col /></colgroup> 334<colgroup><col class="label" /><col /></colgroup>
340<tbody valign="top"> 335<tbody valign="top">
341<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> 336<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>
342</tbody> 337</tbody>
343</table> 338</table>
344</div> 339</div>
345<div class="section" id="copyright"> 340<div class="section">
346<h1><a class="toc-backref" href="#id21" name="copyright">Copyright</a></h1> 341<h1><a class="toc-backref" href="#id21" id="copyright" name="copyright">Copyright</a></h1>
347<p>This document has been placed in the public domain.</p> 342<p>This document has been placed in the public domain.</p>
348</div> 343</div>
349</div>
350 344
345</div>
346<div class="footer">
351<hr class="footer" /> 347<hr class="footer" />
352<div class="footer">
353<a class="reference" href="glep-0013.txt">View document source</a>. 348<a class="reference" href="glep-0013.txt">View document source</a>.
354Generated on: 2004-10-25 16:58 UTC. 349Generated on: 2007-10-13 13:39 UTC.
355Generated 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. 350Generated 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.
351
356</div> 352</div>
357</body> 353</body>
358</html> 354</html>
359 355

Legend:
Removed from v.1.2  
changed lines
  Added in v.1.5

  ViewVC Help
Powered by ViewVC 1.1.20