Manual:Extension/BlueSpiceTranslationTransfer: Difference between revisions

Redaktion (talk | contribs)
No edit summary
Tag: 2017 source edit
No edit summary
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
BlueSpiceTranslationTransfer allows to create a translated Version of an Article in another Wiki
 
== Prerequisites ==
The translation mechanism requires at least one source and one target wiki. The configuration of the translation must be prepared accordingly by a server administrator (see requirements on the [[Reference:BlueSpiceTranslationTransfer|reference page of the TranslationTransfer extension]]).
 
== Translation workflows ==
 
=== Translation of a page ===
Once the wikis have been configured, pages can be translated from the source wiki and created in another language wiki instance.
 
To translate a page:
# '''Click''' on the <code>Translate</code> link in the toolbar on the source page. A dialogue opens.
# '''Select''' the desired target language.
# '''Click''' <code>Translate</code> to start the translation.
# '''Check''' the suggested page name in the target wiki and change it if necessary. This dialogue box only appears for the first translation of the page.
# '''Click''' <code>Translate</code> again to save the page name. The translation is displayed.
# '''Click''' '''<code>Save</code>''' to save the translated page in the target wiki. You can now go directly to the page in the target wiki, translate it into another language (if configured) or close the dialogue box without taking any further action.
<gallery widths="220" heights="200">
File:Manual:Extension BlueSpiceTranslationTransfer 1743770053694.png|Translation button
File:Manual:Extension BlueSpiceTranslationTransfer 1743770108045.png|Language selection dialogue
File:Manual:Extension BlueSpiceTranslationTransfer 1743770150061.png|Customise page title
File:Manual:Extension BlueSpiceTranslationTransfer 1743770194009.png|Page translation display and confirmation
File:Manual:Extension BlueSpiceTranslationTransfer 1743769862375.png|Link between the language versions
</gallery>
 
=== Merge page content ===
If a page has already been translated, subsequent translations overwrite the previous page.
 
However, it is possible to configure in the server configuration whether the pages first land in a specific draft namespace and have to be checked and released manually.
 
If this is configured, the corresponding documentation is available on the [[Manual:Extension/MergeArticles|manual page of the MergeArticles extension]].
 
=== Additional information about the translation ===
The translated content during the translation process includes:
 
* Content of the page
* Display title (and optional real title)
* Categories (however, the category pages are not created, only the category link is transferred)
* Internal links
** Links to other internal pages are also adjusted to point to the correct translated page.
** Example: If the German page A links to the German page B, the English translation page A will link to the English translation page B.
* The embedded files/images on the source page are transferred to the target page without being translated or renamed.
* Templates and template calls in the wikitext are not translated, but are transferred with their original names. The templates can then be adapted manually or translated if necessary.
* Transcluded pages are also transferred without translation
* Code blocks are not translated.
* Translations are linked in the language changer (link to the same page in the other language wikis)
* Limitation: If a page is too long / large, the DeepL API cannot translate it. The best option is to divide the page into smaller subpages
 
=== Exclude file from translation ===
A tag can be inserted on the source page to exclude the file transfer for a specific page from the translation process.
 
In this way, the changes made in the target system are not overwritten during the next translation.
 
To do this, the user must insert the <code>__BS_NO_AUTOMATIC_DOCUMENT_TRANSLATION__</code> tag on the source page that contains the files to be excluded from the translation process.
 
Steps to exclude files from translation:
 
# Add the tag <code>__BS_NO_AUTOMATIC_DOCUMENT_TRANSLATION__</code>in the source code of the source page
# Add the files to the source page
# Translate the page into the target language
# The placeholder from the file is transferred, but the file is not. The file is therefore shown as ‘incorrect’ on the page. This allows users to see that files are missing and may need to be replaced.
[[File:Manual:Extension BlueSpiceTranslationTransfer 1743770656579.png|center|thumb|Not-transferred file]]
​Note: If the file already exists on EN Wiki, the file will be displayed correctly.
 
== Translation overview ==
An overview of all translations is available under <code>Special:TranslationsOverview</code>.
[[File:Manual:Extension BlueSpiceTranslationTransfer 1743771014879.png|center|thumb|700x700px|Translation overview]]
 
== Translation Dictionary ==
The dictionary with all page titles and links can be viewed under <code>Special:TranslationDictionary</code>.
 
If the title of a target page needs to be adapted after the first translation, this can be done on this special page.
[[File:Manual:Extension BlueSpiceTranslationTransfer 1743771305481.png|center|thumb|600x600px|Translation Dictionary ]]
If a source page is renamed, the titles are automatically retranslated and the title translations are updated in the database and in the wiki.
 
The different translation versions are still linked correctly. The redirect selected on the source page is also set up on the corresponding target pages.
 
== Translation glossary ==
Glossary entries for the translation can be maintained on the <code>Special:TranslationsGlossary</code> page. This ensures that certain terms from the source language are always translated with a specific term from the target language. This applies to both the page title and the normal page content.
 
The maintained wiki glossary is transferred to the DeepL glossary and used in the translation.
 
<u>Please note</u>: DeepL glossary has restrictions for supported languages ([https://developers.deepl.com/docs/api-reference/glossaries#list-supported-glossary-language-pairs see DeepL documentation])
[[File:Manual:Extension BlueSpiceTranslationTransfer 1743771485615.png|center|thumb|600x600px|Translation glossary]]
 
== Additional information ==
{{#dpl:title=Handbuch:Erweiterung/BlueSpiceConfigManager|include=#BlueSpiceTranslationTransfer}}
 
==== Configuration of wiki structure and namespaces ====
 
*The translation processes (i.e. which wiki/language can be translated into which wiki/language) must be configured.
*The farm may contain some wiki instances that do not use translation workflows.
*Caution: DeepL translation is not available in all existing languages.
 
The links between the source and target namespaces must be maintained under <code>Special:BlueSpiceConfigManager</code> and <code>BlueSpiceTranslationTransfer</code> extension.
 
For example, the pages from the DE source namespace ‘Finanzen’ must be translated into the EN target namespace ‘Finance’.
[[File:Manual:Extension BlueSpiceTranslationTransfer 1743771917649.png|center|thumb|600x600px|Namespace configuration]]
If the pages must first be created in the draft namespace after translation, this must also be configured in the backend.
 
==== Configuration DeepL API ====
The DeepL API key must be created under <code>Special:BlueSpiceConfigManager</code> and <code>DeepL</code> extension.
 
The configuration is required in the source wiki. [[File:Manual:Extension_AdhocTranslation_1743685074718.png|center|DeepL API Key Configuration|450x450px]]
 
== Ad-hoc Translation ==
{{Manual:Extension/AdhocTranslation}}
 
{{Box Links-en|Topic1=[[Manual:Extension/ContentTransfer]]|Topic2=[[Manual:Extension/MergeArticles]]}}
 
{{translation}}
{{translation}}

Latest revision as of 13:09, 4 April 2025

Prerequisites

The translation mechanism requires at least one source and one target wiki. The configuration of the translation must be prepared accordingly by a server administrator (see requirements on the reference page of the TranslationTransfer extension).

Translation workflows

Translation of a page

Once the wikis have been configured, pages can be translated from the source wiki and created in another language wiki instance.

To translate a page:

  1. Click on the Translate link in the toolbar on the source page. A dialogue opens.
  2. Select the desired target language.
  3. Click Translate to start the translation.
  4. Check the suggested page name in the target wiki and change it if necessary. This dialogue box only appears for the first translation of the page.
  5. Click Translate again to save the page name. The translation is displayed.
  6. Click Save to save the translated page in the target wiki. You can now go directly to the page in the target wiki, translate it into another language (if configured) or close the dialogue box without taking any further action.

Merge page content

If a page has already been translated, subsequent translations overwrite the previous page.

However, it is possible to configure in the server configuration whether the pages first land in a specific draft namespace and have to be checked and released manually.

If this is configured, the corresponding documentation is available on the manual page of the MergeArticles extension.

Additional information about the translation

The translated content during the translation process includes:

  • Content of the page
  • Display title (and optional real title)
  • Categories (however, the category pages are not created, only the category link is transferred)
  • Internal links
    • Links to other internal pages are also adjusted to point to the correct translated page.
    • Example: If the German page A links to the German page B, the English translation page A will link to the English translation page B.
  • The embedded files/images on the source page are transferred to the target page without being translated or renamed.
  • Templates and template calls in the wikitext are not translated, but are transferred with their original names. The templates can then be adapted manually or translated if necessary.
  • Transcluded pages are also transferred without translation
  • Code blocks are not translated.
  • Translations are linked in the language changer (link to the same page in the other language wikis)
  • Limitation: If a page is too long / large, the DeepL API cannot translate it. The best option is to divide the page into smaller subpages

Exclude file from translation

A tag can be inserted on the source page to exclude the file transfer for a specific page from the translation process.

In this way, the changes made in the target system are not overwritten during the next translation.

To do this, the user must insert the tag on the source page that contains the files to be excluded from the translation process.

Steps to exclude files from translation:

  1. Add the tag in the source code of the source page
  2. Add the files to the source page
  3. Translate the page into the target language
  4. The placeholder from the file is transferred, but the file is not. The file is therefore shown as ‘incorrect’ on the page. This allows users to see that files are missing and may need to be replaced.
Not-transferred file

​Note: If the file already exists on EN Wiki, the file will be displayed correctly.

Translation overview

An overview of all translations is available under Special:TranslationsOverview.

Translation overview

Translation Dictionary

The dictionary with all page titles and links can be viewed under Special:TranslationDictionary.

If the title of a target page needs to be adapted after the first translation, this can be done on this special page.

Translation Dictionary

If a source page is renamed, the titles are automatically retranslated and the title translations are updated in the database and in the wiki.

The different translation versions are still linked correctly. The redirect selected on the source page is also set up on the corresponding target pages.

Translation glossary

Glossary entries for the translation can be maintained on the Special:TranslationsGlossary page. This ensures that certain terms from the source language are always translated with a specific term from the target language. This applies to both the page title and the normal page content.

The maintained wiki glossary is transferred to the DeepL glossary and used in the translation.

Please note: DeepL glossary has restrictions for supported languages (see DeepL documentation)

Translation glossary

Additional information

Configuration of wiki structure and namespaces

  • The translation processes (i.e. which wiki/language can be translated into which wiki/language) must be configured.
  • The farm may contain some wiki instances that do not use translation workflows.
  • Caution: DeepL translation is not available in all existing languages.

The links between the source and target namespaces must be maintained under Special:BlueSpiceConfigManager and BlueSpiceTranslationTransfer extension.

For example, the pages from the DE source namespace ‘Finanzen’ must be translated into the EN target namespace ‘Finance’.

Namespace configuration

If the pages must first be created in the draft namespace after translation, this must also be configured in the backend.

Configuration DeepL API

The DeepL API key must be created under Special:BlueSpiceConfigManager and DeepL extension.

The configuration is required in the source wiki.

DeepL API Key Configuration
DeepL API Key Configuration

Ad-hoc Translation

The AdhocTranslation extension translates a wiki page directly into the user's language.

If users have set a language other than the installation language of the wiki as the user language in their settings, the link Translate to my language appears in the toolbar of the page.

‘Translate to my language’ in the toolbar

After clicking on the link, the page content is displayed translated. After reloading the page, the actual content of the page is displayed again.

ExportThe PDF export does not take the ad-hoc translation into account. Export is only available in the original source language.


Configuration

The DeepL API key must be set up under Special:BlueSpiceConfigManager and DeepL Extension.

The configuration is required in each relevant instance.

DeepL API Key Configuration

Related info




To submit feedback about this documentation, visit our community forum.