Wiki Translation Infrastructure - Revision history

Vadi: /* How it Works */

2020-07-05T06:50:19Z

How it Works

TheFae: Marked this version for translation

2020-07-05T00:09:27Z

Marked this version for translation

TheFae: more translation markup

2020-07-04T23:57:58Z

more translation markup

TheFae: Add a link, and test translation markup

2020-07-04T23:03:13Z

Add a link, and test translation markup

Vadi: /* Forcing Updates */

2020-06-20T05:58:48Z

Forcing Updates

Vadi: Reverted edits by Vadi (talk) to last revision by TheFae

2020-06-20T05:57:12Z

Reverted edits by Vadi (talk) to last revision by TheFae

Vadi: /* Forcing Updates */

2020-06-20T05:39:34Z

Forcing Updates

TheFae: Added update tool details.

2020-06-20T05:16:55Z

Added update tool details.

TheFae: Created page with "{{TOC right}} The Mudlet Wiki uses a set of extensions to enable translation of the wiki contents. The MediaWiki Language Extension Bundle provides all the tools needed to m..."

2020-06-19T07:29:37Z

Created page with "{{TOC right}} The Mudlet Wiki uses a set of extensions to enable translation of the wiki contents. The MediaWiki Language Extension Bundle provides all the tools needed to m..."

New page

{{TOC right}}

The Mudlet Wiki uses a set of extensions to enable translation of the wiki contents. The MediaWiki Language Extension Bundle provides all the tools needed to make translations directly on the wiki. However, Mudlet makes use of Crowdin to translate texts throughout the Mudlet project. This page describes the infrastructure that was built to enable translations from Crowdin.

== How it Works ==

Simply put, every day at 1:00 AM UTC the mudlet.org server runs some tasks to import translations from Crowdin and export existing sources from the Wiki.
The sources are extracted from the English version of any page that is ready for translation. The sources are uploaded after importing translations has finished.
Translations can only be made once the source is uploaded, so this method may cause a delay.

Translations can be made on the wiki and both sources and translations can be exported from the wiki using the [[Special:ExportTranslations|Export Translations]] page.
Sources and Translations can be uploaded to Crowdin manually, provided they are exported from the wiki using the "Export for off-line translation" option.
Do note, some page titles contain colon <code>:</code> characters and those must be replaced with <code>=</code> characters before uploading to Crowdin!

All the scripts required can be located in <code>/var/www/i18n/</code> and <code>/var/www/wiki/</code> on the server.

== How to Use ==

To enable a page for translations, a wiki admin or moderator first needs to [[Special:PagePreparation|Prepare for Translation]] their desired page(s). The preparation adds some initial markup to review and help you get started.

Once a page is prepared, you can edit the Translation Markup to better suit your translation needs, or prune out Wikitext for translators where possible.

After the page is prepared and the Translate Markup is finished, the pages must be [[Special:PageTranslation|Marked for Translation]] which will show you a list of "translation units" the page created based on the Translate Markup. Be sure to enable translation of the page display title if it is not already enabled!

With a page properly marked for translation, the imports, exports, and translations can begin.

Extensive changes to a page may require it to be marked for translation again, to help keep translation units manageable for translators.

Planned -- Web-enabled request to manually fire the translation update tasks.

== Helpful Reading ==
* [https://www.mediawiki.org/wiki/Help:Extension:Translate/Page_translation_example Examples for Translation Markup]
* [https://www.mediawiki.org/wiki/Help:Extension:Translate Translate Extension]
* [https://www.mediawiki.org/wiki/MediaWiki_Language_Extension_Bundle MediaWiki Language Extension Bundle]

@@ Line 26: / Line 26: @@
 <!--T:8-->
-All the scripts required can be located in <code>/var/www/i18n/</code> and <code>/var/www/wiki/</code> on the server.  The update task is scheduled via the service user's crontab.</translate>
+All the scripts required are located in <code>/var/www/i18n/</code> and <code>/var/www/wiki/</code> on the server.  The update task is scheduled via the service user's crontab.</translate>
 == <translate><!--T:9--> How to Use</translate> ==

@@ Line 3: / Line 3: @@
 <translate>
 The Mudlet Wiki uses a set of extensions to enable translation of the wiki contents.  The MediaWiki Language Extension Bundle provides all the tools needed to make translations directly on the wiki.  However, Mudlet makes use of Crowdin to translate texts throughout the Mudlet project.  This page describes the infrastructure that was built to enable translations from Crowdin.</translate>
-== <translate>How it Works</translate> ==
+== <translate><!--T:2--> How it Works</translate> ==
-<translate>Simply put, every day at 1:00 AM UTC the mudlet.org server runs some tasks to import translations from Crowdin and export existing sources from the Wiki.
+<translate><!--T:3-->
 The sources are extracted from the English version of any page that is ready for translation.  The sources are uploaded after importing translations has finished.
 Translations can only be made once the source is uploaded, so this method may cause a delay.
 Translations can be made on the wiki. Sources and translations can be manually exported from the wiki using either the [[Special:ExportTranslations|Export Translations]] page, or by using the web tool described in "Forcing Updates" section.
 Sources and Translations can be uploaded to Crowdin manually, provided they are exported from the wiki using the "Export for off-line translation" option.
 Do note, some page titles contain colon <code>:</code> characters and those must be replaced with equals sign <code>=</code> characters before uploading to Crowdin!
 All the scripts required can be located in <code>/var/www/i18n/</code> and <code>/var/www/wiki/</code> on the server.  The update task is scheduled via the service user's crontab.</translate>
-== <translate>How to Use</translate> ==
+== <translate><!--T:9--> How to Use</translate> ==
-<translate>To enable a page for translations, a wiki admin or moderator first needs to [[Special:PagePreparation|Prepare for Translation]] the desired page(s).  The preparation adds some initial markup to review and help them get started.
+<translate><!--T:10-->
 Once a page is prepared, they can edit the Translation Markup to better suit translation needs, or prune out Wikitext for translators where possible.
 After the page is prepared and the Translate Markup is finished, the pages must be [[Special:PageTranslation|Marked for Translation]] which will list off "translation units" the page created based on its Translate Markup.  Be sure to enable translation of the page display title if it is not already enabled!
 With a page properly marked for translation, the imports, exports, and translations can begin.
 Extensive changes to a page may require it to be marked for translation again, to help keep translation units manageable for translators.</translate>
-== <translate>Forcing Updates</translate> ==
+== <translate><!--T:15--> Forcing Updates</translate> ==
-<translate>Wiki Translations and Crowdin Sources can be updated manually by using the Wiki Translations update tool found at https://make.mudlet.org/wiki-translations.php
+<translate><!--T:16-->
 You can pass the following URL Parameters to force specific updates:
 * <code>update=all</code>  -- Forces both import and export, the same actions as the daily task.
@@ Line 45: / Line 59: @@
 * <code>update=crowdin</code> -- Forces export and upload of English source-texts from Wiki to Crowdin.
 (links aren't added here so bots don't 'click' them)
 Manual updates can only be run once within 15 minutes, regardless of the triggered task.</translate>
-== <translate>Helpful Reading</translate> ==
+== <translate><!--T:20--> Helpful Reading</translate> ==
 <translate>
 * [https://www.mediawiki.org/wiki/Help:Extension:Translate/Page_translation_example Examples for Translation Markup]
 * [https://www.mediawiki.org/wiki/Help:Extension:Translate/Page_translation_administration Page Translation Best Practice]

@@ Line 19: / Line 19: @@
 Do note, some page titles contain colon <code>:</code> characters and those must be replaced with equals sign <code>=</code> characters before uploading to Crowdin!
-All the scripts required can be located in <code>/var/www/i18n/</code> and <code>/var/www/wiki/</code> on the server.  The update task is scheduled via the service user's crontab.
+All the scripts required can be located in <code>/var/www/i18n/</code> and <code>/var/www/wiki/</code> on the server.  The update task is scheduled via the service user's crontab.</translate>
-== How to Use ==
+== <translate>How to Use</translate> ==
-To enable a page for translations, a wiki admin or moderator first needs to [[Special:PagePreparation|Prepare for Translation]] the desired page(s).  The preparation adds some initial markup to review and help them get started.
+<translate>To enable a page for translations, a wiki admin or moderator first needs to [[Special:PagePreparation|Prepare for Translation]] the desired page(s).  The preparation adds some initial markup to review and help them get started.
 Once a page is prepared, they can edit the Translation Markup to better suit translation needs, or prune out Wikitext for translators where possible.
@@ Line 33: / Line 33: @@
-Extensive changes to a page may require it to be marked for translation again, to help keep translation units manageable for translators.
+Extensive changes to a page may require it to be marked for translation again, to help keep translation units manageable for translators.</translate>
-== Forcing Updates ==
+== <translate>Forcing Updates</translate> ==
-Wiki Translations and Crowdin Sources can be updated manually by using the Wiki Translations update tool found at https://make.mudlet.org/wiki-translations.php  <!-- use /wiki-translation/  (without .php) for the "fancy" UI version of the tool. -->
+<translate>Wiki Translations and Crowdin Sources can be updated manually by using the Wiki Translations update tool found at https://make.mudlet.org/wiki-translations.php
 You can pass the following URL Parameters to force specific updates:
@@ Line 47: / Line 47: @@
 (links aren't added here so bots don't 'click' them)
-Manual updates can only be run once within 15 minutes, regardless of the triggered task.
+Manual updates can only be run once within 15 minutes, regardless of the triggered task.</translate>
-== Helpful Reading ==
+== <translate>Helpful Reading</translate> ==
 * [https://www.mediawiki.org/wiki/Help:Extension:Translate/Page_translation_example Examples for Translation Markup]
 * [https://www.mediawiki.org/wiki/Help:Extension:Translate/Page_translation_administration Page Translation Best Practice]

@@ Line 1: / Line 1: @@
 {{TOC right}}
-The Mudlet Wiki uses a set of extensions to enable translation of the wiki contents.  The MediaWiki Language Extension Bundle provides all the tools needed to make translations directly on the wiki.  However, Mudlet makes use of Crowdin to translate texts throughout the Mudlet project.  This page describes the infrastructure that was built to enable translations from Crowdin.
+<translate>
-== How it Works ==
+== <translate>How it Works</translate> ==
-Simply put, every day at 1:00 AM UTC the mudlet.org server runs some tasks to import translations from Crowdin and export existing sources from the Wiki.
+<translate>Simply put, every day at 1:00 AM UTC the mudlet.org server runs some tasks to import translations from Crowdin and export existing sources from the Wiki.
 The sources are extracted from the English version of any page that is ready for translation.  The sources are uploaded after importing translations has finished.
@@ Line 35: / Line 37: @@
 == Forcing Updates ==
-You can pass the following values as a URL Parameter to force specific updates:
+Wiki Translations and Crowdin Sources can be updated manually by using the Wiki Translations update tool found at https://make.mudlet.org/wiki-translations.php  <!-- use /wiki-translation/  (without .php) for the "fancy" UI version of the tool. -->
 * <code>update=all</code>  -- Forces both import and export, the same actions as the daily task.
 * <code>update=wiki</code>  -- Forces download and import of translations from Crowdin to the Wiki.
 * <code>update=crowdin</code> -- Forces export and upload of English source-texts from Wiki to Crowdin.
-(links aren't added here so spambots don't 'click' them)
+(links aren't added here so bots don't 'click' them)
 == Helpful Reading ==
 * [https://www.mediawiki.org/wiki/Help:Extension:Translate/Page_translation_example Examples for Translation Markup]
 * [https://www.mediawiki.org/wiki/Help:Extension:Translate Translate Extension]
 * [https://www.mediawiki.org/wiki/MediaWiki_Language_Extension_Bundle MediaWiki Language Extension Bundle]

@@ Line 35: / Line 35: @@
 == Forcing Updates ==
-Wiki Translations and Crowdin Sources can be updated manually by using the Wiki Translations update tool found at https://make.mudlet.org/wiki-translations.php
+Wiki Translations and Crowdin Sources can be updated manually by using the Wiki Translations update tool found at https://make.mudlet.org/wiki-translations.php?
 You can pass the following values as a URL Parameter to force specific updates:
 * <code>update=all</code>  -- Forces both import and export, the same actions as the daily task.
 * <code>update=wiki</code>  -- Forces download and import of translations from Crowdin to the Wiki.
 * <code>update=crowdin</code> -- Forces export and upload of English source-texts from Wiki to Crowdin.
 == Helpful Reading ==