39,881
edits
Authoring guidelines/en: Difference between revisions
Jump to navigation
Jump to search
Updating to match new version of source page
(Updating to match new version of source page) |
(Updating to match new version of source page) |
||
| Line 62: | Line 62: | ||
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 = | ==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. | 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. | ||
| Line 68: | Line 68: | ||
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 ?== | ===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: | 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 79: | Line 79: | ||
#Click on “Mark this version for translation” | #Click on “Mark this version for translation” | ||
==How does one mark changes to a page 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. | 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 94: | Line 94: | ||
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 == | ===Code blocks are not translated=== | ||
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 111: | Line 111: | ||
of the user reading the page in translation. | of the user reading the page in translation. | ||
= "Available software" page = | =="Available software" page== | ||
Tables on the [[Available software]] page are automatically generated from module files in CVMFS. In order to add a link to a new page from the "Documentation" column of those tables, add an entry to https://github.com/ComputeCanada/wiki_module_bot/blob/main/module_wiki_page.json. Please add this change to the definitive copy of the file. | Tables on the [[Available software]] page are automatically generated from module files in CVMFS. In order to add a link to a new page from the "Documentation" column of those tables, add an entry to https://github.com/ComputeCanada/wiki_module_bot/blob/main/module_wiki_page.json. Please add this change to the definitive copy of the file. | ||
Changes may take six hours to propagate. | Changes may take six hours to propagate. | ||