Skip to content

Commit

Permalink
Correct links and headers
Browse files Browse the repository at this point in the history
  • Loading branch information
ignotus666 committed Aug 5, 2022
1 parent d73b82e commit 10cfc72
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ This is the content repository for [jamulus.io](https://jamulus.io). Text appear
<a href="https://hosted.weblate.org/engage/jamulus/">
<img src="https://hosted.weblate.org/widgets/jamulus/-/multi-auto.svg" alt="Translation status" />
</a>

The Jamulus website is translated using [Weblate](https://hosted.weblate.org/engage/jamulus/). If you prefer you may also submit translations via Pull Requests. Note that translating the Jamulus application itself is done by a different process, but you are welcome to help with that too. Introduce yourself on the [GitHub Discussion](https://github.com/jamulussoftware/jamulus/discussions) and say what you’d like to do.

***PLEASE NOTE:*** Discussions should be in English so as to be open to all.
Expand Down
6 changes: 3 additions & 3 deletions _translator-files/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

The recommended way to translate the website documentation is by using [Weblate](https://hosted.weblate.org/projects/jamulus/). If you are comfortable using GitHub and .po file editors, and still want to contribute your translation via a Pull Request, the files for each language are contained in: `_translator-files/po/LANGUAGE/`. You can find a guide on .po file editors [here](https://jamulus.io/kb/2022/08/04/Translating-po-files.html). Please make your PR against the `next-release` branch.

#####Some tips regarding translations:
**Some tips regarding translations:**

- Change the `lang: en` parameter in the files containing it at the beginning of the file to your language code (it, fr, de, etc.) and make sure the `permalink: [parameter]` (e.g. /wiki/Client-Troubleshooting) stays the same.
- At times there are links to other docs or specific paragraphs in other parts of the website: `[translate this](don't translate this#translate-this-but-don't-use-capitals)`. Make sure the last part uses the exact same words as the relevant paragraph title.
- Some documents contain links to screenshots. Make sure you change the language code in them to your own. You can create screenshots for your language in `/assets/img/[LANG]-screenshots` - note that we do not store these image locally but instead use include files calling an external URL to them. Please see README.md on the website repository for further information. Also note that screenshots that do not need to be localised are symlinked to the English version from each `[LANG]-screenshots` directory.
- There are documents containing portions of text that do not require translation, e.g. scripts, links, etc. In these cases, please do not leave the translation field empty, but copy the source text into the translation field.
- Pull Requests for translations should have a title which looks like this: `Update [lang] web translation for [release number]`

#### Please note: if your language has no translated documents, please start with the following:
**Please note: if your language has no translated documents, please start with the following:**

- 1-index.po
- general.po
Expand All @@ -27,4 +27,4 @@ Open an issue ([here](https://github.com/jamulussoftware/jamuluswebsite/issues))
- Lower case if it is a two-character code (e.g. "Add Basque [eu]")
- Lower case + underscore + upper case for regional variations (e.g. "Add Brazilian Portuguese [pt_BR]").

You will be notified on the issue thread you opened when the language files have been created. You can then work on the translations.
You will be notified on the issue thread you opened when the language files have been created. You can then work on the translations.

0 comments on commit 10cfc72

Please sign in to comment.