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

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

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

Revision 1.2 Revision 1.3
1GLEP: 10 1GLEP: 10
2Title: Localization for Gentoo Community 2Title: Localized Gentoo Sites
3Version: $Revision: 1.2 $ 3Version: $Revision: 1.3 $
4Last-Modified: $Date: 2003/08/24 22:11:46 $ 4Last-Modified: $Date: 2004/05/02 21:15:23 $
5Author: Sven Vermeulen <swift@gentoo.org> 5Author: Tobias Scherbaum <dertobi123@gentoo.org>, Sven Vermeulen <swift@gentoo.org>
6Status: Draft 6Status: Draft
7Type: Standards Track
8Content-Type: text/x-rst
9Created: 4 Aug 2003 7Created: 4-Aug-2003
10Post-History: 4-Aug-2003, 22-Aug-2003 8Post-History: 4-Aug-2003, 22-Aug-2003, 14-Mar-2004, 2-May-2004
11 9
12Abstract
13========
14 10
15The `Gentoo web site`_ is the main source of documentation regarding 11Abstract:
16Gentoo itself. It hosts all documents that the `Gentoo Documentation 12=========
17Project`_ delivers, including all made translations.
18 13
19.. _Gentoo web site: http://www.gentoo.org 14The Gentoo Website [#gentoo]_ is the main source of documentation regarding
20.. _Gentoo Documentation Project: http://www.gentoo.org/proj/en/gdp 15Gentoo itself. It hosts all documents that the Gentoo Documentation Project
16[#gdp]_ delivers, including all made translations. In addition the website
17contains the GWN and its translations and several news items.
21 18
22This GLEP proposes some changes regarding the documentation
23so that we can provide our international users with information regarding
24Gentoo Communities, as proposed by `Bug #23199`_.
25 19
26.. _Bug #23199: http://bugs.gentoo.org/show_bug.cgi?id=23199 20Motivation:
21===========
27 22
28Motivation 23Lots of people have shown interest in the localization proposal, and
24even the infrastructure team has given positive feedback. However, due
25to lack of a good roadmap and proposal this suggestion has never grown
26beyond what it is now: a suggestion. Between the first draft of this
27proposal and now some communities grown faster than others. Actually it
28is obvious that we have big communities (lots of users, lots of
29translators) and smaller communities (less users, less translators). If
30we speak about localized Gentoo sites we need to find a capable
31solution for small and even bigger communities. This leads us to a
32point where the lead translator can decide between a small localized
33site including necessarily translated documents and only some
34additional pages and a bigger variant with lots of translated gdp
35documents, translated news and gwn plus additional pages.
36
37
38Rationale:
29========== 39==========
30 40
31Lots of people have shown interest in the localization proposal, 41The current layout regarding documentation in the CVS is as follows:
32and even the infrastructure team has given positive feedback. However, 42
33due to lack of a good roadmap and proposal this suggestion has never 43 [gentoo]/xml/htdocs/doc/en/*
34grown beyond what it is now: a suggestion. 44 [gentoo]/xml/htdocs/doc/nl/*
45 [gentoo]/xml/htdocs/doc/fr/*
35 46
36The current CVS structure (and permissions) are insufficient to implement a 47However, there are several other documents (about, policy, etc) in
37localized section for each possible country. The current permissions are to 48main/$lang:
38broad while they should be very strict, the current layout is too fragmented
39while it should be grouped together.
40 49
41Rationale
42=========
43
44The current layout regarding documentation in the CVS is as follows::
45
46 [gentoo]/xml/htdocs/doc/en/*
47 [gentoo]/xml/htdocs/doc/nl/*
48 [gentoo]/xml/htdocs/doc/fr/*
49 ...
50
51However, the documentation index page itself (and several other
52important parts of the Gentoo website) are structed like this::
53
54 [gentoo]/xml/htdocs/main/en/* 50 [gentoo]/xml/htdocs/main/en/*
55 [gentoo]/xml/htdocs/main/nl/* 51 [gentoo]/xml/htdocs/main/nl/*
56 [gentoo]/xml/htdocs/main/fr/* 52 [gentoo]/xml/htdocs/main/fr/*
57 ...
58 53
59This structure makes it very difficult for assigning permissions to the 54This structure makes it very difficult for assigning permissions to the
60individual translation teams, and even more difficult to really localise 55individual translation teams, and even more difficult to really localize
61the Gentoo Website. At this very moment, the translation teams can edit 56the Gentoo Website. At this very moment, the translation teams can edit
62documents of other languages or even the master English documents. English 57documents of other languages or even the master English documents. English
63reviewers and editors can touch documents of languages they possibly don't 58reviewers and editors can touch documents of languages they possibly don't
64even know. Although we do trust every single documentation editor, a better 59even know. Although we do trust every single documentation editor, a better
65implementation is advisable. 60implementation is advisable. We also can't give access to well-known
61but non-dev translators.
66 62
67We want to restructure the current layout so that the Gentoo Website is 63We want to restructure the current layout so that the Gentoo Website is
68more easily internationalized. 64more easily internationalized.
69 65
70Implementation
71==============
72 66
73CVS Structure 67Implementation:
74------------- 68===============
75 69
76What is needed, is a clear distinction between documentation, newsletters, 70Website Pages:
77website and localization. This requires a directory structure in the CVS 71--------------
78repository that reflects this distinction.
79 72
80In the following scheme, everything is relative to [gentoo]/xml/htdocs:: 73The Lead Translator can choose if he wants to maintain a "small" or a
74"big" localized site. All localized sites will be accessible on
75http://$lang.gentoo.org which will point to [gentoo]xml/htdocs/$lang.
76All localized sites must be implemented in GuideXML.
81 77
82 main/en Contains the main Gentoo Website 78Requirements for "small" localized sites:
83 main/${LANGUAGE} Contains some translated website pages 79.........................................
84 main/lcl/${COUNTRYCODE} Contains the localized Gentoo page
85 doc/en Contains the master English Documentation
86 doc/${LANGUAGE} Contains the translated Documentation
87 news/en Contains the English GWNs
88 news/${LANGUAGE} Contains the translated GWNs
89 proj/en Contains the project Webpages
90 80
91In comparison with what is currently the case, there are no big changes. 81 - all documents marked as required in our Translators Howto
92I've explicitly left out `proj/${LANGUAGE}` since there is no direct 82 - $lang/main/translators.xml, listing of all translators (including
93need to translate project websites. If it is desired, then creating a 83 GWN translators)
94language-specific directory is sufficient. 84 - $lang/main/communities.xml, listing of all community sites available in $lang
85 - index.xml "welcome page", listing of available ressources on
86 $lang.gentoo.org (i.e. links to documentation, translators.xml and
87 communities.xml)
95 88
96Website pages 89Requirements for "big" localized sites:
97------------- 90.......................................
98 91
99Currently, the main documentation page is `main/en/docs.xml`. A better 92 - all documents marked as required in our Translators Howto
100implementation would be to have it as `doc/en/index.xml`. This keeps 93 - $lang/main/translators.xml, listing of all translators (including
101everything documentation-related together. It also provides us with 94 GWN translators)
102seperate index pages for each language (`doc/${LANGUAGE}/index.xml`). 95 - $lang/main/communities.xml, listing of all community sites available in $lang
103 96 - translated $lang/main documents
104The documentation indexes should mention the other indexes (for other 97 - translated $lang/news/gwn
105languages), but shouldn't have seperate links for each language per 98 - translated news items ($lang/news) (only translated news items,
106document. 99 news items on a per-lang basis aren't allowed)
107
108The localization page resides in `main/${COUNTRYCODE}/index.xml`. This
109page, which is formatted the same way as the whole Gentoo website,
110**only** contains the following information::
111
112 - A list of community websites [1]_
113
114 - A link to the translated documentation index
115
116 - A link to translated Gentoo-webpages::
117
118 * About
119
120 * Social Contract
121
122 * Gentoo Weekly News
123
124If the localization team wants, this can be extended to also provide
125news-items (such as with the main Gentoo website). In this case, the
126news items also reside in `main/lcl/${COUNTRYCODE}`.
127
128Also, `http://${COUNTRYCODE}.gentoo.org` should point to
129`main/lcl/${COUNTRYCODE}/index.xml`.
130
131CVS Permissions
132---------------
133
134The permissions are now clear and distinct::
135
136 - Documentation Developers cannot touch the Gentoo website,
137 except for the Index page, which now resides in `doc/en`.
138
139 - Translators can only touch files in `doc/${LANGUAGE}` and
140 `main/${LANGUAGE}`.
141
142 - The localized pages, which are rather static (since they only
143 contain a list of community sites), are maintained by a
144 single group for all countrycodes, unless the localization
145 pages also contain newsitems, in which case seperate groups
146 for each country can exist.
147 100
148 101
149References 102CVS Structure:
150========== 103--------------
151 104
152.. [1] A sum of such community sites can be found at 105Actual scheme, everything is relative to [gentoo]/xml/htdocs::
153 http://dev.gentoo.org/~liquidx/communities.html
154 106
155Copyright 107 main/en Contains the main Gentoo Website (about, policy, lists, etc.)
156========= 108 main/$lang Contains some translated Website pages
109 doc/en Contains the master English Documentation
110 doc/$lang Contains the translated Documentation
111 news Contains English news items
112 news/en/gwn Contains the master English GWNs
113 news/$lang/gwn Contains translated GWNs
114 proj/en Contains the project Webpages
157 115
158This document has been placed in the public domain. 116Proposed scheme, relative to [gentoo]/xml/htdocs::
117
118 $lang/main Contains some translated Website pages
119 $lang/doc Contains the translated Documentation
120 $lang/news Contains translated news items
121 $lang/news/gwn Contains translated GWNs
122
123Mail:
124-----
125
126All mails to www-$lang@gentoo.org should be forwarded to the Lead
127Translator and his Follow-Up.
128
129
130XSL:
131----
132
133We need to "hack" our guide.xsl to support something like inserts.xml for the
134whole site.
135
136
137
138.. [#gentoo] http://www.gentoo.org
139.. [#gdp] http://gdp.gentoo.org
140

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

  ViewVC Help
Powered by ViewVC 1.1.20