Re: [RFR] wml://international/l10n/pseudo-urls.wml
David Prévot wrote:
[...]
> <p>
> The <i>state</i> can be one of the following: TAF, ITT, RFR, LCFC,
> BTS#<bug number> or DONE.
> </p>
In fact it *must* be one of (or perhaps "can be any of") the following.
Are we going for en_US here? If so it probably ought to have a comma
before the "or" (that style is also used below).
[...]
> <li>ITT (Intent To Translate)
> <ul>
> <li>Sent to indicate that you plan to work on the translation, used to
> avoid double work.</li>
> </ul>
That's a run-on sentence; s/,/;/, or perhaps s/used //.
> </li>
> <li>RFR (Request For Review)
> <ul>
> <li>Initial translation is done and, attached to the mail, others on
> the list can then go over it to check for errors.</li>
> <li>Possibly followed by other RFR when substantial changes have been
> made.</li>
> <li>NOTE: send a reply, eventually off-list if you checked it and found
> no flaws.</li>
"Eventually" is a false friend - you mean "possibly". But should I
send a reply on-list if I didn't check it? What *point* is this NOTE
making? I would suggest reorganising these three bulletpoints to
<li>An initial draft translation is attached. Others on the list are
requested to check it for errors and send a reply (possibly
off-list if they found no flaws).</li>
<li>Further RFRs may follow if substantial changes have been made.</li>
> </ul>
> </li>
> <li>ITR (Intent To Review)
> <ul>
> <li>Used to avoid LCFC's being sent when there are pending reviews
> out.</li>
Out? Say "while there are reviews pending", or maybe "while reviewers
are still at work".
> <li>Mainly used when you expect your review not to be ready for several
> days (because the translation is big, or you don't have any time
> before the weekend, etc.)</li>
> <li>Mail body should contain an indication of when to expect the
> review.</li>
Insert definite article.
> <li><b>NOTE</b>: Not parsed by the spider.</li>
Every bulletpoint could start with "Note:", and I don't see why this
one particularly deserves a shouty bold introduction. Besides, if
the spider ignores ITRs, surely that means it's parsing them as
no-ops rather than syntax errors? Make it
<li>Note that ITRs are ignored by the spider.</li>
> </ul>
> </li>
> <li>LCFC (Last Chance For Comment)
> <ul>
> <li>Indicates that translation is done, change from the review process
> have been incorporated, and translation will be send to the
> appropriate place.</li>
<li>Indicates that the translation is finished, with changes from the
review process incorporated, and that it will be sent to the
appropriate place.</li>
(I'm not keen on "ended for a few days" below, but I can't think of
anything better.)
> <li>Can be sent when there are no ITR's, and discussion following the
> last RFR has ended for a few days.</li>
> <li>Should not be sent before there has been at least one review.</li>
> </ul>
> </li>
> <li>BTS#<bug number> (Bug Tracking System)
> <ul>
> <li>Used to register a bug number once you submitted the translation to
> the BTS.</li>
> <li>Regularly the spider will check if an open bug report has been
> fixed or closed.</li>
<li>Used to register a bug number once you have submitted the translation to
the BTS.</li>
<li>The spider will regularly check if an open bug report has been
fixed or closed.</li>
> </ul>
> </li>
> <li>DONE
> <ul>
> <li>Used to close a thread once the translation has been taken into
> account, useful if it has not been sent to the BTS.</li>
"Taken into account" isn't right, but I'm not sure what is. We can't
just say "accepted" or whatever, because a justified refusal counts
too; how about "dealt with"? (And promote comma to semicolon.)
> </ul>
> </li>
> <li>HOLD
> <ul>
> <li>Used to put a translation on hold, when the original version has
> changed but there is no need to update the translation, e.g. you
> know other modifications will be done soon on the original and
> you don't want someone to update the translation too quickly.</li>
> </ul>
That "e.g." is hardly an example - it's just a paraphrase of the
general description. Or possibly even a contradiction; the first
version implies there's no work to be done, the second implies there's
work to be done but it would be wasted effort. Maybe:
<li>Used to put a translation on hold, when the original version has
changed or is about to change and any work done on updates now is
likely to be wasted.</li>
> </li>
> </ul>
>
> <p>
> The <i>type</i> can be anything indicating the type of the document, e.g.:
> po-debconf, debian-installer, po, po4a, or wml.
> </p>
s/e.g.:/such as /
>
> <p>
> <i>package</i> is the name of the package where the document comes from.
Probably s/where/that/
> Please use <i>www.debian.org</i> or nothing for the WML files of the
> Debian web site.
> </p>
>
> <p>
> <i>file</i> is the filename of the document, it can contain other information
s/,/;/
> such as the path to the file so no other
> document in the same package should be referred the same.
I don't quite understand that. Is it saying:
<i>file</i> is the filename of the document; it may contain other information
to uniquely identify the document such as the path to the file.
> It's usually a name like <i>lc</i>.po where <i>lc</i> is the language code
> (e.g.: de for German, or pt_BR for Brazilian Portuguese).
> </p>
>
> <p>
> The structure of <i>file</i> depends on the chosen type, and of course the
> language.
> In principle it's just an identifier, but it's strongly recommended to follow
> the following rules, since it's used to update page status of this section.
> </p>
What "following rules"? And what does "page status of this section"
mean? Maybe something like:
In principle it's just an identifier, but since it's used to track page
status it's strongly recommended to follow the scheme given below.
> <ul>
> <li><code>po-debconf://package-name/lc.po</code></li>
> <li><code>po://package-name/path-in-sourcepackage/lc.po</code></li>
> <li><code>debian-installer://package-name/path-in-sourcepackage/lc.po</code></li>
> <li><code>wml://path_under_language_name_in_CVS</code></li>
> <li><code>po4a://package-name/path-in-sourcepackage/lc.po</code></li>
> </ul>
>
> <p>
> The state BTS is somewhat special, it used to register a bug number so the
s/,/;/
Is that "is used to" with a missing "is", or "it used to" with a
missing explanation of how things have changed?
> l10n-bot can track the status of the translation once submitted to
> the BTS: it will check if any of the open bug reports have been
> closed. An example of this command is (for the debian-l10n-spanish list):
How is it a "command"?
Guessing that it's "is used", I would suggest:
The "BTS" state is somewhat special; it registers a bug number so the
l10n-bot can track the status of the translation once submitted to
the BTS by checking whether any of the open bug reports have been
closed. Thus for instance the debian-l10n-spanish list might use:
> </p>
> <div class="center"><code>[BTS#123456] po-debconf://cupsys/es.po</code></div>
(Stale example alert: s/cupsys/cups/ here and below)
>
> <p>
> If you have the intent to translate a lot of packages, you can ITT them all
> at ones. An example (for the debian-l10n-danish list):
> </p>
If you intend to translate a lot of packages, you can ITT them all
at once. An example (for the debian-l10n-danish list):
> <div class="center"><code>[ITT] po-debconf://{cupsys,courier,apache2}/da.po</code></div>
> <p>
> So put the packages between curly braces and separate them with comma's. No
> extra spaces!
> </p>
In en_US that's just "braces", and we can see they're curly.
No apostrophe in "commas".
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
--- pseudo-urls.wml.old 2012-08-11 09:43:29.604733792 +0100
+++ pseudo-urls.wml.new 2012-08-11 09:44:23.892411634 +0100
@@ -11,8 +11,8 @@
<div class="center"><code>[<state>] <type>://<package>/<file></code></div>
<p>
-The <i>state</i> can be one of the following: TAF, ITT, RFR, LCFC,
-BTS#<bug number> or DONE.
+The <i>state</i> must be one of the following: TAF, ITT, RFR, LCFC,
+BTS#<bug number>, or DONE.
</p>
@@ -31,30 +31,27 @@
</li>
<li>ITT (Intent To Translate)
<ul>
- <li>Sent to indicate that you plan to work on the translation, used to
+ <li>Sent to indicate that you plan to work on the translation; used to
avoid double work.</li>
</ul>
</li>
<li>RFR (Request For Review)
<ul>
- <li>Initial translation is done and, attached to the mail, others on
- the list can then go over it to check for errors.</li>
- <li>Possibly followed by other RFR when substantial changes have been
- made.</li>
- <li>NOTE: send a reply, eventually off-list if you checked it and found
- no flaws.</li>
+ <li>An initial draft translation is attached. Others on the list are
+ requested to check it for errors and send a reply (possibly
+ off-list if they found no flaws).</li>
+ <li>Further RFRs may follow if substantial changes have been made.</li>
</ul>
</li>
<li>ITR (Intent To Review)
<ul>
- <li>Used to avoid LCFC's being sent when there are pending reviews
- out.</li>
+ <li>Used to avoid LCFC's being sent when there are reviews pending.</li>
<li>Mainly used when you expect your review not to be ready for several
days (because the translation is big, or you don't have any time
before the weekend, etc.)</li>
- <li>Mail body should contain an indication of when to expect the
+ <li>The mail body should contain an indication of when to expect the
review.</li>
- <li><b>NOTE</b>: Not parsed by the spider.</li>
+ <li>Note that ITRs are ignored by the spider.</li>
</ul>
</li>
<li>LCFC (Last Chance For Comment)
@@ -69,43 +66,41 @@
</li>
<li>BTS#<bug number> (Bug Tracking System)
<ul>
- <li>Used to register a bug number once you submitted the translation to
+ <li>Used to register a bug number once you have submitted the translation to
the BTS.</li>
- <li>Regularly the spider will check if an open bug report has been
+ <li>The spider will regularly check if an open bug report has been
fixed or closed.</li>
</ul>
</li>
<li>DONE
<ul>
- <li>Used to close a thread once the translation has been taken into
- account, useful if it has not been sent to the BTS.</li>
+ <li>Used to close a thread once the translation has been dealt with;
+ useful if it has not been sent to the BTS.</li>
</ul>
</li>
<li>HOLD
<ul>
<li>Used to put a translation on hold, when the original version has
- changed but there is no need to update the translation, e.g. you
- know other modifications will be done soon on the original and
- you don't want someone to update the translation too quickly.</li>
+ changed or is about to change and any work done on updates now is
+ likely to be wasted.</li>
</ul>
</li>
</ul>
<p>
-The <i>type</i> can be anything indicating the type of the document, e.g.:
+The <i>type</i> can be anything indicating the type of the document, such as
po-debconf, debian-installer, po, po4a, or wml.
</p>
<p>
-<i>package</i> is the name of the package where the document comes from.
+<i>package</i> is the name of the package that the document comes from.
Please use <i>www.debian.org</i> or nothing for the WML files of the
Debian web site.
</p>
<p>
-<i>file</i> is the filename of the document, it can contain other information
-such as the path to the file so no other
-document in the same package should be referred the same.
+<i>file</i> is the filename of the document; it can contain other information
+to uniquely identify the document such as the path to the file.
It's usually a name like <i>lc</i>.po where <i>lc</i> is the language code
(e.g.: de for German, or pt_BR for Brazilian Portuguese).
</p>
@@ -113,8 +108,8 @@
<p>
The structure of <i>file</i> depends on the chosen type, and of course the
language.
-In principle it's just an identifier, but it's strongly recommended to follow
-the following rules, since it's used to update page status of this section.
+In principle it's just an identifier, but since it's used to track page
+status it's strongly recommended to follow the scheme given below.
</p>
<ul>
@@ -126,19 +121,19 @@
</ul>
<p>
-The state BTS is somewhat special, it used to register a bug number so the
+The "BTS" state is somewhat special; it registers a bug number so the
l10n-bot can track the status of the translation once submitted to
-the BTS: it will check if any of the open bug reports have been
-closed. An example of this command is (for the debian-l10n-spanish list):
+the BTS by checking whether any of the open bug reports have been
+closed. Thus for instance the debian-l10n-spanish list might use:
</p>
-<div class="center"><code>[BTS#123456] po-debconf://cupsys/es.po</code></div>
+<div class="center"><code>[BTS#123456] po-debconf://cups/es.po</code></div>
<p>
-If you have the intent to translate a lot of packages, you can ITT them all
-at ones. An example (for the debian-l10n-danish list):
+If you intend to translate a lot of packages, you can ITT them all
+at once. An example (for the debian-l10n-danish list):
</p>
-<div class="center"><code>[ITT] po-debconf://{cupsys,courier,apache2}/da.po</code></div>
+<div class="center"><code>[ITT] po-debconf://{cups,courier,apache2}/da.po</code></div>
<p>
-So put the packages between curly braces and separate them with comma's. No
+So put the packages between braces and separate them with commas. No
extra spaces!
</p>
#use wml::debian::template title="Coordination of l10n teams"
<h1>Pseudo-URLs</h1>
<p>
The program that listens to debian-l10n-* lists understands pseudo-URLs in the
subject header.
The pseudo-URLs need to have the following form.
</p>
<div class="center"><code>[<state>] <type>://<package>/<file></code></div>
<p>
The <i>state</i> must be one of the following: TAF, ITT, RFR, LCFC,
BTS#<bug number>, or DONE.
</p>
<ul>
<li>TAF (<i>Travail À Faire</i>)
<ul>
<li>Sent to indicate that there is a document that needs to be worked
on.</li>
</ul>
</li>
<li>MAJ (<i>Mise À Jour</i>)
<ul>
<li>Sent to indicate that there is a document that needs to be updated
and that the work is reserved for the previous translator.</li>
</ul>
</li>
<li>ITT (Intent To Translate)
<ul>
<li>Sent to indicate that you plan to work on the translation; used to
avoid double work.</li>
</ul>
</li>
<li>RFR (Request For Review)
<ul>
<li>An initial draft translation is attached. Others on the list are
requested to check it for errors and send a reply (possibly
off-list if they found no flaws).</li>
<li>Further RFRs may follow if substantial changes have been made.</li>
</ul>
</li>
<li>ITR (Intent To Review)
<ul>
<li>Used to avoid LCFC's being sent when there are reviews pending.</li>
<li>Mainly used when you expect your review not to be ready for several
days (because the translation is big, or you don't have any time
before the weekend, etc.)</li>
<li>The mail body should contain an indication of when to expect the
review.</li>
<li>Note that ITRs are ignored by the spider.</li>
</ul>
</li>
<li>LCFC (Last Chance For Comment)
<ul>
<li>Indicates that translation is done, change from the review process
have been incorporated, and translation will be send to the
appropriate place.</li>
<li>Can be sent when there are no ITR's, and discussion following the
last RFR has ended for a few days.</li>
<li>Should not be sent before there has been at least one review.</li>
</ul>
</li>
<li>BTS#<bug number> (Bug Tracking System)
<ul>
<li>Used to register a bug number once you have submitted the translation to
the BTS.</li>
<li>The spider will regularly check if an open bug report has been
fixed or closed.</li>
</ul>
</li>
<li>DONE
<ul>
<li>Used to close a thread once the translation has been dealt with;
useful if it has not been sent to the BTS.</li>
</ul>
</li>
<li>HOLD
<ul>
<li>Used to put a translation on hold, when the original version has
changed or is about to change and any work done on updates now is
likely to be wasted.</li>
</ul>
</li>
</ul>
<p>
The <i>type</i> can be anything indicating the type of the document, such as
po-debconf, debian-installer, po, po4a, or wml.
</p>
<p>
<i>package</i> is the name of the package that the document comes from.
Please use <i>www.debian.org</i> or nothing for the WML files of the
Debian web site.
</p>
<p>
<i>file</i> is the filename of the document; it can contain other information
to uniquely identify the document such as the path to the file.
It's usually a name like <i>lc</i>.po where <i>lc</i> is the language code
(e.g.: de for German, or pt_BR for Brazilian Portuguese).
</p>
<p>
The structure of <i>file</i> depends on the chosen type, and of course the
language.
In principle it's just an identifier, but since it's used to track page
status it's strongly recommended to follow the scheme given below.
</p>
<ul>
<li><code>po-debconf://package-name/lc.po</code></li>
<li><code>po://package-name/path-in-sourcepackage/lc.po</code></li>
<li><code>debian-installer://package-name/path-in-sourcepackage/lc.po</code></li>
<li><code>wml://path_under_language_name_in_CVS</code></li>
<li><code>po4a://package-name/path-in-sourcepackage/lc.po</code></li>
</ul>
<p>
The "BTS" state is somewhat special; it registers a bug number so the
l10n-bot can track the status of the translation once submitted to
the BTS by checking whether any of the open bug reports have been
closed. Thus for instance the debian-l10n-spanish list might use:
</p>
<div class="center"><code>[BTS#123456] po-debconf://cups/es.po</code></div>
<p>
If you intend to translate a lot of packages, you can ITT them all
at once. An example (for the debian-l10n-danish list):
</p>
<div class="center"><code>[ITT] po-debconf://{cups,courier,apache2}/da.po</code></div>
<p>
So put the packages between braces and separate them with commas. No
extra spaces!
</p>
Reply to: