/[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.1 Revision 1.2
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.0: http://docutils.sourceforge.net/" />
12 <title>GLEP 10 -- Internationalization of www.gentoo.org</title> 12 <title>GLEP 10 -- Localization for Gentoo Community</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">
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">Internationalization of www.gentoo.org</td> 34<tr class="field"><th class="field-name">Title:</th><td class="field-body">Localization for Gentoo Community</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.1</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.cgi/xml/htdocs/proj/en/glep/glep-0010.txt?cvsroot=gentoo">2003/08/04 18:03:54</a></td>
39</tr> 39</tr>
45</tr> 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> 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> 47</tr>
48<tr class="field"><th class="field-name">Created:</th><td class="field-body">4 Aug 2003</td> 48<tr class="field"><th class="field-name">Created:</th><td class="field-body">4 Aug 2003</td>
49</tr> 49</tr>
50<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">4-Aug-2003</td> 50<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">4-Aug-2003, 22-Aug-2003</td>
51</tr> 51</tr>
52</tbody> 52</tbody>
53</table> 53</table>
54<hr /> 54<hr />
55<div class="contents topic" id="contents"> 55<div class="contents topic" id="contents">
56<p class="topic-title"><a name="contents">Contents</a></p> 56<p class="topic-title"><a name="contents">Contents</a></p>
57<ul class="simple"> 57<ul class="simple">
58<li><a class="reference" href="#abstract" id="id11" name="id11">Abstract</a></li> 58<li><a class="reference" href="#abstract" id="id8" name="id8">Abstract</a></li>
59<li><a class="reference" href="#motivation" id="id12" name="id12">Motivation</a></li> 59<li><a class="reference" href="#motivation" id="id9" name="id9">Motivation</a></li>
60<li><a class="reference" href="#rationale" id="id13" name="id13">Rationale</a></li> 60<li><a class="reference" href="#rationale" id="id10" name="id10">Rationale</a></li>
61<li><a class="reference" href="#implementation" id="id14" name="id14">Implementation</a><ul> 61<li><a class="reference" href="#implementation" id="id11" name="id11">Implementation</a><ul>
62<li><a class="reference" href="#cvs-structure" id="id15" name="id15">CVS Structure</a></li> 62<li><a class="reference" href="#cvs-structure" id="id12" name="id12">CVS Structure</a></li>
63<li><a class="reference" href="#internationalized-website" id="id16" name="id16">Internationalized Website</a></li> 63<li><a class="reference" href="#website-pages" id="id13" name="id13">Website pages</a></li>
64<li><a class="reference" href="#permissions" id="id17" name="id17">Permissions</a></li> 64<li><a class="reference" href="#cvs-permissions" id="id14" name="id14">CVS Permissions</a></li>
65</ul> 65</ul>
66</li> 66</li>
67<li><a class="reference" href="#backwards-compatibility" id="id18" name="id18">Backwards Compatibility</a></li>
68<li><a class="reference" href="#references" id="id19" name="id19">References</a></li> 67<li><a class="reference" href="#references" id="id15" name="id15">References</a></li>
69<li><a class="reference" href="#copyright" id="id20" name="id20">Copyright</a></li> 68<li><a class="reference" href="#copyright" id="id16" name="id16">Copyright</a></li>
70</ul> 69</ul>
71</div> 70</div>
72<div class="section" id="abstract"> 71<div class="section" id="abstract">
73<h1><a class="toc-backref" href="#id11" name="abstract">Abstract</a></h1> 72<h1><a class="toc-backref" href="#id8" name="abstract">Abstract</a></h1>
74<p>The <a class="reference" href="http://www.gentoo.org">Gentoo web site</a> <a class="footnote-reference" href="#id3" id="id4" name="id4">[2]</a> is the main source of documentation regarding 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
75Gentoo itself. It hosts all documents that the <a class="reference" href="http://www.gentoo.org/proj/en/gdp">Gentoo Documentation 74Gentoo itself. It hosts all documents that the <a class="reference" href="http://www.gentoo.org/proj/en/gdp">Gentoo Documentation
76Project</a> <a class="footnote-reference" href="#id5" id="id6" name="id6">[3]</a> delivers, including all made translations.</p> 75Project</a> <a class="footnote-reference" href="#id4" id="id5" name="id5">[3]</a> delivers, including all made translations.</p>
77<p>This GLEP proposes a change in CVS structure regarding the documentation 76<p>This GLEP proposes some changes regarding the documentation
78so that the individual translation teams can create a localized Gentoo 77so that we can provide our international users with information regarding
79website as proposed by <a class="reference" href="http://bugs.gentoo.org/show_bug.cgi?id=23199">Bug #23199</a> <a class="footnote-reference" href="#id7" id="id8" name="id8">[4]</a>.</p> 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>
80</div> 79</div>
81<div class="section" id="motivation"> 80<div class="section" id="motivation">
82<h1><a class="toc-backref" href="#id12" name="motivation">Motivation</a></h1> 81<h1><a class="toc-backref" href="#id9" name="motivation">Motivation</a></h1>
83<p>Lots of people have shown interest in the internationalization proposal, 82<p>Lots of people have shown interest in the localization proposal,
84and even the infrastructure team has given positive feedback. However, 83and even the infrastructure team has given positive feedback. However,
85due to lack of a good roadmap and proposal this suggestion has never 84due to lack of a good roadmap and proposal this suggestion has never
86grown beyond what it is now: a suggestion.</p> 85grown beyond what it is now: a suggestion.</p>
87<p>The current CVS structure (and permissions) are insufficient to implement an 86<p>The current CVS structure (and permissions) are insufficient to implement a
88internationalized website. The current permissions are to broad while they 87localized section for each possible country. The current permissions are to
89should be very strict, the current layout is too fragmented while it should be 88broad while they should be very strict, the current layout is too fragmented
90grouped together.</p> 89while it should be grouped together.</p>
91</div> 90</div>
92<div class="section" id="rationale"> 91<div class="section" id="rationale">
93<h1><a class="toc-backref" href="#id13" name="rationale">Rationale</a></h1> 92<h1><a class="toc-backref" href="#id10" name="rationale">Rationale</a></h1>
94<p>The current layout regarding documentation in the CVS is as follows:</p> 93<p>The current layout regarding documentation in the CVS is as follows:</p>
95<pre class="literal-block"> 94<pre class="literal-block">
96[gentoo]/xml/htdocs/doc/en/* 95[gentoo]/xml/htdocs/doc/en/*
97[gentoo]/xml/htdocs/doc/nl/* 96[gentoo]/xml/htdocs/doc/nl/*
98[gentoo]/xml/htdocs/doc/fr/* 97[gentoo]/xml/htdocs/doc/fr/*
115implementation is advisable.</p> 114implementation is advisable.</p>
116<p>We want to restructure the current layout so that the Gentoo Website is 115<p>We want to restructure the current layout so that the Gentoo Website is
117more easily internationalized.</p> 116more easily internationalized.</p>
118</div> 117</div>
119<div class="section" id="implementation"> 118<div class="section" id="implementation">
120<h1><a class="toc-backref" href="#id14" name="implementation">Implementation</a></h1> 119<h1><a class="toc-backref" href="#id11" name="implementation">Implementation</a></h1>
121<div class="section" id="cvs-structure"> 120<div class="section" id="cvs-structure">
122<h2><a class="toc-backref" href="#id15" name="cvs-structure">CVS Structure</a></h2> 121<h2><a class="toc-backref" href="#id12" name="cvs-structure">CVS Structure</a></h2>
123<p>A better implementation is to fully seperate each language from the 122<p>What is needed, is a clear distinction between documentation, newsletters,
124other. For instance:</p> 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>
125<pre class="literal-block"> 126<pre class="literal-block">
126[gentoo]/xml/htdocs/en/doc 127main/en Contains the main Gentoo Website
127[gentoo]/xml/htdocs/en/main 128main/${LANGUAGE} Contains some translated website pages
128[gentoo]/xml/htdocs/en/proj 129main/lcl/${COUNTRYCODE} Contains the localized Gentoo page
129... 130doc/en Contains the master English Documentation
130[gentoo]/xml/htdocs/nl/doc 131doc/${LANGUAGE} Contains the translated Documentation
131[gentoo]/xml/htdocs/nl/main 132news/en Contains the English GWNs
132[gentoo]/xml/htdocs/nl/proj 133news/${LANGUAGE} Contains the translated GWNs
133... 134proj/en Contains the project Webpages
134[gentoo]/xml/htdocs/fr/doc
135[gentoo]/xml/htdocs/fr/main
136[gentoo]/xml/htdocs/fr/proj
137...
138</pre> 135</pre>
139<p>This implementation has several advantages:</p> 136<p>In comparison with what is currently the case, there are no big changes.
140<ul> 137I've explicitly left out <cite>proj/${LANGUAGE}</cite> since there is no direct
141<li><p class="first">Easy (and more secure) CVS permissions</p> 138need to translate project websites. If it is desired, then creating a
142<p>Every translation team can now be contained in its own group regarding 139language-specific directory is sufficient.</p>
143permissions. That group has access to the full
144[gentoo]/xml/htdocs/${LANGUAGE} directory and subdirectories. Other
145languages (including English) cannot be touched by the translation
146teams.</p>
147</li>
148<li><p class="first">Better integration regarding the website</p>
149<p>Currently, the website's <a class="reference" href="http://www.gentoo.org/main/en/docs.xml">documentation page</a> <a class="footnote-reference" href="#id9" id="id10" name="id10">[5]</a> lists all translations
150too. Every time a new translation is uploaded, the links are adjusted.
151With the new structure, the translation teams are in charge of their
152own documentation page which can be found through
153<a class="reference" href="http://www.gentoo.org">http://www.gentoo.org</a>/${LANGUAGE}/main/docs.xml.</p>
154</li>
155<li><p class="first">Internationalization of the website</p>
156<p>In this stadium <a class="reference" href="http://www.gentoo.org">http://www.gentoo.org</a>/${LANGUAGE} would host the
157internationalized Gentoo web site. The infrastructure-team would then
158make sure that <a class="reference" href="http:/">http:/</a>/${LANGUAGE}.gentoo.org refers to the
159beforementioned URL.</p>
160</li>
161</ul>
162<p>This CVS restructure shouldn't take much time, it does require an atomic
163move of the existing directories, meaning CVS access for all affected
164parties (and this <em>includes</em> the Gentoo Project webpages) would be
165unavailable during the transition. It also requires a rewrite of permissions
166which is discussed further down this GLEP.</p>
167</div> 140</div>
168<div class="section" id="internationalized-website"> 141<div class="section" id="website-pages">
169<h2><a class="toc-backref" href="#id16" name="internationalized-website">Internationalized Website</a></h2> 142<h2><a class="toc-backref" href="#id13" name="website-pages">Website pages</a></h2>
170<p>The Gentoo web servers (and their update-pace) aren't created for 143<p>Currently, the main documentation page is <cite>main/en/docs.xml</cite>. A better
171high-volume data transfers or updates. Therefor a consensus was made 144implementation would be to have it as <cite>doc/en/index.xml</cite>. This keeps
172that the teams in charge of the internationalization of the Gentoo web 145everything documentation-related together. It also provides us with
173site (in this proposal the translation teams) would not create a 146seperate index pages for each language (<cite>doc/${LANGUAGE}/index.xml</cite>).</p>
174blog-like situation, but link existing localised gentoo communities <a class="footnote-reference" href="#id2" id="id1" name="id1">[1]</a> 147<p>The documentation indexes should mention the other indexes (for other
175from the <a class="reference" href="http:/">http:/</a>/${LANGUAGE}.gentoo.org website.</p> 148languages), but shouldn't have seperate links for each language per
176<p>Some people might ask why we wouldn't just have 149document.</p>
177<a class="reference" href="http:/">http:/</a>/${LANGUAGE}.gentoo.org refer (through DNS or otherwise) to the 150<p>The localization page resides in <cite>main/${COUNTRYCODE}/index.xml</cite>. This
178respective community site. This is because that implementation is only 151page, which is formatted the same way as the whole Gentoo website,
179plausible if there is only one community site regarding the 152<strong>only</strong> contains the following information:</p>
180language/country. However, there can be several such community sites, 153<pre class="literal-block">
181and providing one with the referral and not the other would be 154- A list of community websites [1]_
182discriminating.</p> 155
156- A link to the translated documentation index
157
158- A link to translated Gentoo-webpages::
159
160 * About
161
162 * Social Contract
163
164 * Gentoo Weekly News
165</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>
183</div> 171</div>
184<div class="section" id="permissions"> 172<div class="section" id="cvs-permissions">
185<h2><a class="toc-backref" href="#id17" name="permissions">Permissions</a></h2> 173<h2><a class="toc-backref" href="#id14" name="cvs-permissions">CVS Permissions</a></h2>
186<p>The proposed implementation would result in the following possible 174<p>The permissions are now clear and distinct:</p>
187permission scheme (all read/write):</p>
188<pre class="literal-block"> 175<pre class="literal-block">
189cvswebdoc: [gentoo]/xml/htdocs/en/main and [gentoo]/xml/htdocs/en/doc 176- Documentation Developers cannot touch the Gentoo website,
190cvsnlweb: [gentoo]/xml/htdocs/nl 177 except for the Index page, which now resides in `doc/en`.
191cvsfrweb: [gentoo]/xml/htdocs/fr 178
192... 179- Translators can only touch files in `doc/${LANGUAGE}` and
193cvskernel: [gentoo]/xml/htdocs/en/proj/kernel 180 `main/${LANGUAGE}`.
194cvsgdp: [gentoo]/xml/htdocs/en/proj/gdp 181
195cvsinfrastruct: [gentoo]/xml/htdocs/en/proj/infrastructure 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.
196</pre> 187</pre>
197<p>As you can see, the translation teams are in charge of the whole
198internationalization: translation of website, projects, documentation.</p>
199<p>The English documentation team is contained in cvswebdoc and has access
200to the doc/ subdirectory (in which the documentation resides) and the
201main/ subdirectory (in which the docs.xml page and others reside).</p>
202<p>The project web pages themselves are contained in seperate groups as is
203currently the case.</p>
204</div> 188</div>
205</div>
206<div class="section" id="backwards-compatibility">
207<h1><a class="toc-backref" href="#id18" name="backwards-compatibility">Backwards Compatibility</a></h1>
208<p>Although nothing gets lost, the new implementation is not compatible with the
209current one. However, due to the nature of documentation (and website) this is
210not a problem.</p>
211</div> 189</div>
212<div class="section" id="references"> 190<div class="section" id="references">
213<h1><a class="toc-backref" href="#id19" name="references">References</a></h1> 191<h1><a class="toc-backref" href="#id15" name="references">References</a></h1>
192<table class="footnote" frame="void" id="id1" rules="none">
193<colgroup><col class="label" /><col /></colgroup>
194<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
196<a class="reference" href="http://dev.gentoo.org/~liquidx/communities.html">http://dev.gentoo.org/~liquidx/communities.html</a></td></tr>
197</tbody>
198</table>
214<table class="footnote" frame="void" id="id2" rules="none"> 199<table class="footnote" frame="void" id="id2" rules="none">
215<colgroup><col class="label" /><col /></colgroup> 200<colgroup><col class="label" /><col /></colgroup>
216<tbody valign="top"> 201<tbody valign="top">
217<tr><td class="label"><a class="fn-backref" href="#id1" name="id2">[1]</a></td><td>A sum of such community sites can be found at
218<a class="reference" href="http://dev.gentoo.org/~liquidx/communities.html">http://dev.gentoo.org/~liquidx/communities.html</a></td></tr>
219</tbody>
220</table>
221<table class="footnote" frame="void" id="id3" rules="none">
222<colgroup><col class="label" /><col /></colgroup>
223<tbody valign="top">
224<tr><td class="label"><a class="fn-backref" href="#id4" name="id3">[2]</a></td><td><a class="reference" href="http://www.gentoo.org">http://www.gentoo.org</a></td></tr> 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>
225</tbody> 203</tbody>
226</table> 204</table>
227<table class="footnote" frame="void" id="id5" rules="none"> 205<table class="footnote" frame="void" id="id4" rules="none">
228<colgroup><col class="label" /><col /></colgroup> 206<colgroup><col class="label" /><col /></colgroup>
229<tbody valign="top"> 207<tbody valign="top">
230<tr><td class="label"><a class="fn-backref" href="#id6" name="id5">[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> 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>
231</tbody> 209</tbody>
232</table> 210</table>
233<table class="footnote" frame="void" id="id7" rules="none"> 211<table class="footnote" frame="void" id="id6" rules="none">
234<colgroup><col class="label" /><col /></colgroup> 212<colgroup><col class="label" /><col /></colgroup>
235<tbody valign="top"> 213<tbody valign="top">
236<tr><td class="label"><a class="fn-backref" href="#id8" name="id7">[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> 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>
237</tbody>
238</table>
239<table class="footnote" frame="void" id="id9" rules="none">
240<colgroup><col class="label" /><col /></colgroup>
241<tbody valign="top">
242<tr><td class="label"><a class="fn-backref" href="#id10" name="id9">[5]</a></td><td><a class="reference" href="http://www.gentoo.org/main/en/docs.xml">http://www.gentoo.org/main/en/docs.xml</a></td></tr>
243</tbody> 215</tbody>
244</table> 216</table>
245</div> 217</div>
246<div class="section" id="copyright"> 218<div class="section" id="copyright">
247<h1><a class="toc-backref" href="#id20" name="copyright">Copyright</a></h1> 219<h1><a class="toc-backref" href="#id16" name="copyright">Copyright</a></h1>
248<p>This document has been placed in the public domain.</p> 220<p>This document has been placed in the public domain.</p>
249</div> 221</div>
250</div> 222</div>
251 223
252<hr class="footer"/> 224<hr class="footer"/>
253<div class="footer"> 225<div class="footer">
254<a class="reference" href="glep-0010.txt">View document source</a>. 226<a class="reference" href="glep-0010.txt">View document source</a>.
255Generated on: 2003-08-04 18:18 UTC. 227Generated on: 2003-08-24 22:07 UTC.
256Generated 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. 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.
257</div> 229</div>
258</body> 230</body>
259</html> 231</html>
260 232

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

  ViewVC Help
Powered by ViewVC 1.1.20