Skip to content

Commit 20bef85

Browse files
authored
[TASK] Revise localization overview chapter (#92)
Releases: main, 12.4, 11.5
1 parent b20dff4 commit 20bef85

1 file changed

Lines changed: 105 additions & 87 deletions

File tree

Lines changed: 105 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -1,153 +1,170 @@
1-
.. include:: /Includes.rst.txt
1+
.. include:: /Includes.rst.txt
22

3+
.. _localization-overview:
34

4-
.. _localization-overview:
5-
5+
=====================
66
Localization overview
7-
^^^^^^^^^^^^^^^^^^^^^
7+
=====================
8+
9+
.. contents::
10+
:local:
11+
12+
13+
Introduction
14+
============
815

916
You can get a complete overview of the page tree and page
10-
translations by using the **Web > Info** module and choosing
11-
the "Localization Overview" function.
17+
translations by using the :guilabel:`Web > Info` module and choosing
18+
the :guilabel:`Localization Overview` function.
1219

13-
.. figure:: /Images/ManualScreenshots/InfoModule/LocalizationOverviewIntroductionPackage.png
14-
:alt: Localization Overview in Web > Info module
20+
.. figure:: /Images/ManualScreenshots/InfoModule/LocalizationOverviewIntroductionPackage.png
21+
:alt: Localization Overview in Web > Info module
22+
:class: with-shadow
1523

16-
Overview of existing translations in a blank Introduction Package
24+
Overview of existing translations in a blank Introduction Package
1725

18-
All the green entries show which languages each page is available in.
19-
The gray areas mean that no translation is available but access to the
20-
page specifying this language will be tolerated. It is also very quick
26+
All the green entries indicate which languages the respective page is available
27+
in. The gray areas mean that no translation is available, but access to the
28+
page specifying this language is tolerated. It is also fast
2129
to create new translations from this module: use the checkboxes and hit
22-
the "Create new translation headers" button.
30+
the :guilabel:`Create new translation headers` button.
2331

24-
.. figure:: /Images/ManualScreenshots/InfoModule/LocalizationOverviewMassTranslation.png
25-
:alt: Translating several pages at once
32+
.. figure:: /Images/ManualScreenshots/InfoModule/LocalizationOverviewMassTranslation.png
33+
:alt: Translating several pages at once
34+
:class: with-shadow
2635

27-
Creating translations for a whole selection of pages at once
36+
Creating translations for a whole selection of pages at once
2837

2938

30-
.. _localization-overview-hide-missing-translations:
39+
.. _localization-overview-hide-missing-translations:
3140

3241
Hiding pages if no translation exist
33-
""""""""""""""""""""""""""""""""""""
42+
====================================
3443

35-
If a translation of a page does not exist it will by default still
36-
appear in the website menu when using that language. Here the
37-
home page of the Introduction Package is in German (as can be seen
38-
from the translate page title in :code:`<title>` tag), and all other
39-
(untranslated) pages still appear in the menu, albeit in the default
40-
language (English).
44+
If there is no translation of a page, it will still appear by default in the
45+
website menu when this language is used. Here the home page of the Introduction
46+
Package is in German (as can be seen from the translate page title in
47+
:html:`<title>` tag), and all other (untranslated) pages still appear in the
48+
menu, albeit in the default language (English).
4149

42-
.. figure:: /Images/ManualScreenshots/Frontend/LocalizationOverviewDefaultLanguageFallback.png
43-
:alt: The menu with untranslated pages
50+
.. figure:: /Images/ManualScreenshots/Frontend/LocalizationOverviewDefaultLanguageFallback.png
51+
:alt: The menu with untranslated pages
52+
:class: with-shadow
4453

45-
The German home page with untranslated pages appearing in the menu
54+
The German home page with untranslated pages appearing in the menu
4655

47-
This behaviour can be changed. Let's edit the "Customizing" page.
48-
In the "Behaviour" tab, check the "Hide page if no translation for current
49-
language exists":
56+
This behaviour can be changed. Let us edit the "Customizing" page.
57+
In the :guilabel:`Behaviour` tab, check the
58+
:guilabel:`Hide page if no translation for current language exists`:
5059

51-
.. figure:: /Images/ManualScreenshots/Record/LocalizationOverviewHideIfNoTranslation.png
52-
:alt: Hiding the page if not translated
60+
.. figure:: /Images/ManualScreenshots/Record/LocalizationOverviewHideIfNoTranslation.png
61+
:alt: Hiding the page if not translated
62+
:class: with-shadow
5363

54-
Hide the page if it is not translated
64+
Hide the page if it is not translated
5565

5666
This is reflected in the *Localization Overview*:
5767

58-
.. figure:: /Images/ManualScreenshots/InfoModule/LocalizationOverviewTranslationHidden.png
59-
:alt: Hidden translation in the overview
68+
.. figure:: /Images/ManualScreenshots/InfoModule/LocalizationOverviewTranslationHidden.png
69+
:alt: Hidden translation in the overview
70+
:class: with-shadow
6071

61-
The Localization Overview reflects the change in visibility of the "Customizing" page
72+
The Localization Overview reflects the change in visibility of the "Customizing" page
6273

6374
From this it is clear that when viewing the website in
6475
German the "Customizing" page is not accessible. The menu
6576
reflects this in the frontend.
6677

67-
.. figure:: /Images/ManualScreenshots/Frontend/LocalizationOverviewMenuWithHiddenUntranslatedPage.png
68-
:alt: Hidden translation in the menu
78+
.. figure:: /Images/ManualScreenshots/Frontend/LocalizationOverviewMenuWithHiddenUntranslatedPage.png
79+
:alt: Hidden translation in the menu
80+
:class: with-shadow
6981

70-
The "Customizing" page does not appear in the menu anymore
82+
The "Customizing" page does not appear in the menu anymore
7183

72-
Trying to access the "Customizing" page with directly with its id will
84+
Trying to access the "Customizing" page directly with its ID will
7385
produce an error.
7486

75-
.. figure:: /Images/ManualScreenshots/Frontend/LocalizationOverviewTranslationError.png
76-
:alt: Missing translation generates error
87+
.. figure:: /Images/ManualScreenshots/Frontend/LocalizationOverviewTranslationError.png
88+
:alt: Missing translation generates error
89+
:class: with-shadow
7790

78-
An error message indicates a missing translation
91+
An error message indicates a missing translation
7992

8093

81-
.. _localization-overview-hide-default-language:
94+
.. _localization-overview-hide-default-language:
8295

8396
Hiding default translation of pages
84-
"""""""""""""""""""""""""""""""""""
97+
===================================
8598

86-
If you want pages in *only* the alternative languages you must still
99+
If you want pages *only* in the alternative languages you must still
87100
create a default language page in the page tree which simply acts as a
88101
placeholder. Setting this status is done by selecting the checkbox
89-
"Hide default translation of page":
102+
:guilabel:`Hide default translation of page`:
90103

91-
.. figure:: /Images/ManualScreenshots/Record/LocalizationOverviewHideDefaultLanguage.png
92-
:alt: Hiding the page in default language
104+
.. figure:: /Images/ManualScreenshots/Record/LocalizationOverviewHideDefaultLanguage.png
105+
:alt: Hiding the page in default language
106+
:class: with-shadow
93107

94-
Hide the page in the default language
108+
Hide the page in the default language
95109

96110
This is reflected in the *Localization Overview*:
97111

98-
.. figure:: /Images/ManualScreenshots/Record/LocalizedContentAllLanguageDefined.png
99-
:alt: Hidden default language in the overview
100-
101-
The Localization Overview shows the page as being unavailable in the default language
112+
.. figure:: /Images/ManualScreenshots/Record/LocalizedContentAllLanguageDefined.png
113+
:alt: Hidden default language in the overview
114+
:class: with-shadow
102115

103-
.. note::
116+
The Localization Overview shows the page as being unavailable in the default language
104117

105-
The page also appears as being unavailable in Danish, because Danish falls back to
106-
English and English is not available.
118+
.. note::
119+
The page also appears as being unavailable in Danish, because Danish falls
120+
back to English and English is not available.
107121

108122
On the web site, the menu now looks like this in German:
109123

110-
.. figure:: /Images/ManualScreenshots/Frontend/LocalizationOverviewHideDefaultLanguageMenuGerman.png
111-
:alt: German menu with language-specific page
124+
.. figure:: /Images/ManualScreenshots/Frontend/LocalizationOverviewHideDefaultLanguageMenuGerman.png
125+
:alt: German menu with language-specific page
126+
:class: with-shadow
112127

113-
The German-specific page shows up in the German version of the web site
128+
The German-specific page shows up in the German version of the web site
114129

115130
and in English:
116131

117-
.. figure:: /Images/ManualScreenshots/Frontend/LocalizationOverviewHideDefaultLanguageMenuEnglish.png
118-
:alt: English menu not showing language-specific page
132+
.. figure:: /Images/ManualScreenshots/Frontend/LocalizationOverviewHideDefaultLanguageMenuEnglish.png
133+
:alt: English menu not showing language-specific page
134+
:class: with-shadow
119135

120-
The German-specific page does not show up in the default version of the web site
136+
The German-specific page does not show up in the default version of the web site
121137

122-
Trying to access the "Nur für Deutschland" page in default language will
138+
Trying to access the "Nur für Deutschland" page in the default language will
123139
yield an error.
124140

125141
Hiding pages in the default language is probably a rare thing to do,
126142
but it is possible to imagine cases where the topic of a page or
127143
section is only relevant in one of the alternative languages.
128-
Especially if a language of the site is not only a translation but may
144+
Especially, if a language of the site is not only a translation but may
129145
serve subsidiaries of a company in a local context.
130146

131147

132-
.. _localization-overview-inverse-hiding:
148+
.. _localization-overview-inverse-hiding:
133149

134150
Inverse control of hidden translations
135-
""""""""""""""""""""""""""""""""""""""
151+
======================================
136152

137153
It is also possible to hide all untranslated pages by default
138154
with a global setting:
139155

140-
.. code-block:: php
141-
:caption: EXT:site_package/ext_localconf.php
156+
.. code-block:: php
157+
:caption: EXT:site_package/ext_localconf.php
142158
143-
$GLOBALS['TYPO3_CONF_VARS']['FE']['hidePagesIfNotTranslatedByDefault'] = 1;
159+
$GLOBALS['TYPO3_CONF_VARS']['FE']['hidePagesIfNotTranslatedByDefault'] = 1;
144160
145161
The *Localization Overview* reflects this immediately:
146162

147-
.. figure:: /Images/ManualScreenshots/InfoModule/LocalizationOverviewInvertTranslationHandling.png
148-
:alt: All untranslated pages hidden by default
163+
.. figure:: /Images/ManualScreenshots/InfoModule/LocalizationOverviewInvertTranslationHandling.png
164+
:alt: All untranslated pages hidden by default
165+
:class: with-shadow
149166

150-
The Localization Overview shows that all untranslated pages are hidden by default
167+
The Localization Overview shows that all untranslated pages are hidden by default
151168

152169
Note how the behaviour of specific localization setting for the
153170
"Customizing" pages has been inverted. We had earlier defined the page
@@ -158,30 +175,31 @@ being gray instead of red).
158175
When editing the page properties, the label of the corresponding
159176
checkbox has changed:
160177

161-
.. figure:: /Images/ManualScreenshots/Frontend/LocalizationOverviewShowEvenIfNoTranslation.png
162-
:alt: Show page even if no translation exists
178+
.. figure:: /Images/ManualScreenshots/Frontend/LocalizationOverviewShowEvenIfNoTranslation.png
179+
:alt: Show page even if no translation exists
180+
:class: with-shadow
163181

164-
Inverted behaviour: choose to show the page even if no translation exists
182+
Inverted behaviour: choose to show the page even if no translation exists
165183

166184

167185
.. _localization-overview-final-notes:
168186

169187
Final notes
170-
"""""""""""
188+
===========
171189

172-
Summary of colors in "Localization Overview":
190+
Summary of colors in the Localization Overview:
173191

174192
Green background
175-
Page is translated and viewable in this
176-
language. For translations it means that an active Alternative Page
177-
Language overlay record is present.
193+
Page is translated and viewable in this
194+
language. For translations it means that an active Alternative Page
195+
Language overlay record is present.
178196

179197
Red background
180-
Page *cannot* be viewed in this language and you
181-
will see an error message if you try. Menus should automatically
182-
filter out links to pages with this translation.
198+
Page *cannot* be viewed in this language and you
199+
will see an error message if you try. Menus should automatically
200+
filter out links to pages with this translation.
183201

184202
Gray background (not available for default language)
185-
Page will fall back to the specified fallback mode for content.
186-
Depends on language fallback configuration set in your site
187-
configuration.
203+
Page will fall back to the specified fallback mode for content.
204+
It depends on the language fallback configuration set in your site
205+
configuration.

0 commit comments

Comments
 (0)