Skip to content

Commit f0c608b

Browse files
[add] i18n glossary and unify admonition titles
- add i18n/GLOSSARY.md with canonical translations of recurring template phrases (section labels, headings, version notes, admonition titles) for ru/de/ko/zh - unify theme.admonition.* labels in code.json: consistent capitalization for ru/de, drop caution/warning duplicates (ru danger→Опасно, caution→Осторожно; de nouns capitalized; zh caution→注意)
1 parent e6cc55d commit f0c608b

4 files changed

Lines changed: 84 additions & 10 deletions

File tree

‎i18n/GLOSSARY.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Translation Glossary — All documentation template phrases
2+
3+
Purpose: a single reference for translations of recurring template phrases in the documentation
4+
([../docs/](../docs/)). Consult it when translating new articles and when reviewing localizations —
5+
the wording and markdown markup (`**...**`, `### ...`, full-width `:` for zh/ko) must match verbatim.
6+
7+
The **canonical** (most frequent) variant is given.
8+
9+
---
10+
11+
## 1. Section labels (bold lead before a list)
12+
13+
| EN | ru | de | ko | zh |
14+
|---|---|---|---|---|
15+
| `**Related articles:**` | `**Полезные статьи:**` | `**Verwandte Artikel:**` | `**관련 문서:**` | `**相关文章:**` |
16+
| `**Related article:**` | `**Полезная статья:**` | `**Verwandter Artikel:**` | `**관련 문서:**` | `**相关文章:**` |
17+
| `**Related sample:**` | `**Связанный пример:**` | `**Verwandtes Beispiel:**` | `**관련 샘플:**` | `**相关示例:**` |
18+
| `**Related samples:**` | `**Связанные примеры:**` | `**Verwandte Beispiele:**` | `**관련 예제:**` | `**相关示例:**` |
19+
| `**Related API:**` | `**Похожее API:**` | `**Verwandte API:**` | `**관련 API:**` | `**相关 API:**` |
20+
| `**Change log:**` | `**Журнал изменений:**` | `**Changelog:**` | `**변경 로그:**` | `**更新日志:**` |
21+
| `**Example:**` | `**Пример:**` | `**Beispiel:**` | `**예제:**` | `**示例:**` |
22+
| `**Example on GitHub**` | `**Пример на GitHub**` | `**Beispiel auf GitHub**` | `**GitHub 예제**` | `**GitHub 示例**` |
23+
24+
## 2. Section headings (API-page template)
25+
26+
| EN | ru | de | ko | zh |
27+
|---|---|---|---|---|
28+
| `### Description` | `### Описание` | `### Beschreibung` | `### 설명` | `### 描述` |
29+
| `### Usage` | `### Использование` | `### Verwendung` | `### 사용법` | `### 用法` |
30+
| `### Example` | `### Пример` | `### Beispiel` | `### 예제` | `### 示例` |
31+
| `### Parameters` | `### Параметры` | `### Parameter` | `### 매개변수` | `### 参数` |
32+
| `### Returns` | `### Возвращаемое значение` | `### Rückgabewert` | `### 반환값` | `### 返回值` |
33+
| `### Fixes` | `### Исправления` | `### Fehlerbehebungen` | `### 수정 사항` | `### 修复` |
34+
| `### New functionality` | `### Новый функционал` | `### Neue Funktionalität` | `### 새로운 기능` | `### 新功能` |
35+
| `### Updates` | `### Обновления` | `### Aktualisierungen` | `### 업데이트` | `### 更新` |
36+
| `### Default config` | `### Конфигурация по умолчанию` | `### Standardkonfiguration` | `### 기본 설정` | `### 默认配置` |
37+
| `### Breaking changes` | `### Критические изменения` | `### Breaking Changes` | `### 주요 변경 사항` | `### 重大变更` |
38+
| `## Related API and guides` | `## Связанные API и гайды` | `## Verwandte API und Anleitungen` | `## 관련 API 및 가이드` | `## 相关 API 和指南` |
39+
| `## What's next` | `## Что дальше` | `## Wie geht es weiter` | `## 다음 단계` | `## 下一步` |
40+
| `## API reference` | `## Справочник API` | `## API-Referenz` | `## API 참조` | `## API 参考` |
41+
42+
## 3. Version notes (inside `**Change log:**`)
43+
44+
Format `<Action> in vX.X` — the "action" word is translated, the version number stays as is.
45+
46+
The forms below are verified against actual occurrences in the locales (e.g. `Добавлено в v5.2`,
47+
`v5.2에서 추가`, `v5.2 中新增`). The version number is not translated.
48+
49+
| EN | ru | de | ko | zh |
50+
|---|---|---|---|---|
51+
| `Added in vX.X` | `Добавлено в vX.X` | `Hinzugefügt in vX.X` | `vX.X에서 추가` | `vX.X 中新增` |
52+
| `Updated in vX.X` | `Обновлено в vX.X` | `Aktualisiert in vX.X` | `vX.X에서 업데이트` | `vX.X 中更新` |
53+
| `Deprecated in vX.X` | `Устарело в vX.X` | `Veraltet in vX.X` | `vX.X에서 지원 중단` | `vX.X 中弃用` |
54+
| `Removed in vX.X` | `Удалено в vX.X` | `Entfernt in vX.X` | `vX.X에서 제거` | `vX.X 中移除` |
55+
| `Starting from vX.X, …` | `Начиная с vX.X, …` | `Ab vX.X …` | `vX.X부터 …` | `从 vX.X 起,…` |
56+
57+
## 4. Admonition block titles (`:::note`, `:::tip` …)
58+
59+
The titles of these blocks come **not from markdown**, but from the `theme.admonition.*` keys in
60+
`i18n/<locale>/code.json` (in EN — Docusaurus built-in defaults). In `.md` the block type (`:::note`,
61+
`:::tip`, …) is not translated — only the `message` in `code.json` changes.
62+
63+
The Docusaurus theme renders the title with `text-transform: uppercase`, so for ru/de the visible
64+
title is always UPPERCASE, while ko/zh have no letter case. Canon: **capitalized first letter**, with
65+
words distinct between types (no `caution`/`warning` duplicates).
66+
67+
| Type | ru | de | ko | zh |
68+
|---|---|---|---|---|
69+
| `:::note` | `Примечание` | `Hinweis` | `노트` | `备注` |
70+
| `:::tip` | `Подсказка` | `Tipp` | `팁` | `提示` |
71+
| `:::info` | `К сведению` | `Info` | `정보` | `信息` |
72+
| `:::warning` | `Предупреждение` | `Warnung` | `경고` | `警告` |
73+
| `:::caution` | `Осторожно` | `Vorsicht` | `주의` | `注意` |
74+
| `:::danger` | `Опасно` | `Gefahr` | `위험` | `危险` |

‎i18n/de/code.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -139,23 +139,23 @@
139139
"description": "The label alongside a tag list"
140140
},
141141
"theme.admonition.caution": {
142-
"message": "vorsicht",
142+
"message": "Vorsicht",
143143
"description": "The default label used for the Caution admonition (:::caution)"
144144
},
145145
"theme.admonition.danger": {
146-
"message": "gefahr",
146+
"message": "Gefahr",
147147
"description": "The default label used for the Danger admonition (:::danger)"
148148
},
149149
"theme.admonition.info": {
150150
"message": "Info",
151151
"description": "The default label used for the Info admonition (:::info)"
152152
},
153153
"theme.admonition.note": {
154-
"message": "hinweis",
154+
"message": "Hinweis",
155155
"description": "The default label used for the Note admonition (:::note)"
156156
},
157157
"theme.admonition.tip": {
158-
"message": "tipp",
158+
"message": "Tipp",
159159
"description": "The default label used for the Tip admonition (:::tip)"
160160
},
161161
"theme.admonition.warning": {

‎i18n/ru/code.json‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -139,23 +139,23 @@
139139
"description": "The label alongside a tag list"
140140
},
141141
"theme.admonition.caution": {
142-
"message": "предупреждение",
142+
"message": "Осторожно",
143143
"description": "The default label used for the Caution admonition (:::caution)"
144144
},
145145
"theme.admonition.danger": {
146-
"message": "осторожно",
146+
"message": "Опасно",
147147
"description": "The default label used for the Danger admonition (:::danger)"
148148
},
149149
"theme.admonition.info": {
150-
"message": "к сведению",
150+
"message": "К сведению",
151151
"description": "The default label used for the Info admonition (:::info)"
152152
},
153153
"theme.admonition.note": {
154-
"message": "примечание",
154+
"message": "Примечание",
155155
"description": "The default label used for the Note admonition (:::note)"
156156
},
157157
"theme.admonition.tip": {
158-
"message": "подсказка",
158+
"message": "Подсказка",
159159
"description": "The default label used for the Tip admonition (:::tip)"
160160
},
161161
"theme.admonition.warning": {

‎i18n/zh/code.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@
139139
"description": "The label alongside a tag list"
140140
},
141141
"theme.admonition.caution": {
142-
"message": "警告",
142+
"message": "注意",
143143
"description": "The default label used for the Caution admonition (:::caution)"
144144
},
145145
"theme.admonition.danger": {

0 commit comments

Comments
 (0)