Skip to content

Commit 8ac7ff2

Browse files
committed
📝 Add translation guide for achievements
1 parent 6a4855f commit 8ac7ff2

2 files changed

Lines changed: 41 additions & 3 deletions

File tree

src/assets/img/achievements.png

370 KB
Loading

src/content/docs/translating.mdx

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,19 @@
22
# SPDX-FileCopyrightText: Simon Schneegans <code@simonschneegans.de>
33
# SPDX-License-Identifier: CC-BY-4.0
44

5-
title: Translate Kando!
5+
title: Translating Kando
66
description: Translate Kando into your language.
7-
tableOfContents: false
87
sidebar:
98
order: 2
109
---
1110

1211
import { LinkButton } from '@astrojs/starlight/components';
1312
import Intro from '../../components/Intro.astro';
1413
import CustomAside from '../../components/CustomAside.astro';
14+
import {Image} from 'astro:assets';
15+
16+
17+
import achievements from '../../assets/img/achievements.png';
1518

1619
![banner](../../assets/banners/banner02.png)
1720

@@ -27,8 +30,43 @@ To get started, simply click the button below, create an account, and start tran
2730
</LinkButton>
2831
</Intro>
2932

33+
Nearly all strings on Weblate come with a context screenshot, so you can see where they are used in the application.
34+
In case something is not clear, feel free to ask for help on our [Discord Server](https://discord.gg/hZwbVSDkhy)!
35+
36+
The only real challenge will be the translation of the achievements.
37+
Hence, we have created a separate guide for this task below.
38+
39+
## Translating Achievements
40+
41+
Translating achievements can be a bit tricky, as several achievements contain placeholders for variables (like `{{n}}`, `{{tier}}`, or `{{attribute}}`) which will be replaced by strings which can be translated as well 🤯.
42+
43+
<Image src={achievements} alt="menu editor" class="shadow"/>
44+
<center><sup>Kando's achievement dialog.</sup></center>
45+
46+
The image above shows some typical achievements that can be translated.
47+
In the following, we will first explain the structure of _achievement names_ (the bold text above) and then the structure of _achievement descriptions_ (the normal text below the bold text).
48+
49+
### Achievement Names
50+
51+
Some achievement names contain either the placeholder `{{tier}}` or `{{attribute}}`.
52+
- In English, `{{tier}}` will be replaced by the roman numbers "I", "II", "III", "IV", or "V". For instance, in the screenshot above, the achievement "The Journey is the Reward IV" contains the placeholder `{{tier}}` at the end which was replaced by "IV". When translating this achievement name, make sure to keep the placeholder `{{tier}}` in the correct position for your language. The five tiers can be translated as well! So you do not have to keep the roman numbers if your language has a better way to express this.
53+
- The placeholder `{{attribute}}` will be replaced in a similar way. In English, it will be replaced by one of the words "Novice", "Capable", "Skilled", "Expert", or "Sensei". For instance, the "Skilled Slicer" achievement in the screenshot above contains the placeholder `{{attribute}}` at the beginning. So the user will progress from a "Novice Slicer" to a "Sensei Slicer" over time. Again, the five attributes can be translated as well!
54+
55+
As you can see, there's a lot of flexibility when translating achievement names.
56+
With some creativity, you can come up with great translations that fit your language perfectly!
57+
You do not have to stick to the English structure if your language allows for a better expression.
58+
59+
### Achievement Descriptions
60+
61+
Achievement descriptions often contain placeholders as well.
62+
Usually, it will be `{{n}}` which will be replaced by a number.
63+
However, there are also some more complex cases where multiple placeholders are used.
64+
For instance, the English string for the description of the "Skilled Slicer" achievement is `Select {{n}} items at depth {{depth}} in less than {{time}} ms`.
65+
66+
You can change the order of the placeholders in your translation if your language requires a different sentence structure.
67+
3068
<CustomAside type="thanks" title="Thank you!">
69+
If you made it this far: Thank you so much!
3170
Translating Kando into your language is a great way to contribute to the project.
32-
It is very easy to do and does not require any programming skills.
3371
At the same time, it is a very valuable contribution, as it makes Kando accessible to more people around the world.
3472
</CustomAside>

0 commit comments

Comments
 (0)