Skip to content

Commit b401f16

Browse files
nickvergessennickvergessen
authored
Merge pull request #13414 from nextcloud/backport/13404/stable30
[stable30] feat(user_manual): Make translation versions more visible
2 parents 9703fbe + 6576951 commit b401f16

File tree

8 files changed

+249
-10
lines changed

8 files changed

+249
-10
lines changed

‎admin_manual/_templates/versions.html‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{% if READTHEDOCS %}
2+
{# Add rst-badge after rst-versions for small badge style. #}
3+
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
4+
<span class="rst-current-version" data-toggle="rst-current-version">
5+
☁️ {{ current_version }}
6+
<span class="fa fa-caret-down"></span>
7+
</span>
8+
<div class="rst-other-versions">
9+
<dl>
10+
<dt>☁️ {{ _('Versions') }}</dt>
11+
{% for slug, url in versions|reverse %}
12+
<dd style="width: 32%">
13+
<a href="{{ url }}"
14+
{% if current_version == slug %}
15+
style="color: var(--dark-link-color);"
16+
{% endif %}
17+
>
18+
{{ slug }}
19+
</a>
20+
</dd>
21+
{% endfor %}
22+
</dl>
23+
</div>
24+
</div>
25+
{% endif %}

‎admin_manual/conf.py‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
extensions += ['sphinx.ext.todo', 'rst2pdf.pdfbuilder', 'sphinx.ext.intersphinx']
3333

3434
# Add any paths that contain templates here, relative to this directory.
35-
templates_path = ['../_shared_assets/templates']
35+
templates_path = ['../_shared_assets/templates', '_templates']
3636

3737
# The suffix of source filenames.
3838
source_suffix = '.rst'
@@ -61,6 +61,8 @@
6161
# for a list of supported languages.
6262
#language = None
6363

64+
language = 'en'
65+
6466
# There are two options for replacing |today|: either, you set today to some
6567
# non-false value, then it is used:
6668
#today = ''

‎conf.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
sys.path.insert(0, os.path.abspath(dir_path + '/_ext'))
99
now = datetime.datetime.now()
1010

11+
os.environ["READTHEDOCS"] = "True"
12+
1113
extensions = ['sphinx_rtd_theme', 'sphinx_rtd_dark_mode', 'sphinx_copybutton']
1214

1315
# General information about the project.

‎developer_manual/_templates/versions.html‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{% if READTHEDOCS %}
2+
{# Add rst-badge after rst-versions for small badge style. #}
3+
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
4+
<span class="rst-current-version" data-toggle="rst-current-version">
5+
☁️ {{ current_version }}
6+
<span class="fa fa-caret-down"></span>
7+
</span>
8+
<div class="rst-other-versions">
9+
<dl>
10+
<dt>☁️ {{ _('Versions') }}</dt>
11+
{% for slug, url in versions|reverse %}
12+
<dd style="width: 32%">
13+
<a href="{{ url }}"
14+
{% if current_version == slug %}
15+
style="color: var(--dark-link-color);"
16+
{% endif %}
17+
>
18+
{{ slug }}
19+
</a>
20+
</dd>
21+
{% endfor %}
22+
</dl>
23+
</div>
24+
</div>
25+
{% endif %}

‎developer_manual/conf.py‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
extensions += ['sphinx.ext.todo', 'rst2pdf.pdfbuilder', 'sphinx.ext.intersphinx', 'sphinxcontrib.phpdomain', 'sphinx_toolbox.collapse', 'sphinx_reredirects']
3333

3434
# Add any paths that contain templates here, relative to this directory.
35-
templates_path = ['../_shared_assets/templates']
35+
templates_path = ['../_shared_assets/templates', '_templates']
3636

3737
# The suffix of source filenames.
3838
source_suffix = '.rst'
@@ -60,6 +60,8 @@
6060
# for a list of supported languages.
6161
#language = None
6262

63+
language = 'en'
64+
6365
# There are two options for replacing |today|: either, you set today to some
6466
# non-false value, then it is used:
6567
#today = ''

‎user_manual/Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ html:
5353
versions-template-all: $(foreach lang, $(LANGS), add-lang-to-versions-template-$(lang))
5454

5555
add-lang-to-versions-template-%:
56-
sed -i '/Here goes the Langs/i <dd><a href="/server/latest/user_manual/$*/">$*</a></dd>' ./_templates/versions.html
56+
sed -i '/Here go the languages/i {% set available_languages = available_languages + ["$*"] %}' ./_templates/versions.html
5757

5858
html-all: $(foreach lang, $(LANGS), html-allow-warnings-lang-$(lang))
5959

‎user_manual/_templates/versions.html‎

Lines changed: 187 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,202 @@
11
{% if READTHEDOCS %}
22
{# Add rst-badge after rst-versions for small badge style. #}
3+
<!-- Here go the languages -->
4+
{% set available_languages = available_languages|sort %}
35
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
46
<span class="rst-current-version" data-toggle="rst-current-version">
5-
<span class="fa fa-book"> Read the Docs</span>
6-
v: {{ current_version }}
7+
🌐
8+
{% set language_code = language %}
9+
{% if language_code == 'cs' %}
10+
Czech
11+
{% elif language_code == 'da' %}
12+
Danish
13+
{% elif language_code == 'de' %}
14+
German
15+
{% elif language_code == 'el' %}
16+
Greek
17+
{% elif language_code == 'es' %}
18+
Spanish
19+
{% elif language_code == 'en' %}
20+
English
21+
{% elif language_code == 'fi_FI' %}
22+
Finnish
23+
{% elif language_code == 'fr' %}
24+
French
25+
{% elif language_code == 'hr' %}
26+
Croatian
27+
{% elif language_code == 'hu_HU' %}
28+
Hungarian
29+
{% elif language_code == 'id' %}
30+
Indonesian
31+
{% elif language_code == 'it' %}
32+
Italian
33+
{% elif language_code == 'ja_JP' %}
34+
Japanese
35+
{% elif language_code == 'ko' %}
36+
Korean
37+
{% elif language_code == 'mn' %}
38+
Mongolian
39+
{% elif language_code == 'nb_NO' %}
40+
Norwegian
41+
{% elif language_code == 'nl' %}
42+
Dutch
43+
{% elif language_code == 'pl' %}
44+
Polish
45+
{% elif language_code == 'pt_PT' %}
46+
Portuguese
47+
{% elif language_code == 'pt_BR' %}
48+
Portuguese (BR)
49+
{% elif language_code == 'ro' %}
50+
Romanian
51+
{% elif language_code == 'ru' %}
52+
Russian
53+
{% elif language_code == 'sk_SK' %}
54+
Slovakian
55+
{% elif language_code == 'sq' %}
56+
Albanian
57+
{% elif language_code == 'sr' %}
58+
Slovenian
59+
{% elif language_code == 'sv' %}
60+
Swedish
61+
{% elif language_code == 'tr' %}
62+
Turkish
63+
{% elif language_code == 'uk' %}
64+
Ukrainian
65+
{% elif language_code == 'uz' %}
66+
Uzbek
67+
{% elif language_code == 'vi' %}
68+
Vietnamese
69+
{% elif language_code == 'zh_CN' %}
70+
Chinese
71+
{% elif language_code == 'zh_HK' %}
72+
Chinese (HK)
73+
{% elif language_code == 'zh_TW' %}
74+
Chinese (TW)
75+
{% else %}
76+
{{ language_code }}
77+
{% endif %}
78+
<span class="fa fa-caret-down"></span>
79+
80+
 ☁️ {{ current_version }}
781
<span class="fa fa-caret-down"></span>
882
</span>
983
<div class="rst-other-versions">
1084
<dl>
11-
<dt>Languages</dt>
12-
<!--Here goes the Langs-->
85+
<dt>🌐 {{ _('Languages') }}</dt>
86+
{% for language_code in available_languages %}
87+
<dd style="width: 32%; vertical-align: top;">
88+
<a href="/server/latest/user_manual/{{ language_code }}/"
89+
{% if language_code == language %}
90+
style="color: var(--dark-link-color);"
91+
{% endif %}
92+
>
93+
{% if language_code == 'af' %}
94+
Afrikaans
95+
{% elif language_code == 'ar' %}
96+
Arabic
97+
{% elif language_code == 'br' %}
98+
Breton
99+
{% elif language_code == 'ca' %}
100+
Catalan
101+
{% elif language_code == 'cs' %}
102+
Czech
103+
{% elif language_code == 'da' %}
104+
Danish
105+
{% elif language_code == 'de' %}
106+
German
107+
{% elif language_code == 'el' %}
108+
Greek
109+
{% elif language_code == 'eo' %}
110+
Esperanto
111+
{% elif language_code == 'es' %}
112+
Spanish
113+
{% elif language_code == 'en' %}
114+
English
115+
{% elif language_code == 'fi_FI' %}
116+
Finnish
117+
{% elif language_code == 'fr' %}
118+
French
119+
{% elif language_code == 'hr' %}
120+
Croatian
121+
{% elif language_code == 'hu_HU' %}
122+
Hungarian
123+
{% elif language_code == 'ga' %}
124+
Irish
125+
{% elif language_code == 'gl' %}
126+
Glacian
127+
{% elif language_code == 'id' %}
128+
Indonesian
129+
{% elif language_code == 'it' %}
130+
Italian
131+
{% elif language_code == 'ja_JP' %}
132+
Japanese
133+
{% elif language_code == 'ko' %}
134+
Korean
135+
{% elif language_code == 'mn' %}
136+
Mongolian
137+
{% elif language_code == 'nb_NO' %}
138+
Norwegian (NB)
139+
{% elif language_code == 'nl' %}
140+
Dutch
141+
{% elif language_code == 'nn' %}
142+
Norwegian (NN)
143+
{% elif language_code == 'pl' %}
144+
Polish
145+
{% elif language_code == 'pt_PT' %}
146+
Portuguese
147+
{% elif language_code == 'pt_BR' %}
148+
Portuguese (BR)
149+
{% elif language_code == 'ro' %}
150+
Romanian
151+
{% elif language_code == 'ru' %}
152+
Russian
153+
{% elif language_code == 'si' %}
154+
Sinhala
155+
{% elif language_code == 'sk_SK' %}
156+
Slovakian
157+
{% elif language_code == 'sq' %}
158+
Albanian
159+
{% elif language_code == 'sr' %}
160+
Slovenian
161+
{% elif language_code == 'sv' %}
162+
Swedish
163+
{% elif language_code == 'ta' %}
164+
Tamil
165+
{% elif language_code == 'tr' %}
166+
Turkish
167+
{% elif language_code == 'uk' %}
168+
Ukrainian
169+
{% elif language_code == 'uz' %}
170+
Uzbek
171+
{% elif language_code == 'vi' %}
172+
Vietnamese
173+
{% elif language_code == 'zh_CN' %}
174+
Chinese
175+
{% elif language_code == 'zh_HK' %}
176+
Chinese (HK)
177+
{% elif language_code == 'zh_TW' %}
178+
Chinese (TW)
179+
{% else %}
180+
{{ language_code }}
181+
{% endif %}
182+
</a>
183+
</dd>
184+
{% endfor %}
13185
</dl>
14186
</div>
15187
<div class="rst-other-versions">
16188
<dl>
17-
<dt>{{ _('Versions') }}</dt>
18-
{% for slug, url in versions %}
19-
<dd><a href="{{ url }}">{{ slug }}</a></dd>
189+
<dt>☁️ {{ _('Versions') }}</dt>
190+
{% for slug, url in versions|reverse %}
191+
<dd style="width: 32%">
192+
<a href="{{ url }}"
193+
{% if current_version == slug %}
194+
style="color: var(--dark-link-color);"
195+
{% endif %}
196+
>
197+
{{ slug }}
198+
</a>
199+
</dd>
20200
{% endfor %}
21201
</dl>
22202
<dl>

‎user_manual/conf.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -308,6 +308,9 @@
308308
html_context['versions'] = generateVersionsDocs(current_docs)
309309
html_context['theme_vcs_pageview_mode'] += current_docs
310310

311+
html_context['available_languages'] = [
312+
]
313+
311314
# translation
312315
locale_dirs = ['locale/'] # path is example but recommended.
313316
gettext_compact = False # optional.

0 commit comments

Comments
 (0)