| 1 |
g2boojum |
1.1 |
GLEP: 10
|
| 2 |
g2boojum |
1.2 |
Title: Localization for Gentoo Community
|
| 3 |
|
|
Version: $Revision: 1.1 $
|
| 4 |
|
|
Last-Modified: $Date: 2003/08/04 18:03:54 $
|
| 5 |
g2boojum |
1.1 |
Author: Sven Vermeulen <swift@gentoo.org>
|
| 6 |
|
|
Status: Draft
|
| 7 |
|
|
Type: Standards Track
|
| 8 |
|
|
Content-Type: text/x-rst
|
| 9 |
|
|
Created: 4 Aug 2003
|
| 10 |
g2boojum |
1.2 |
Post-History: 4-Aug-2003, 22-Aug-2003
|
| 11 |
g2boojum |
1.1 |
|
| 12 |
|
|
Abstract
|
| 13 |
|
|
========
|
| 14 |
|
|
|
| 15 |
|
|
The `Gentoo web site`_ is the main source of documentation regarding
|
| 16 |
|
|
Gentoo itself. It hosts all documents that the `Gentoo Documentation
|
| 17 |
|
|
Project`_ delivers, including all made translations.
|
| 18 |
|
|
|
| 19 |
|
|
.. _Gentoo web site: http://www.gentoo.org
|
| 20 |
|
|
.. _Gentoo Documentation Project: http://www.gentoo.org/proj/en/gdp
|
| 21 |
|
|
|
| 22 |
g2boojum |
1.2 |
This GLEP proposes some changes regarding the documentation
|
| 23 |
|
|
so that we can provide our international users with information regarding
|
| 24 |
|
|
Gentoo Communities, as proposed by `Bug #23199`_.
|
| 25 |
g2boojum |
1.1 |
|
| 26 |
|
|
.. _Bug #23199: http://bugs.gentoo.org/show_bug.cgi?id=23199
|
| 27 |
|
|
|
| 28 |
|
|
Motivation
|
| 29 |
|
|
==========
|
| 30 |
|
|
|
| 31 |
g2boojum |
1.2 |
Lots of people have shown interest in the localization proposal,
|
| 32 |
g2boojum |
1.1 |
and even the infrastructure team has given positive feedback. However,
|
| 33 |
|
|
due to lack of a good roadmap and proposal this suggestion has never
|
| 34 |
|
|
grown beyond what it is now: a suggestion.
|
| 35 |
|
|
|
| 36 |
g2boojum |
1.2 |
The current CVS structure (and permissions) are insufficient to implement a
|
| 37 |
|
|
localized section for each possible country. The current permissions are to
|
| 38 |
|
|
broad while they should be very strict, the current layout is too fragmented
|
| 39 |
|
|
while it should be grouped together.
|
| 40 |
g2boojum |
1.1 |
|
| 41 |
|
|
Rationale
|
| 42 |
|
|
=========
|
| 43 |
|
|
|
| 44 |
|
|
The 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 |
|
|
|
| 51 |
|
|
However, the documentation index page itself (and several other
|
| 52 |
|
|
important parts of the Gentoo website) are structed like this::
|
| 53 |
|
|
|
| 54 |
|
|
[gentoo]/xml/htdocs/main/en/*
|
| 55 |
|
|
[gentoo]/xml/htdocs/main/nl/*
|
| 56 |
|
|
[gentoo]/xml/htdocs/main/fr/*
|
| 57 |
|
|
...
|
| 58 |
|
|
|
| 59 |
|
|
This structure makes it very difficult for assigning permissions to the
|
| 60 |
|
|
individual translation teams, and even more difficult to really localise
|
| 61 |
|
|
the Gentoo Website. At this very moment, the translation teams can edit
|
| 62 |
|
|
documents of other languages or even the master English documents. English
|
| 63 |
|
|
reviewers and editors can touch documents of languages they possibly don't
|
| 64 |
|
|
even know. Although we do trust every single documentation editor, a better
|
| 65 |
|
|
implementation is advisable.
|
| 66 |
|
|
|
| 67 |
|
|
We want to restructure the current layout so that the Gentoo Website is
|
| 68 |
|
|
more easily internationalized.
|
| 69 |
|
|
|
| 70 |
|
|
Implementation
|
| 71 |
|
|
==============
|
| 72 |
|
|
|
| 73 |
|
|
CVS Structure
|
| 74 |
|
|
-------------
|
| 75 |
|
|
|
| 76 |
g2boojum |
1.2 |
What is needed, is a clear distinction between documentation, newsletters,
|
| 77 |
|
|
website and localization. This requires a directory structure in the CVS
|
| 78 |
|
|
repository that reflects this distinction.
|
| 79 |
|
|
|
| 80 |
|
|
In the following scheme, everything is relative to [gentoo]/xml/htdocs::
|
| 81 |
|
|
|
| 82 |
|
|
main/en Contains the main Gentoo Website
|
| 83 |
|
|
main/${LANGUAGE} Contains some translated website pages
|
| 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 |
|
|
|
| 91 |
|
|
In comparison with what is currently the case, there are no big changes.
|
| 92 |
|
|
I've explicitly left out `proj/${LANGUAGE}` since there is no direct
|
| 93 |
|
|
need to translate project websites. If it is desired, then creating a
|
| 94 |
|
|
language-specific directory is sufficient.
|
| 95 |
g2boojum |
1.1 |
|
| 96 |
g2boojum |
1.2 |
Website pages
|
| 97 |
|
|
-------------
|
| 98 |
|
|
|
| 99 |
|
|
Currently, the main documentation page is `main/en/docs.xml`. A better
|
| 100 |
|
|
implementation would be to have it as `doc/en/index.xml`. This keeps
|
| 101 |
|
|
everything documentation-related together. It also provides us with
|
| 102 |
|
|
seperate index pages for each language (`doc/${LANGUAGE}/index.xml`).
|
| 103 |
|
|
|
| 104 |
|
|
The documentation indexes should mention the other indexes (for other
|
| 105 |
|
|
languages), but shouldn't have seperate links for each language per
|
| 106 |
|
|
document.
|
| 107 |
|
|
|
| 108 |
|
|
The localization page resides in `main/${COUNTRYCODE}/index.xml`. This
|
| 109 |
|
|
page, 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 |
|
|
|
| 124 |
|
|
If the localization team wants, this can be extended to also provide
|
| 125 |
|
|
news-items (such as with the main Gentoo website). In this case, the
|
| 126 |
|
|
news items also reside in `main/lcl/${COUNTRYCODE}`.
|
| 127 |
|
|
|
| 128 |
|
|
Also, `http://${COUNTRYCODE}.gentoo.org` should point to
|
| 129 |
|
|
`main/lcl/${COUNTRYCODE}/index.xml`.
|
| 130 |
|
|
|
| 131 |
|
|
CVS Permissions
|
| 132 |
|
|
---------------
|
| 133 |
|
|
|
| 134 |
|
|
The 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 |
g2boojum |
1.1 |
|
| 139 |
g2boojum |
1.2 |
- Translators can only touch files in `doc/${LANGUAGE}` and
|
| 140 |
|
|
`main/${LANGUAGE}`.
|
| 141 |
g2boojum |
1.1 |
|
| 142 |
g2boojum |
1.2 |
- 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 |
g2boojum |
1.1 |
|
| 148 |
|
|
|
| 149 |
|
|
References
|
| 150 |
|
|
==========
|
| 151 |
|
|
|
| 152 |
|
|
.. [1] A sum of such community sites can be found at
|
| 153 |
|
|
http://dev.gentoo.org/~liquidx/communities.html
|
| 154 |
|
|
|
| 155 |
|
|
Copyright
|
| 156 |
|
|
=========
|
| 157 |
|
|
|
| 158 |
|
|
This document has been placed in the public domain.
|
Parent Directory
| 
Revision Log