Added clone.txt
[gitmagic.git] / en / translate.txt
blobd1842cdf2b2ab9bf083f9e61f4ec6eea7add447b
1 == Appendix B: Translating This Guide ==
3 I recommend the following steps for translating this guide, so my scripts can
4 quickly produce HTML and PDF versions, and all translations can live in the
5 same repository.
7 Clone the source, then create a directory corresponding to the target
8 language's IETF tag: see
9 http://www.w3.org/International/articles/language-tags/Overview.en.php[the W3C
10 article on internationalization]. For example, English is "en" and Japanese is
11 "ja". In the new directory, and translate the +txt+ files from the "en"
12 subdirectory.
14 For instance, to translate the guide into http://en.wikipedia.org/wiki/Klingon_language[Klingon], you might type:
16  $ git clone git://repo.or.cz/gitmagic.git
17  $ cd gitmagic
18  $ mkdir tlh  # "tlh" is the IETF language code for Klingon.
19  $ cd tlh
20  $ cp ../en/intro.txt .
21  $ edit intro.txt  # Translate the file.
23 and so on for each text file.
25 Edit the Makefile and add the language code to the `TRANSLATIONS` variable.
26 You can now review your work incrementally:
28  $ make tlh
29  $ firefox book-tlh/index.html
31 Commit your changes often, then let me know when they're ready.
32 GitHub has an interface that facilitates this: fork the "gitmagic" project,
33 push your changes, then ask me to merge.