Gentoo Archives: gentoo-doc

From: "Jan Kundrát" <jkt@g.o>
To: gentoo-doc@l.g.o
Subject: Re: [gentoo-doc] [RFC] Marking unmaintained documents
Date: Thu, 08 Sep 2005 21:11:44
Message-Id: 4320A8E3.8040305@gentoo.org
In Reply to: Re: [gentoo-doc] [RFC] Marking unmaintained documents by Alexey Chumakov
1 Alexey Chumakov wrote:
2 > After some extensive work with mostly outdated Russian docs, I tend to
3 > agree with Jan--we need some means to signal an outdated translation.
4 >
5 > My proposition is somewhat simpler --
6 >
7 > 1. Let the reader decide if the document is outdated :-)
8 > We'll need to link the derived document to source one, and add a
9 > displayed message:
10 > "Source document is available at [link]
11 > [optional version - fetched from source doc if possible
12 > [optional date]"
13 >
14 > Attr might look like this:
15 > <guide link="/doc/ru/sample.xml" lang="ru" source-link="/doc/en/sample.xml">
16 >
17 > Or, maybe it'll be possible to fetch dependency info from metadoc...
18
19 Well, I asked about something similar (maybe completely different - I
20 don't know XSLT much) - use <uri link="metadoc:file-id"> and
21 automatically select translated file if available. I was told that it is
22 not easy and (iirc) can't be done ATM. Would be great, though :-).
23
24 > 2. It's also useful to introduce some link like "send comments here..."
25 > directly into document, and point it to GDP [internalization] page in
26 > the document's language.
27 > E.g. many Russian readers do not realize easily where to post their bug
28 > reports and suggestions...
29
30 IMHO useless, but I'm not typical Russian reader :-)
31
32 > 3. For unofficial languages, IMHO there is no need to do anything if
33 > there's no index reference to it.
34
35 Well, but what if previously supported language transformes into
36 unsupported one? There will be some links from non-official websites
37 pointing to the outdated translations...
38
39 > And 3rd party articles are already marked :-)
40
41 IIRC, articles themselves are *not* marked, only the index is.
42
43 Cheers,
44 -jkt
45
46
47 --
48 cd /local/pub && more beer > /dev/mouth

Attachments

File name MIME type
signature.asc application/pgp-signature