launchpad-dev team mailing list archive

[Jeroen Vermeulen <jtv@xxxxxxxxxxxxx>]

Matthew Revell wrote:

More pedantry on demand!

> https://help.launchpad.net/Translations/YourProject/ImportingTranslations/Draft


You start out by saying there are two ways to import translations, then 
for the first of those you say there are two ways of doing _that_, and 
you end up sounding like Von Clausewitz(*).

How about just mentioning the "one-off import" option right in the first 
section under the two bullet points, without an extra heading?  That 
also means you don't jump straight from the enumeration to the next 
subsection, which always looks a bit like you're trying to simulate an 
index anyway.

Then, under "Naming translation files":

"Place the files in the same directory as the template for which they 
are meant. Each template and its translation files must have its own 
directory. This rules out the first naming option for templates that was 
mentioned above."

This looks like a dazed survivor of a text refactoring.  How about:

"Place each PO file in the same directory as the template it translates. 
 Remember that each template should have its own directory."

This also looks like a good place to mention the rules on language 
codes: 2-letter codes where possible (and 3-letter codes otherwise), 
leave out redundant country codes, and generally avoid country codes 
wherever possible.  A slightly more extensive example here would work 
wonders--just the usual listing of two templates with a bunch of 
translations each.


Jeroen

* Carl von Clausewitz.  Read his work someday, if only for his 
edifying--yawn--writing style.  I hear he was brilliant in his analysis 
but I just couldn't stand reading the stuff.