TechDocs/Mainpage/Translations/Styleguide

English Rules

General

  1. Public holidays, also self-created holidays should be written in upper case. E.g. I Love Free Software Day.

  2. Choose carefully between "like" and "want." "Like" (as a verb, and there are other uses) means to be pleased by something or enjoy doing something, or to be attracted to a person. "Want" (in its most common meaning) means to desire something that one does not have. Sometimes the same thing is both liked and wanted. But often one verb or the other is the better choice. "Want" can also mean simply to lack something, without necessarily desiring it. (This is a less common usage.)

  3. Oxford comma. Use the Oxford comma wherever possible.
    For example: a) Do not use it in the dedication "To my father, Barack Obama and Donald Trump." A comma after "Obama" would look as though I were claiming him as my parent. b) Do use it in the dedication "To my parents, Barack Obama, and Donald Trump." Without the comma after "Obama" it would look as though I were claiming "Obama" and "Trump" are my parents.

  4. Be careful when copying and pasting text. When you copy text from one document to another, try to be sure that what is being inserted is consistent with what it is joining. There are many grammatical (such as tense and number) and stylistic ways in which the texts may clash. Be particularly careful when transplanting text of less than full sentences into a different document.

  5. Try to assure that when a link is provided there are spaces around it between it and the surrounding punctuation, even if strict propriety would say that there should be no space there. If a reader copies the link, there is a danger that without the technically improper space the reader would copy the punctuation as part of the link.

British English vs. American English

  1. British English to be used as general rule. The noun "licence" (verb and derivatives must be always "license") is to be used if inside a news item, but not when used related to a more "international" project (such as REUSE, where US spelling "license" should be used). When it appears as a part of the licence name (e.g. GNU General Public License) or inside the title of a conference/external page, it should be left untouched.

Italian Rules

General

  1. Capitals should be used when referring to a name of a project, such as Software Libero (Free Software), Standard Aperti (Open Standards). Preposition or other ancillary words should not be capitalised, as in Libertà del Router (Router Freedom).

  2. License names should be left untouched (e.g. GNU General Public License).

  3. Put under double quotes when translating the title of a campaign or other titles (e.g. I Love Free Software Day => giornata "Io amo il Software Libero").

  4. Oxford comma: use it only when the "e" conjunction is ambiguous or when you want to put a pause, e.g.:

    • Amo moltissimo i miei genitori, Sandra Mondaini e Raimondo Vianello (wrong if Sandra and Raimondo are not your parents)
      Amo moltissimo i miei genitori, Sandra Mondaini, e Raimondo Vianello (right)

    • «Raccomando a tutti di combattere per i propri diritti» dice Paolo Rossi, e non possiamo che essere totalmente d'accordo
  5. When citing text, if in the English version the text is placed under double quotes ("), replace them with typographical left/right double angle quotation marks (« »).

  6. Avoid suspensive dash at the end of the sentence, and replace it with a comma or colon, e.g. "Here you find the ones who are working for and with the FSFE and have been given permanent responsibility or authority for certain areas - staffers and volunteers" => "Puoi trovare qui le persone che lavorano per e con la FSFE a cui sono state date responsabilità o autorità permanenti in certe aree: i membri dello staff e i volontari".

  7. Opposite to English rules, full stop should be placed outside quotes, e.g.:

    • Scegli accuratamente tra "mi piace" e "voglio".

TechDocs/Mainpage/Translations/Styleguide (last edited 2021-05-26 15:25:39 by lucabon)