cc_staff
82
edits
Authoring guidelines: Difference between revisions
m
fix heading levels
(add write the docs resource) |
m (fix heading levels) |
||
| Line 66: | Line 66: | ||
There are multiple [[Special:UncategorizedTemplates|templates]] available. Please use them as appropriate. Of particular interest are templates for [[Including a command within the wiki]] and for [[Including a source code file within the wiki]]. | There are multiple [[Special:UncategorizedTemplates|templates]] available. Please use them as appropriate. Of particular interest are templates for [[Including a command within the wiki]] and for [[Including a source code file within the wiki]]. | ||
= Translation = <!--T:6--> | ==Translation== <!--T:6--> | ||
<!--T:7--> | <!--T:7--> | ||
| Line 74: | Line 74: | ||
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. | 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 ?== <!--T:9--> | ===How does one mark a new page for translation ?=== <!--T:9--> | ||
When you have written a page, you should tag it for translation. Here are the steps to do so: | When you have written a page, you should tag it for translation. Here are the steps to do so: | ||
#Ensure that the content to be translated is enclosed within <translate> </translate> tags. | #Ensure that the content to be translated is enclosed within <translate> </translate> tags. | ||
| Line 85: | Line 85: | ||
#Click on “Mark this version for translation” | #Click on “Mark this version for translation” | ||
==How does one mark changes to a page for translation ?== <!--T:10--> | ===How does one mark changes to a page for translation ?=== <!--T:10--> | ||
First, try to mark a page for translation only once it is stable. | 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-->. You must never manually edit those tags or copy them. Those are automatically generated. | 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-->. You must never manually edit those tags or copy them. Those are automatically generated. | ||
| Line 102: | Line 102: | ||
Note that the "Page translation" page includes a checkbox for "Do not invalidate translations" in each changed unit. You should only select this option if the change is something like a typo - which shouldn't cause the other-language version to need adjustment. | Note that the "Page translation" page includes a checkbox for "Do not invalidate translations" in each changed unit. You should only select this option if the change is something like a typo - which shouldn't cause the other-language version to need adjustment. | ||
== Code blocks are not translated == <!--T:21--> | ===Code blocks are not translated=== <!--T:21--> | ||
Our professional human translator is not a programmer. | Our professional human translator is not a programmer. | ||
They cannot distinguish between code and comments in every possible language, | They cannot distinguish between code and comments in every possible language, | ||
| Line 121: | Line 121: | ||
of the user reading the page in translation. | of the user reading the page in translation. | ||
= "Available software" page = <!--T:16--> | =="Available software" page== <!--T:16--> | ||
<!--T:17--> | <!--T:17--> | ||