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

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

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

Revision 1.2 Revision 1.4
6PEP, see http://www.python.org/peps/pep-0001.html for instructions and links 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! 7to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE!
8--> 8-->
9<head> 9<head>
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 <meta name="generator" content="Docutils 0.3.0: http://docutils.sourceforge.net/" /> 11 <meta name="generator" content="Docutils 0.3.3: http://docutils.sourceforge.net/" />
12 <title>GLEP 10 -- Localization for Gentoo Community</title> 12 <title>GLEP 10 -- Localized Gentoo Sites</title>
13 <link rel="stylesheet" href="tools/glep.css" type="text/css" /> 13 <link rel="stylesheet" href="tools/glep.css" type="text/css" />
14</head> 14</head>
15<body bgcolor="white"> 15<body bgcolor="white">
16<table class="navigation" cellpadding="0" cellspacing="0" 16<table class="navigation" cellpadding="0" cellspacing="0"
17 width="100%" border="0"> 17 width="100%" border="0">
20<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" 20<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
21 border="0" width="150" height="35" /></a></td> 21 border="0" width="150" height="35" /></a></td>
22<td class="textlinks" align="left"> 22<td class="textlinks" align="left">
23[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] 23[<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>] 24[<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>]
25[<b><a href="http://www.gentoo.org/proj/en/glep/glep-0010.txt">GLEP Source</a></b>] 25[<b><a href="./glep-0010.txt">GLEP Source</a></b>]
26</td></tr></table> 26</td></tr></table>
27<div class="document"> 27<div class="document">
28<table class="rfc2822 field-list" frame="void" rules="none"> 28<table class="rfc2822 field-list" frame="void" rules="none">
29<col class="field-name" /> 29<col class="field-name" />
30<col class="field-body" /> 30<col class="field-body" />
31<tbody valign="top"> 31<tbody valign="top">
32<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">10</td> 32<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">10</td>
33</tr> 33</tr>
34<tr class="field"><th class="field-name">Title:</th><td class="field-body">Localization for Gentoo Community</td> 34<tr class="field"><th class="field-name">Title:</th><td class="field-body">Localized Gentoo Sites</td>
35</tr> 35</tr>
36<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.1</td> 36<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.4</td>
37</tr> 37</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.cgi/xml/htdocs/proj/en/glep/glep-0010.txt?cvsroot=gentoo">2003/08/04 18:03:54</a></td> 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-0010.txt?cvsroot=gentoo">2004/08/22 13:57:11</a></td>
39</tr> 39</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> 40<tr class="field"><th class="field-name">Author:</th><td class="field-body">Tobias Scherbaum &lt;dertobi123&#32;&#97;t&#32;gentoo.org&gt;, Sven Vermeulen &lt;swift&#32;&#97;t&#32;gentoo.org&gt;</td>
41</tr> 41</tr>
42<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> 42<tr class="field"><th class="field-name">Status:</th><td class="field-body">deferred</td>
43</tr> 43</tr>
44<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
45</tr>
46<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>
48<tr class="field"><th class="field-name">Created:</th><td class="field-body">4 Aug 2003</td> 44<tr class="field"><th class="field-name">Created:</th><td class="field-body">4-Aug-2003</td>
49</tr> 45</tr>
50<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">4-Aug-2003, 22-Aug-2003</td> 46<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">4-Aug-2003, 22-Aug-2003, 14-Mar-2004, 2-May-2004, 22-Aug-2004</td>
51</tr> 47</tr>
52</tbody> 48</tbody>
53</table> 49</table>
54<hr /> 50<hr />
55<div class="contents topic" id="contents"> 51<div class="contents topic" id="contents">
56<p class="topic-title"><a name="contents">Contents</a></p> 52<p class="topic-title first"><a name="contents">Contents</a></p>
57<ul class="simple"> 53<ul class="simple">
54<li><a class="reference" href="#status" id="id4" name="id4">Status</a></li>
58<li><a class="reference" href="#abstract" id="id8" name="id8">Abstract</a></li> 55<li><a class="reference" href="#abstract" id="id5" name="id5">Abstract:</a></li>
59<li><a class="reference" href="#motivation" id="id9" name="id9">Motivation</a></li> 56<li><a class="reference" href="#motivation" id="id6" name="id6">Motivation:</a></li>
60<li><a class="reference" href="#rationale" id="id10" name="id10">Rationale</a></li> 57<li><a class="reference" href="#rationale" id="id7" name="id7">Rationale:</a></li>
61<li><a class="reference" href="#implementation" id="id11" name="id11">Implementation</a><ul> 58<li><a class="reference" href="#implementation" id="id8" name="id8">Implementation:</a><ul>
62<li><a class="reference" href="#cvs-structure" id="id12" name="id12">CVS Structure</a></li>
63<li><a class="reference" href="#website-pages" id="id13" name="id13">Website pages</a></li> 59<li><a class="reference" href="#website-pages" id="id9" name="id9">Website Pages:</a><ul>
64<li><a class="reference" href="#cvs-permissions" id="id14" name="id14">CVS Permissions</a></li> 60<li><a class="reference" href="#requirements-for-small-localized-sites" id="id10" name="id10">Requirements for &quot;small&quot; localized sites:</a></li>
61<li><a class="reference" href="#requirements-for-big-localized-sites" id="id11" name="id11">Requirements for &quot;big&quot; localized sites:</a></li>
65</ul> 62</ul>
66</li> 63</li>
67<li><a class="reference" href="#references" id="id15" name="id15">References</a></li> 64<li><a class="reference" href="#cvs-structure" id="id12" name="id12">CVS Structure:</a></li>
68<li><a class="reference" href="#copyright" id="id16" name="id16">Copyright</a></li> 65<li><a class="reference" href="#mail" id="id13" name="id13">Mail:</a></li>
66<li><a class="reference" href="#xsl" id="id14" name="id14">XSL:</a></li>
67</ul>
69</ul> 68</li>
69</ul>
70</div>
71<div class="section" id="status">
72<h1><a class="toc-backref" href="#id4" name="status">Status</a></h1>
73<p>Due to insufficient resources, the doc team is unable to implement
74this GLEP at this time. It has therefore been marked &quot;deferred&quot;.</p>
70</div> 75</div>
71<div class="section" id="abstract"> 76<div class="section" id="abstract">
72<h1><a class="toc-backref" href="#id8" name="abstract">Abstract</a></h1> 77<h1><a class="toc-backref" href="#id5" name="abstract">Abstract:</a></h1>
73<p>The <a class="reference" href="http://www.gentoo.org">Gentoo web site</a> <a class="footnote-reference" href="#id2" id="id3" name="id3">[2]</a> is the main source of documentation regarding 78<p>The Gentoo Website <a class="footnote-reference" href="#gentoo" id="id1" name="id1">[1]</a> is the main source of documentation regarding
74Gentoo itself. It hosts all documents that the <a class="reference" href="http://www.gentoo.org/proj/en/gdp">Gentoo Documentation 79Gentoo itself. It hosts all documents that the Gentoo Documentation Project
75Project</a> <a class="footnote-reference" href="#id4" id="id5" name="id5">[3]</a> delivers, including all made translations.</p> 80<a class="footnote-reference" href="#gdp" id="id2" name="id2">[2]</a> delivers, including all made translations. In addition the website
76<p>This GLEP proposes some changes regarding the documentation 81contains the GWN and its translations and several news items.</p>
77so that we can provide our international users with information regarding
78Gentoo Communities, as proposed by <a class="reference" href="http://bugs.gentoo.org/show_bug.cgi?id=23199">Bug #23199</a> <a class="footnote-reference" href="#id6" id="id7" name="id7">[4]</a>.</p>
79</div> 82</div>
80<div class="section" id="motivation"> 83<div class="section" id="motivation">
81<h1><a class="toc-backref" href="#id9" name="motivation">Motivation</a></h1> 84<h1><a class="toc-backref" href="#id6" name="motivation">Motivation:</a></h1>
82<p>Lots of people have shown interest in the localization proposal, 85<p>Lots of people have shown interest in the localization proposal, and
83and even the infrastructure team has given positive feedback. However, 86even the infrastructure team has given positive feedback. However, due
84due to lack of a good roadmap and proposal this suggestion has never 87to lack of a good roadmap and proposal this suggestion has never grown
85grown beyond what it is now: a suggestion.</p> 88beyond what it is now: a suggestion. Between the first draft of this
86<p>The current CVS structure (and permissions) are insufficient to implement a 89proposal and now some communities grown faster than others. Actually it
87localized section for each possible country. The current permissions are to 90is obvious that we have big communities (lots of users, lots of
88broad while they should be very strict, the current layout is too fragmented 91translators) and smaller communities (less users, less translators). If
89while it should be grouped together.</p> 92we speak about localized Gentoo sites we need to find a capable
93solution for small and even bigger communities. This leads us to a
94point where the lead translator can decide between a small localized
95site including necessarily translated documents and only some
96additional pages and a bigger variant with lots of translated gdp
97documents, translated news and gwn plus additional pages.</p>
90</div> 98</div>
91<div class="section" id="rationale"> 99<div class="section" id="rationale">
92<h1><a class="toc-backref" href="#id10" name="rationale">Rationale</a></h1> 100<h1><a class="toc-backref" href="#id7" name="rationale">Rationale:</a></h1>
93<p>The current layout regarding documentation in the CVS is as follows:</p> 101<p>The current layout regarding documentation in the CVS is as follows:</p>
94<pre class="literal-block"> 102<blockquote>
95[gentoo]/xml/htdocs/doc/en/* 103[gentoo]/xml/htdocs/doc/en/*
96[gentoo]/xml/htdocs/doc/nl/* 104[gentoo]/xml/htdocs/doc/nl/*
97[gentoo]/xml/htdocs/doc/fr/* 105[gentoo]/xml/htdocs/doc/fr/*</blockquote>
98... 106<p>However, there are several other documents (about, policy, etc) in
99</pre> 107main/$lang:</p>
100<p>However, the documentation index page itself (and several other 108<blockquote>
101important parts of the Gentoo website) are structed like this:</p>
102<pre class="literal-block">
103[gentoo]/xml/htdocs/main/en/* 109[gentoo]/xml/htdocs/main/en/*
104[gentoo]/xml/htdocs/main/nl/* 110[gentoo]/xml/htdocs/main/nl/*
105[gentoo]/xml/htdocs/main/fr/* 111[gentoo]/xml/htdocs/main/fr/*</blockquote>
106...
107</pre>
108<p>This structure makes it very difficult for assigning permissions to the 112<p>This structure makes it very difficult for assigning permissions to the
109individual translation teams, and even more difficult to really localise 113individual translation teams, and even more difficult to really localize
110the Gentoo Website. At this very moment, the translation teams can edit 114the Gentoo Website. At this very moment, the translation teams can edit
111documents of other languages or even the master English documents. English 115documents of other languages or even the master English documents. English
112reviewers and editors can touch documents of languages they possibly don't 116reviewers and editors can touch documents of languages they possibly don't
113even know. Although we do trust every single documentation editor, a better 117even know. Although we do trust every single documentation editor, a better
114implementation is advisable.</p> 118implementation is advisable. We also can't give access to well-known
119but non-dev translators.</p>
115<p>We want to restructure the current layout so that the Gentoo Website is 120<p>We want to restructure the current layout so that the Gentoo Website is
116more easily internationalized.</p> 121more easily internationalized.</p>
117</div> 122</div>
118<div class="section" id="implementation"> 123<div class="section" id="implementation">
119<h1><a class="toc-backref" href="#id11" name="implementation">Implementation</a></h1> 124<h1><a class="toc-backref" href="#id8" name="implementation">Implementation:</a></h1>
125<div class="section" id="website-pages">
126<h2><a class="toc-backref" href="#id9" name="website-pages">Website Pages:</a></h2>
127<p>The Lead Translator can choose if he wants to maintain a &quot;small&quot; or a
128&quot;big&quot; localized site. All localized sites will be accessible on
129<a class="reference" href="http://$lang.gentoo.org">http://$lang.gentoo.org</a> which will point to [gentoo]xml/htdocs/$lang.
130All localized sites must be implemented in GuideXML.</p>
131<div class="section" id="requirements-for-small-localized-sites">
132<h3><a class="toc-backref" href="#id10" name="requirements-for-small-localized-sites">Requirements for &quot;small&quot; localized sites:</a></h3>
133<blockquote>
134<ul class="simple">
135<li>all documents marked as required in our Translators Howto</li>
136<li>$lang/main/translators.xml, listing of all translators (including
137GWN translators)</li>
138<li>$lang/main/communities.xml, listing of all community sites available in $lang</li>
139<li>index.xml &quot;welcome page&quot;, listing of available ressources on
140$lang.gentoo.org (i.e. links to documentation, translators.xml and
141communities.xml)</li>
142</ul>
143</blockquote>
144</div>
145<div class="section" id="requirements-for-big-localized-sites">
146<h3><a class="toc-backref" href="#id11" name="requirements-for-big-localized-sites">Requirements for &quot;big&quot; localized sites:</a></h3>
147<blockquote>
148<ul class="simple">
149<li>all documents marked as required in our Translators Howto</li>
150<li>$lang/main/translators.xml, listing of all translators (including
151GWN translators)</li>
152<li>$lang/main/communities.xml, listing of all community sites available in $lang</li>
153<li>translated $lang/main documents</li>
154<li>translated $lang/news/gwn</li>
155<li>translated news items ($lang/news) (only translated news items,
156news items on a per-lang basis aren't allowed)</li>
157</ul>
158</blockquote>
159</div>
160</div>
120<div class="section" id="cvs-structure"> 161<div class="section" id="cvs-structure">
121<h2><a class="toc-backref" href="#id12" name="cvs-structure">CVS Structure</a></h2> 162<h2><a class="toc-backref" href="#id12" name="cvs-structure">CVS Structure:</a></h2>
122<p>What is needed, is a clear distinction between documentation, newsletters,
123website and localization. This requires a directory structure in the CVS
124repository that reflects this distinction.</p>
125<p>In the following scheme, everything is relative to [gentoo]/xml/htdocs:</p> 163<p>Actual scheme, everything is relative to [gentoo]/xml/htdocs:</p>
126<pre class="literal-block"> 164<pre class="literal-block">
127main/en Contains the main Gentoo Website 165main/en Contains the main Gentoo Website (about, policy, lists, etc.)
128main/${LANGUAGE} Contains some translated website pages 166main/$lang Contains some translated Website pages
129main/lcl/${COUNTRYCODE} Contains the localized Gentoo page
130doc/en Contains the master English Documentation 167doc/en Contains the master English Documentation
131doc/${LANGUAGE} Contains the translated Documentation 168doc/$lang Contains the translated Documentation
169news Contains English news items
132news/en Contains the English GWNs 170news/en/gwn Contains the master English GWNs
133news/${LANGUAGE} Contains the translated GWNs 171news/$lang/gwn Contains translated GWNs
134proj/en Contains the project Webpages 172proj/en Contains the project Webpages
135</pre> 173</pre>
136<p>In comparison with what is currently the case, there are no big changes. 174<p>Proposed scheme, relative to [gentoo]/xml/htdocs:</p>
137I've explicitly left out <cite>proj/${LANGUAGE}</cite> since there is no direct
138need to translate project websites. If it is desired, then creating a
139language-specific directory is sufficient.</p>
140</div>
141<div class="section" id="website-pages">
142<h2><a class="toc-backref" href="#id13" name="website-pages">Website pages</a></h2>
143<p>Currently, the main documentation page is <cite>main/en/docs.xml</cite>. A better
144implementation would be to have it as <cite>doc/en/index.xml</cite>. This keeps
145everything documentation-related together. It also provides us with
146seperate index pages for each language (<cite>doc/${LANGUAGE}/index.xml</cite>).</p>
147<p>The documentation indexes should mention the other indexes (for other
148languages), but shouldn't have seperate links for each language per
149document.</p>
150<p>The localization page resides in <cite>main/${COUNTRYCODE}/index.xml</cite>. This
151page, which is formatted the same way as the whole Gentoo website,
152<strong>only</strong> contains the following information:</p>
153<pre class="literal-block"> 175<pre class="literal-block">
154- A list of community websites [1]_ 176$lang/main Contains some translated Website pages
155 177$lang/doc Contains the translated Documentation
156- A link to the translated documentation index 178$lang/news Contains translated news items
157 179$lang/news/gwn Contains translated GWNs
158- A link to translated Gentoo-webpages::
159
160 * About
161
162 * Social Contract
163
164 * Gentoo Weekly News
165</pre> 180</pre>
166<p>If the localization team wants, this can be extended to also provide
167news-items (such as with the main Gentoo website). In this case, the
168news items also reside in <cite>main/lcl/${COUNTRYCODE}</cite>.</p>
169<p>Also, <cite>http://${COUNTRYCODE}.gentoo.org</cite> should point to
170<cite>main/lcl/${COUNTRYCODE}/index.xml</cite>.</p>
171</div> 181</div>
172<div class="section" id="cvs-permissions"> 182<div class="section" id="mail">
173<h2><a class="toc-backref" href="#id14" name="cvs-permissions">CVS Permissions</a></h2> 183<h2><a class="toc-backref" href="#id13" name="mail">Mail:</a></h2>
174<p>The permissions are now clear and distinct:</p> 184<p>All mails to <a class="reference" href="mailto:www-$lang&#64;gentoo.org">www-$lang&#64;gentoo.org</a> should be forwarded to the Lead
175<pre class="literal-block"> 185Translator and his Follow-Up.</p>
176- Documentation Developers cannot touch the Gentoo website,
177 except for the Index page, which now resides in `doc/en`.
178
179- Translators can only touch files in `doc/${LANGUAGE}` and
180 `main/${LANGUAGE}`.
181
182- The localized pages, which are rather static (since they only
183 contain a list of community sites), are maintained by a
184 single group for all countrycodes, unless the localization
185 pages also contain newsitems, in which case seperate groups
186 for each country can exist.
187</pre>
188</div> 186</div>
189</div>
190<div class="section" id="references"> 187<div class="section" id="xsl">
191<h1><a class="toc-backref" href="#id15" name="references">References</a></h1> 188<h2><a class="toc-backref" href="#id14" name="xsl">XSL:</a></h2>
189<p>We need to &quot;hack&quot; our guide.xsl to support something like inserts.xml for the
190whole site.</p>
192<table class="footnote" frame="void" id="id1" rules="none"> 191<table class="footnote" frame="void" id="gentoo" rules="none">
193<colgroup><col class="label" /><col /></colgroup> 192<colgroup><col class="label" /><col /></colgroup>
194<tbody valign="top"> 193<tbody valign="top">
195<tr><td class="label"><a name="id1">[1]</a></td><td>A sum of such community sites can be found at 194<tr><td class="label"><a class="fn-backref" href="#id1" name="gentoo">[1]</a></td><td><a class="reference" href="http://www.gentoo.org">http://www.gentoo.org</a></td></tr>
196<a class="reference" href="http://dev.gentoo.org/~liquidx/communities.html">http://dev.gentoo.org/~liquidx/communities.html</a></td></tr>
197</tbody> 195</tbody>
198</table> 196</table>
199<table class="footnote" frame="void" id="id2" rules="none"> 197<table class="footnote" frame="void" id="gdp" rules="none">
200<colgroup><col class="label" /><col /></colgroup> 198<colgroup><col class="label" /><col /></colgroup>
201<tbody valign="top"> 199<tbody valign="top">
202<tr><td class="label"><a class="fn-backref" href="#id3" name="id2">[2]</a></td><td><a class="reference" href="http://www.gentoo.org">http://www.gentoo.org</a></td></tr> 200<tr><td class="label"><a class="fn-backref" href="#id2" name="gdp">[2]</a></td><td><a class="reference" href="http://gdp.gentoo.org">http://gdp.gentoo.org</a></td></tr>
203</tbody> 201</tbody>
204</table> 202</table>
205<table class="footnote" frame="void" id="id4" rules="none">
206<colgroup><col class="label" /><col /></colgroup>
207<tbody valign="top">
208<tr><td class="label"><a class="fn-backref" href="#id5" name="id4">[3]</a></td><td><a class="reference" href="http://www.gentoo.org/proj/en/gdp">http://www.gentoo.org/proj/en/gdp</a></td></tr>
209</tbody>
210</table>
211<table class="footnote" frame="void" id="id6" rules="none">
212<colgroup><col class="label" /><col /></colgroup>
213<tbody valign="top">
214<tr><td class="label"><a class="fn-backref" href="#id7" name="id6">[4]</a></td><td><a class="reference" href="http://bugs.gentoo.org/show_bug.cgi?id=23199">http://bugs.gentoo.org/show_bug.cgi?id=23199</a></td></tr>
215</tbody>
216</table>
217</div> 203</div>
218<div class="section" id="copyright">
219<h1><a class="toc-backref" href="#id16" name="copyright">Copyright</a></h1>
220<p>This document has been placed in the public domain.</p>
221</div> 204</div>
222</div> 205</div>
223 206
224<hr class="footer"/> 207<hr class="footer" />
225<div class="footer"> 208<div class="footer">
226<a class="reference" href="glep-0010.txt">View document source</a>. 209<a class="reference" href="glep-0010.txt">View document source</a>.
227Generated on: 2003-08-24 22:07 UTC. 210Generated on: 2004-08-22 13:42 UTC.
228Generated 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. 211Generated 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.
229</div> 212</div>
230</body> 213</body>
231</html> 214</html>
232 215

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

  ViewVC Help
Powered by ViewVC 1.1.20