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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.2 - (hide annotations) (download) (as text)
Sun Aug 24 22:11:46 2003 UTC (11 years ago) by g2boojum
Branch: MAIN
Changes since 1.1: +100 -128 lines
File MIME type: text/html
Updated gleps.

1 g2boojum 1.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.3.0: http://docutils.sourceforge.net/" />
12 g2boojum 1.2 <title>GLEP 10 -- Localization for Gentoo Community</title>
13 g2boojum 1.1 <link rel="stylesheet" href="tools/glep.css" type="text/css" />
14     </head>
15     <body bgcolor="white">
16     <table class="navigation" cellpadding="0" cellspacing="0"
17     width="100%" border="0">
18     <tr><td class="navicon" width="150" height="35">
19     <a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
20     <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
21     border="0" width="150" height="35" /></a></td>
22     <td class="textlinks" align="left">
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>]
25     [<b><a href="http://www.gentoo.org/proj/en/glep/glep-0010.txt">GLEP Source</a></b>]
26     </td></tr></table>
27     <div class="document">
28     <table class="rfc2822 field-list" frame="void" rules="none">
29     <col class="field-name" />
30     <col class="field-body" />
31     <tbody valign="top">
32     <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">10</td>
33     </tr>
34 g2boojum 1.2 <tr class="field"><th class="field-name">Title:</th><td class="field-body">Localization for Gentoo Community</td>
35 g2boojum 1.1 </tr>
36     <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.1</td>
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>
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>
41     </tr>
42     <tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td>
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>
49     </tr>
50 g2boojum 1.2 <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">4-Aug-2003, 22-Aug-2003</td>
51 g2boojum 1.1 </tr>
52     </tbody>
53     </table>
54     <hr />
55     <div class="contents topic" id="contents">
56     <p class="topic-title"><a name="contents">Contents</a></p>
57     <ul class="simple">
58 g2boojum 1.2 <li><a class="reference" href="#abstract" id="id8" name="id8">Abstract</a></li>
59     <li><a class="reference" href="#motivation" id="id9" name="id9">Motivation</a></li>
60     <li><a class="reference" href="#rationale" id="id10" name="id10">Rationale</a></li>
61     <li><a class="reference" href="#implementation" id="id11" name="id11">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>
64     <li><a class="reference" href="#cvs-permissions" id="id14" name="id14">CVS Permissions</a></li>
65 g2boojum 1.1 </ul>
66     </li>
67 g2boojum 1.2 <li><a class="reference" href="#references" id="id15" name="id15">References</a></li>
68     <li><a class="reference" href="#copyright" id="id16" name="id16">Copyright</a></li>
69 g2boojum 1.1 </ul>
70     </div>
71     <div class="section" id="abstract">
72 g2boojum 1.2 <h1><a class="toc-backref" href="#id8" 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
74 g2boojum 1.1 Gentoo itself. It hosts all documents that the <a class="reference" href="http://www.gentoo.org/proj/en/gdp">Gentoo Documentation
75 g2boojum 1.2 Project</a> <a class="footnote-reference" href="#id4" id="id5" name="id5">[3]</a> delivers, including all made translations.</p>
76     <p>This GLEP proposes some changes regarding the documentation
77     so that we can provide our international users with information regarding
78     Gentoo 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 g2boojum 1.1 </div>
80     <div class="section" id="motivation">
81 g2boojum 1.2 <h1><a class="toc-backref" href="#id9" name="motivation">Motivation</a></h1>
82     <p>Lots of people have shown interest in the localization proposal,
83 g2boojum 1.1 and even the infrastructure team has given positive feedback. However,
84     due to lack of a good roadmap and proposal this suggestion has never
85     grown beyond what it is now: a suggestion.</p>
86 g2boojum 1.2 <p>The current CVS structure (and permissions) are insufficient to implement a
87     localized section for each possible country. The current permissions are to
88     broad while they should be very strict, the current layout is too fragmented
89     while it should be grouped together.</p>
90 g2boojum 1.1 </div>
91     <div class="section" id="rationale">
92 g2boojum 1.2 <h1><a class="toc-backref" href="#id10" name="rationale">Rationale</a></h1>
93 g2boojum 1.1 <p>The current layout regarding documentation in the CVS is as follows:</p>
94     <pre class="literal-block">
95     [gentoo]/xml/htdocs/doc/en/*
96     [gentoo]/xml/htdocs/doc/nl/*
97     [gentoo]/xml/htdocs/doc/fr/*
98     ...
99     </pre>
100     <p>However, the documentation index page itself (and several other
101     important parts of the Gentoo website) are structed like this:</p>
102     <pre class="literal-block">
103     [gentoo]/xml/htdocs/main/en/*
104     [gentoo]/xml/htdocs/main/nl/*
105     [gentoo]/xml/htdocs/main/fr/*
106     ...
107     </pre>
108     <p>This structure makes it very difficult for assigning permissions to the
109     individual translation teams, and even more difficult to really localise
110     the Gentoo Website. At this very moment, the translation teams can edit
111     documents of other languages or even the master English documents. English
112     reviewers and editors can touch documents of languages they possibly don't
113     even know. Although we do trust every single documentation editor, a better
114     implementation is advisable.</p>
115     <p>We want to restructure the current layout so that the Gentoo Website is
116     more easily internationalized.</p>
117     </div>
118     <div class="section" id="implementation">
119 g2boojum 1.2 <h1><a class="toc-backref" href="#id11" name="implementation">Implementation</a></h1>
120 g2boojum 1.1 <div class="section" id="cvs-structure">
121 g2boojum 1.2 <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,
123     website and localization. This requires a directory structure in the CVS
124     repository that reflects this distinction.</p>
125     <p>In the following scheme, everything is relative to [gentoo]/xml/htdocs:</p>
126 g2boojum 1.1 <pre class="literal-block">
127 g2boojum 1.2 main/en Contains the main Gentoo Website
128     main/${LANGUAGE} Contains some translated website pages
129     main/lcl/${COUNTRYCODE} Contains the localized Gentoo page
130     doc/en Contains the master English Documentation
131     doc/${LANGUAGE} Contains the translated Documentation
132     news/en Contains the English GWNs
133     news/${LANGUAGE} Contains the translated GWNs
134     proj/en Contains the project Webpages
135     </pre>
136     <p>In comparison with what is currently the case, there are no big changes.
137     I've explicitly left out <cite>proj/${LANGUAGE}</cite> since there is no direct
138     need to translate project websites. If it is desired, then creating a
139     language-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
144     implementation would be to have it as <cite>doc/en/index.xml</cite>. This keeps
145     everything documentation-related together. It also provides us with
146     seperate index pages for each language (<cite>doc/${LANGUAGE}/index.xml</cite>).</p>
147     <p>The documentation indexes should mention the other indexes (for other
148     languages), but shouldn't have seperate links for each language per
149     document.</p>
150     <p>The localization page resides in <cite>main/${COUNTRYCODE}/index.xml</cite>. This
151     page, 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">
154     - A list of community websites [1]_
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 g2boojum 1.1 </pre>
166 g2boojum 1.2 <p>If the localization team wants, this can be extended to also provide
167     news-items (such as with the main Gentoo website). In this case, the
168     news 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>
172     <div class="section" id="cvs-permissions">
173     <h2><a class="toc-backref" href="#id14" name="cvs-permissions">CVS Permissions</a></h2>
174     <p>The permissions are now clear and distinct:</p>
175 g2boojum 1.1 <pre class="literal-block">
176 g2boojum 1.2 - 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 g2boojum 1.1 </pre>
188     </div>
189     </div>
190     <div class="section" id="references">
191 g2boojum 1.2 <h1><a class="toc-backref" href="#id15" name="references">References</a></h1>
192     <table class="footnote" frame="void" id="id1" rules="none">
193 g2boojum 1.1 <colgroup><col class="label" /><col /></colgroup>
194     <tbody valign="top">
195 g2boojum 1.2 <tr><td class="label"><a name="id1">[1]</a></td><td>A sum of such community sites can be found at
196 g2boojum 1.1 <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>
199 g2boojum 1.2 <table class="footnote" frame="void" id="id2" rules="none">
200 g2boojum 1.1 <colgroup><col class="label" /><col /></colgroup>
201     <tbody valign="top">
202 g2boojum 1.2 <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>
203 g2boojum 1.1 </tbody>
204     </table>
205 g2boojum 1.2 <table class="footnote" frame="void" id="id4" rules="none">
206 g2boojum 1.1 <colgroup><col class="label" /><col /></colgroup>
207     <tbody valign="top">
208 g2boojum 1.2 <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 g2boojum 1.1 </tbody>
210     </table>
211 g2boojum 1.2 <table class="footnote" frame="void" id="id6" rules="none">
212 g2boojum 1.1 <colgroup><col class="label" /><col /></colgroup>
213     <tbody valign="top">
214 g2boojum 1.2 <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 g2boojum 1.1 </tbody>
216     </table>
217     </div>
218     <div class="section" id="copyright">
219 g2boojum 1.2 <h1><a class="toc-backref" href="#id16" name="copyright">Copyright</a></h1>
220 g2boojum 1.1 <p>This document has been placed in the public domain.</p>
221     </div>
222     </div>
223    
224     <hr class="footer"/>
225     <div class="footer">
226     <a class="reference" href="glep-0010.txt">View document source</a>.
227 g2boojum 1.2 Generated on: 2003-08-24 22:07 UTC.
228 g2boojum 1.1 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.
229     </div>
230     </body>
231     </html>

  ViewVC Help
Powered by ViewVC 1.1.20