Skip to content

RumovZ/anki-manual-de_DE

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Best viewed on the website: https://rumovz.github.io/anki-manual-de_DE

This is a translation fork of the official Anki manual and accordingly licensed under the CC BY-SA 4 license:

https://creativecommons.org/licenses/by-sa/4.0/

Pull requests are welcome (see below). Unless you state otherwise, any pull requests you submit will be licensed under the above license.


Contributing

Contributions can be made in three ways.

  1. Translating a file. Please see #1 and conventions below.

  2. Improving an existing translation. A simple PR will do, but please see conventions below.

  3. Incorporating updates from the official manual. First, merge in the original manual (upstream):

    git fetch upstream
    git merge upstream/main

    There will be merge conflicts with any already translated files that have been updated in the original manual. The shown diff is usually not very helpful. Instead we are interested in the diff between the current state of upstream and the last merged in state (let's say we're on branch local):

    git diff local...upstream/main

    With that we can resolve the conflicts by updating the translation and discarding the incoming changes.

Conventions

Format

This list of conventions is to ensure easier synchronisation with the official manual, cleaner merges, and a consistent look.

  • Empty lines, heading placements, etc. in the official manual are to be preserved as much as possible. Single linebreaks (which are ignored in Markdown) may be used to the heart's content.
  • File names are not to be translated. Title translations are made in SUMMARY.md (in square brackets) and have to agree with the titles on the relevant pages.
  • Linebreaks should be inserted roughly after at most 100 characters.
  • Formatting, such as ` for code and <kbd></kbd> for key presses, may be improved, as it's not consistent in the official manual.

Translation

This list of conventions is to ensure a minimum of consistency within the manual. If you disagree with or want to add anything, feel free to open an issue.

  • Use "du" over "Sie".
  • Anglicisms are to be avoided. (Of course, that's quite often impossible.)
  • Translations should sound natural. Don't hesitate to deviate from the original, as long as the content remains the same. Updates to the content, however, must be made on https://github.com/ankitects/anki-manual before they can be integrated here.
  • Ideally, terms used in Anki should agree with the translations over on https://i18n.ankiweb.net/de/. Of course, improvements can be made there as well.

Tips

Previewing Changes

If you want to preview your local changes, you can install mdbook, put it in your PATH, and run mdbook serve -o from within your repository folder. The binaries and a more detailed description can be found under the link above. In order to render the table of contents at the top of some pages, mdbook-toc is needed as well, but this requires a Rust installation.