1,221
edits
Authoring guidelines/en: Difference between revisions
Jump to navigation
Jump to search
Importing a new version from external source
No edit summary |
(Importing a new version from external source) |
||
| Line 20: | Line 20: | ||
* Screen shots are good, especially in how-tos and tutorials. But full-sized screen shots interrupt the structure and flow of the text if they’re placed in-line. Let them float to the right-hand side. Also, scale the image down. If that makes important information unreadable, maybe a cropped picture is better? Or, remind the reader in the caption that they can "Click on the image for a larger version." | * Screen shots are good, especially in how-tos and tutorials. But full-sized screen shots interrupt the structure and flow of the text if they’re placed in-line. Let them float to the right-hand side. Also, scale the image down. If that makes important information unreadable, maybe a cropped picture is better? Or, remind the reader in the caption that they can "Click on the image for a larger version." | ||
* Minimize use of synonyms. Yes, it makes the text less boring, but for a new user or one reading in a second language, interchangeable terms (e.g. "machine", "host", "node", "server") may be confusing. | * Minimize use of synonyms. Yes, it makes the text less boring, but for a new user or one reading in a second language, interchangeable terms (e.g. "machine", "host", "node", "server") may be confusing. | ||
* Leave one blank line at the end of each section before the following header. The translation package uses the blank line and header to determine the boundaries of translation units. | * Leave one blank line at the end of each section before the following header. The translation package uses the blank line and header to determine the boundaries of translation units. | ||
=== Templates === | === Templates === | ||
| Line 27: | Line 27: | ||
= Traduction = | = Traduction = | ||
{{:Page Translation}}. | {{:Page Translation}}. | ||
To translate a page, one first writes the content in the original language. Second, the page is marked for translation. Then, a ''human'' translates the page using organizational tools provided by the wiki extension [https://www.mediawiki.org/wiki/Extension:Translate Translate]. Tutorials for this extension can be found [https://www.mediawiki.org/wiki/Help:Extension:Translate here]. Finally, a second human reviews the translation. If a page has not yet been translated, users can see the page in the original language. If a translation has not yet been reviewed, users can see the non-reviewed translation. | |||
Marking a page for translation will trigger an analysis of the content of the wiki page. The page content will be split by the extension into so-called translation units. Translation units can be a title, a paragraph, an image, etc. These small units can then be translated one by one, ensuring that a modification to a page does not trigger the translation of the whole page. This also allows tracking of what percentage of a page is translated, or outdated. | |||
==How does one mark a new page for translation ?== | |||
When you have written a page, you should tag it for translation. Here are the steps to do so: | |||
#Ensure that the wiki code to be translated is enclosed within <translate> </translate> tags. | |||
#Ensure that the tag <languages /> appear at the very top of the page. This will show a box | |||
#Go in “View” mode, and then click on the “Mark this page for translation” | |||
#Review the translation units. | |||
##Try to ensure that no wiki code (tables, tags, etc) gets translated. This can be done by breaking the page in multiple <translate> </translate> sections. | |||
#In the “Priority languages” section, write either “fr” or “en” as the priority language, that is, the language into which it needs to be translated. | |||
#Click on “Mark this version for translation” | |||
==How does one mark changes to a page for translation ?== | |||
First, try to mark a page for translation only once it is stable. | |||
Second, if you do have to make a change to a page that has been translated, make sure you do NOT change the tags of the form <!--T:3-->. Those are automatically generated. | |||
Once you have done your edits, you can mark the changes to be translated by doing the following : | |||
#Ensure that the new text to be translated is enclosed within <translate> </translate> tags. | |||
#Go in “View” mode. You should see the text “This page has changes since it was last marked for translation.” at the top of the page. Click on “marked for translation”. | |||
#Review the translation units. | |||
##Try to ensure that no wiki code (tables, tags, etc) gets translated. This can be done by breaking the page in multiple <translate> </translate> sections. | |||
#In the “Priority languages” section, write either “fr” or “en” as the priority language, that is, the language into which it needs to be translated. | |||
#Click on “Mark this version for translation” | |||