| 1 |
Hi GDPers, |
| 2 |
|
| 3 |
Xavier Neys wrote: |
| 4 |
> Jan Kundrát wrote: |
| 5 |
> |
| 6 |
>> Hi GDP-related entities, |
| 7 |
>> as promised on IRC, here are my ideas about $SUBJECT. |
| 8 |
>> |
| 9 |
>> Currently we have quite a lot of "unsupported"/"invalid"/"unmaintained" |
| 10 |
>> documents for one of these reasons: |
| 11 |
>> |
| 12 |
>> a) Third party article |
| 13 |
>> b) Older Handbook |
| 14 |
>> c) Translation in language which is not officially supported |
| 15 |
>> d) Outdated translation |
| 16 |
[...] |
| 17 |
|
| 18 |
After some extensive work with mostly outdated Russian docs, I tend to |
| 19 |
agree with Jan--we need some means to signal an outdated translation. |
| 20 |
|
| 21 |
My proposition is somewhat simpler -- |
| 22 |
|
| 23 |
1. Let the reader decide if the document is outdated :-) |
| 24 |
We'll need to link the derived document to source one, and add a |
| 25 |
displayed message: |
| 26 |
"Source document is available at [link] |
| 27 |
[optional version - fetched from source doc if possible |
| 28 |
[optional date]" |
| 29 |
|
| 30 |
Attr might look like this: |
| 31 |
<guide link="/doc/ru/sample.xml" lang="ru" source-link="/doc/en/sample.xml"> |
| 32 |
|
| 33 |
Or, maybe it'll be possible to fetch dependency info from metadoc... |
| 34 |
|
| 35 |
2. It's also useful to introduce some link like "send comments here..." |
| 36 |
directly into document, and point it to GDP [internalization] page in |
| 37 |
the document's language. |
| 38 |
E.g. many Russian readers do not realize easily where to post their bug |
| 39 |
reports and suggestions... |
| 40 |
|
| 41 |
3. For unofficial languages, IMHO there is no need to do anything if |
| 42 |
there's no index reference to it. |
| 43 |
And 3rd party articles are already marked :-) |
| 44 |
|
| 45 |
How do you like this idea? |
| 46 |
|
| 47 |
|
| 48 |
WKR, |
| 49 |
Alexey Chumakov |
| 50 |
-- |
| 51 |
gentoo-doc@g.o mailing list |
Archives