Actions

JDOC

Translating Links

From Joomla! Documentation

Other languages: català 42% • ‎Deutsch 100% • ‎English 100% • ‎español 100% • ‎français 100% • ‎Bahasa Indonesia 100% • ‎日本語 100% • ‎Nederlands 100% • ‎русский 47% • ‎Kiswahili 100%

Linking translated pages together is an important part of page navigation for our users. It is a quick way to send a user to another page for more information on relevant topics. Translating these links must be done a specific way to keep a user in their language of choice. If a person is browsing our documentation in their language, they would probably prefer to stay in their language if possible. Providing a link to a page in its English form will work, however, the user must click the link to their language to read it in their language.

Contents

Introduction

Translating page links must be done a certain way to send the reader to another page in the same language. English writers can help by following this format too. It makes it easier on the translators when they start translating pages if the correct link for localisation is already used.

In a normal links [[Component]] a user is taken to the Component page when they click the link. If there is a translated version of the page, for example, French, the French page would be located at [[Component/fr]].

So what if the page for Component/fr has not been created yet? The user would see a 'red-link' (page doesn't exist) compared to a blue link (the page exists). Perhaps the page Component will be translated, but it has not been translated yet. This is why Special:MyLanguage/ should always be used as a prefix to the linked page.

[[Component]] should be written as [[S:MyLanguage/Component|Component]]
 or
[[Component]] should be written as [[Special:MyLanguage/Component|Component]]

How "Special:MyLanguage" Works in Links

What does Special:MyLanguage/ do? It does a few things when processing a clicked link on a page before sending the user to the page. Using the page Component as an example:-

  • The user has asked for this link, Special:MyLanguage/Component
  • Get the user's language (or what language is the page current being viewed in?).
  • Got it! The user is viewing the page in French, fr is the language code.
  • Let's see if the link clicked to Component exists in French. Add /fr to it.
    • Yes, Component/fr is a valid page! Send the user to the page's French version;
    • No, the page Component/fr doesn't exist. Send the user to the default source language version;
  • Show the user the page.

Applications of Use

Translators

A setting in documentation has made it easier with an short alias to "Special:" in links. You may use "S:" instead of "Special:" in a link, [[S:MyLanguage/...]].

Regular page links

[[Component]] should be written as [[S:MyLanguage/Component|<{translate this only}>]]
 or
[[Component]] should be written as [[Special:MyLanguage/Component|<{translate this only}>]]

Namespaced page links

[[JDOC:Translating Links]] should be written as [[S:MyLanguage/JDOC:Translating Links|<{translate this only}>]]
 or
[[JDOC:Translating Links]] should be written as [[Special:MyLanguage/JDOC:Translating Links|<{translate this only}>]]

Category page links:

[[:Category:Glossary_definitions]] should be written as [[S:MyLanguage/:Category:Glossary_definitions|<{translate this only}>]]
 or
[[:Category:Glossary_definitions]] should be written as [[Special:MyLanguage/:Category:Glossary_definitions|<{translate this only}>]]

English Page Writers and Editors

All the above in the Translators section applies to English version page writers and copy editors. You can help with translations by creating page links in English version pages using Special:MyLanguage/ or S:MyLanguage/ too! A page doesn't need to be marked for translation or even in the process of being translated. As pages are added to the translation queue, translators will have an easier time translating the links on a page.