Skip to content

Commit adf9a3f

Browse files
committed
docs: Update translation guidelines to emphasize Weblate contributions [skip ci]
1 parent 391c7e5 commit adf9a3f

2 files changed

Lines changed: 58 additions & 16 deletions

File tree

docs/TRANSLATING.de.md

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,24 @@ Wir freuen uns über neue Übersetzungen!
1616

1717
---
1818

19-
## 🚀 Schnellstart
19+
## 🌐 Über Weblate übersetzen (Empfohlen)
20+
21+
Der einfachste Weg, Übersetzungen beizutragen, ist über **Weblate** — kein Programmieren nötig:
22+
23+
👉 **[Auf Weblate übersetzen](https://hosted.weblate.org/projects/simple-notes-sync/)**
24+
25+
1. Kostenloses Weblate-Konto erstellen
26+
2. Zum Simple Notes Sync Projekt navigieren
27+
3. Deine Sprache auswählen (oder eine neue anfordern)
28+
4. Direkt im Browser übersetzen
29+
30+
Weblate erstellt automatisch Pull Requests mit deinen Übersetzungen.
31+
32+
---
33+
34+
## 🚀 Manuelle Übersetzung (Alternative)
35+
36+
Wenn du lieber direkt mit den Quelldateien arbeitest:
2037

2138
### 1. Repository forken
2239

@@ -42,18 +59,20 @@ cp values/strings.xml values-fr/strings.xml
4259

4360
```xml
4461
<!-- Original (Englisch) -->
45-
<string name="app_name">Simple Notes</string>
62+
<string name="settings">Settings</string>
4663
<string name="notes_title">Notes</string>
4764

4865
<!-- Übersetzt (Französisch) -->
49-
<string name="app_name">Notes Simples</string>
66+
<string name="settings">Paramètres</string>
5067
<string name="notes_title">Notes</string>
5168
```
5269

5370
**Wichtig:**
5471
- Übersetze nur den Text zwischen `>` und `</string>`
5572
- Ändere NICHT die `name="..."` Attribute
73+
- Übersetze NICHT `app_name` — behalte es als "Simple Notes"
5674
- Behalte `%s`, `%d`, `%1$s` etc. als Platzhalter
75+
- Behalte Emoji-Zeichen (📝, ✅, etc.) unverändert
5776

5877
### 4. locales_config.xml aktualisieren
5978

@@ -93,24 +112,26 @@ android/app/src/main/res/
93112

94113
## 📝 String-Kategorien
95114

96-
Die `strings.xml` enthält etwa 400+ Strings, aufgeteilt in:
115+
Die `strings.xml` enthält etwa 440+ Strings (inklusive 5 Plurale), aufgeteilt in:
97116

98117
| Kategorie | Beschreibung | Anzahl |
99118
|-----------|--------------|--------|
100-
| UI Texte | Buttons, Labels, Titel | ~100 |
101-
| Settings | Alle 7 Einstellungs-Screens | ~150 |
119+
| UI Texte | Buttons, Labels, Titel | ~120 |
120+
| Settings | Alle Einstellungs-Screens | ~150 |
102121
| Dialoge | Bestätigungen, Fehler | ~80 |
103122
| Sync | Synchronisations-Meldungen | ~50 |
104-
| Sonstige | Tooltips, Accessibility | ~30 |
123+
| Sonstige | Tooltips, Accessibility, Widgets | ~40 |
105124

106125
---
107126

108127
## ✅ Qualitätscheckliste
109128

110-
Vor dem Pull Request:
129+
Vor dem Pull Request (nicht nötig für Weblate-Beiträge):
111130

112131
- [ ] Alle Strings übersetzt (keine englischen Reste)
132+
- [ ] `app_name` als "Simple Notes" beibehalten
113133
- [ ] Platzhalter (`%s`, `%d`) beibehalten
134+
- [ ] Emoji-Zeichen unverändert
114135
- [ ] Keine XML-Syntaxfehler
115136
- [ ] App startet ohne Crashes
116137
- [ ] Text passt in UI-Elemente (nicht zu lang)

docs/TRANSLATING.md

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,24 @@ We welcome new translations!
1616

1717
---
1818

19-
## 🚀 Quick Start
19+
## 🌐 Translate via Weblate (Recommended)
20+
21+
The easiest way to contribute translations is through **Weblate** — no coding required:
22+
23+
👉 **[Translate on Weblate](https://hosted.weblate.org/projects/simple-notes-sync/)**
24+
25+
1. Create a free Weblate account
26+
2. Browse to the Simple Notes Sync project
27+
3. Select your language (or request a new one)
28+
4. Start translating directly in the browser
29+
30+
Weblate automatically creates pull requests with your translations.
31+
32+
---
33+
34+
## 🚀 Manual Translation (Alternative)
35+
36+
If you prefer working directly with the source files:
2037

2138
### 1. Fork the Repository
2239

@@ -42,18 +59,20 @@ Open `values-fr/strings.xml` and translate all `<string>` entries:
4259

4360
```xml
4461
<!-- Original (English) -->
45-
<string name="app_name">Simple Notes</string>
62+
<string name="settings">Settings</string>
4663
<string name="notes_title">Notes</string>
4764

4865
<!-- Translated (French) -->
49-
<string name="app_name">Notes Simples</string>
66+
<string name="settings">Paramètres</string>
5067
<string name="notes_title">Notes</string>
5168
```
5269

5370
**Important:**
5471
- Only translate text between `>` and `</string>`
5572
- Do NOT change `name="..."` attributes
73+
- Do NOT translate `app_name` — keep it as "Simple Notes"
5674
- Keep `%s`, `%d`, `%1$s` etc. as placeholders
75+
- Keep emoji characters (📝, ✅, etc.) unchanged
5776

5877
### 4. Update locales_config.xml
5978

@@ -93,24 +112,26 @@ android/app/src/main/res/
93112

94113
## 📝 String Categories
95114

96-
The `strings.xml` contains about 400+ strings, divided into:
115+
The `strings.xml` contains about 440+ strings (including 5 plurals), divided into:
97116

98117
| Category | Description | Count |
99118
|----------|-------------|-------|
100-
| UI Texts | Buttons, labels, titles | ~100 |
101-
| Settings | All 7 settings screens | ~150 |
119+
| UI Texts | Buttons, labels, titles | ~120 |
120+
| Settings | All settings screens | ~150 |
102121
| Dialogs | Confirmations, errors | ~80 |
103122
| Sync | Synchronization messages | ~50 |
104-
| Other | Tooltips, accessibility | ~30 |
123+
| Other | Tooltips, accessibility, widgets | ~40 |
105124

106125
---
107126

108127
## ✅ Quality Checklist
109128

110-
Before creating your Pull Request:
129+
Before creating your Pull Request (not needed for Weblate contributions):
111130

112131
- [ ] All strings translated (no English leftovers)
132+
- [ ] `app_name` left as "Simple Notes"
113133
- [ ] Placeholders (`%s`, `%d`) preserved
134+
- [ ] Emoji characters unchanged
114135
- [ ] No XML syntax errors
115136
- [ ] App launches without crashes
116137
- [ ] Text fits in UI elements (not too long)

0 commit comments

Comments
 (0)