Kartei icon indicating copy to clipboard operation
Kartei copied to clipboard

Published 20 hours ago • verified publisher icon kellertuer

Translating manual / README into English

Open mandarg opened this issue 7 years ago • 6 comments

Hi,

I found your package while looking for a LaTeX package for flashcards, and so far, it seems like exactly the sort of thing I was looking for.

I would like to help by translating as much of the instructions, etc. as I can into English – so perhaps it can become accessible to a wider audience.

Firstly, would you be interested a pull request for such a translation? I have an example translation of the first page of the manual in my fork. Your project page does mention Instructions in English.

If the answer to the above is yes, what do you think would be the best way to go about doing this? I can see a few options:

  1. Retain single files (e.g. README.md, manual.pdf, and just have sections of German and English text in each.

  2. Have separate files for English and German README.md, README-en.md, manual-en.pdf, etc. (This is the approach I am currently taking in my repo).

  3. Simply maintain a different branch in Git for the English translation, and (I'm not quite sure how this would work) generate -en releases from it or something.

  4. Something else?

Anyway, let me know what you think!

mandarg avatar Mar 21 '17 02:03 mandarg

Oh that sounds like an awesome idea, I always wanted to translate is but never got the time to. I think it would be good to habe one readme (first english then german block) and two manuals; but one branch. The only thing I am not so sure about is whether we should be equally authors of the manuscript; just because I don't know how other LaTeX projects do that. I'll check for that but I think it would be nicer to have you mentioned as „translated to english by“ or something?

kellertuer avatar Mar 21 '17 17:03 kellertuer

Thanks for answering all my questions perfectly!

I don't care about the authors thing, I'll remove my name from the \author and maybe add a footnote somewhere if (hopefully when) I finish the translation.

mandarg avatar Mar 22 '17 01:03 mandarg

It does not have to be a footnote, just a was to distinguish between coding and manual :) Im fine e.g. with

my name

translated to english by your name

:)

kellertuer avatar Mar 22 '17 07:03 kellertuer

@mandarg Are you still working on the translation?

It might be smart to translate the readme and the beispiel.tex first and only then start with the manual.

joelfischerr avatar Oct 16 '17 14:10 joelfischerr

@joelfischerr I haven't worked on it in a while; but translating the README and beispiel.tex first is a good idea. I'll get a PR up for that.

mandarg avatar Oct 17 '17 00:10 mandarg

Opened PR #14, which also fixes issue #11.

mandarg avatar Oct 17 '17 03:10 mandarg