Mercurial > mplayer.hg
annotate DOCS/tech/translations.txt @ 17865:47403d56ab6d
synced with 1.224
author | gabrov |
---|---|
date | Tue, 14 Mar 2006 21:21:26 +0000 |
parents | fe601b7b10c8 |
children | 625b642df80d |
rev | line source |
---|---|
11809 | 1 ________________________________________ |
2 HOW TO DO A GOOD TRANSLATION FOR MPLAYER | |
3 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
4 | |
5 We always welcome new translations, but please be aware that | |
6 translations are not just one time jobs. They have to be maintained | |
7 in order to be useful. Otherwise they quickly get outdated and become | |
8 obsolete, useless cruft. That said, we would be happy if you could | |
9 maintain a new documentation translation. | |
10 | |
16120
cc8e5b36f1ed
Mention the MPlayer-translations mailing list and explain the difference
diego
parents:
14558
diff
changeset
|
11 Documentation related discussions happen on the MPlayer-DOCS mailing list, |
cc8e5b36f1ed
Mention the MPlayer-translations mailing list and explain the difference
diego
parents:
14558
diff
changeset
|
12 while documentation translation related discussions happen on the |
cc8e5b36f1ed
Mention the MPlayer-translations mailing list and explain the difference
diego
parents:
14558
diff
changeset
|
13 MPlayer-translations mailing list. If you want to maintain a translation |
cc8e5b36f1ed
Mention the MPlayer-translations mailing list and explain the difference
diego
parents:
14558
diff
changeset
|
14 you should subscribe to both, as the English documentation CVS changelogs, |
cc8e5b36f1ed
Mention the MPlayer-translations mailing list and explain the difference
diego
parents:
14558
diff
changeset
|
15 which you need to keep the translation up to date, are sent to MPlayer-DOCS. |
cc8e5b36f1ed
Mention the MPlayer-translations mailing list and explain the difference
diego
parents:
14558
diff
changeset
|
16 You can subscribe here: |
11809 | 17 |
18 http://mplayerhq.hu/mailman/listinfo/mplayer-docs | |
16120
cc8e5b36f1ed
Mention the MPlayer-translations mailing list and explain the difference
diego
parents:
14558
diff
changeset
|
19 http://mplayerhq.hu/mailman/listinfo/mplayer-translations |
11809 | 20 |
21 Send updates and patches to this mailing list or directly to the documentation | |
22 or console message maintainers, see DOCS/tech/MAINTAINERS for details. | |
23 | |
24 Translations of MPlayer documentation consist of 3 parts in descending | |
25 order of importance: | |
26 | |
27 1) console messages (help/help_mp-XX.h) | |
28 2) man page | |
29 3) XML documentation | |
30 | |
31 Please note that only doing 1) or 1) + 2) is perfectly fine. | |
32 | |
33 You can find the latest versions of the help_mp-XX.h files in CVS or | |
34 here: | |
35 | |
36 http://www.mplayerhq.hu/cgi-bin/cvsweb.cgi/main/help/ | |
37 | |
38 help_mp-en.h is the master file that you should use as a base for translations. | |
39 If you are adopting an already existing translation, please check it from top | |
40 to bottom once. Later it should suffice to just translate missing messages. If | |
41 you want to check for untranslated messages the help/help-diff.sh script comes | |
42 in handy: | |
43 | |
44 help_diff.sh help_mp-XX.h < help_mp-en.h | |
45 | |
46 will print untranslated messages to the screen, just substitute XX with your | |
47 language code. Additionally, please make sure that your translated messages fit | |
48 on an 80 character wide display to avoid overflowing output. | |
49 | |
12091
c67c28e4992e
How to handle incomplete translations of message files.
diego
parents:
11809
diff
changeset
|
50 If you do not translate all messages at once, please do not leave untranslated |
c67c28e4992e
How to handle incomplete translations of message files.
diego
parents:
11809
diff
changeset
|
51 messages in your translated file, just leave them out instead. The MPlayer |
c67c28e4992e
How to handle incomplete translations of message files.
diego
parents:
11809
diff
changeset
|
52 build system automatically checks for missing messages and uses the English |
c67c28e4992e
How to handle incomplete translations of message files.
diego
parents:
11809
diff
changeset
|
53 ones instead. This has the added advantage of providing the latest versions of |
c67c28e4992e
How to handle incomplete translations of message files.
diego
parents:
11809
diff
changeset
|
54 the English messages, since English messages in translations may be outdated. |
c67c28e4992e
How to handle incomplete translations of message files.
diego
parents:
11809
diff
changeset
|
55 Furthermore, running help_diff.sh on your translated file will immediately show |
c67c28e4992e
How to handle incomplete translations of message files.
diego
parents:
11809
diff
changeset
|
56 missing messages, which eases further translation. |
c67c28e4992e
How to handle incomplete translations of message files.
diego
parents:
11809
diff
changeset
|
57 |
16791
fe601b7b10c8
Add a note about the "synce with 1.XXX" line that should be in every
diego
parents:
16120
diff
changeset
|
58 If no messages are missing, please add a line similar to |
fe601b7b10c8
Add a note about the "synce with 1.XXX" line that should be in every
diego
parents:
16120
diff
changeset
|
59 |
fe601b7b10c8
Add a note about the "synce with 1.XXX" line that should be in every
diego
parents:
16120
diff
changeset
|
60 /* Synced with help_mp-en.h 1.XXX */ |
fe601b7b10c8
Add a note about the "synce with 1.XXX" line that should be in every
diego
parents:
16120
diff
changeset
|
61 |
fe601b7b10c8
Add a note about the "synce with 1.XXX" line that should be in every
diego
parents:
16120
diff
changeset
|
62 to the file header, replacing XXX with the revision of help_mp-en.h that your |
fe601b7b10c8
Add a note about the "synce with 1.XXX" line that should be in every
diego
parents:
16120
diff
changeset
|
63 translation is in sync with. This way we can easily tell if the translation |
fe601b7b10c8
Add a note about the "synce with 1.XXX" line that should be in every
diego
parents:
16120
diff
changeset
|
64 is up to date or not. |
fe601b7b10c8
Add a note about the "synce with 1.XXX" line that should be in every
diego
parents:
16120
diff
changeset
|
65 |
11809 | 66 Translations are for documentation what porting is for code. Many more eyes |
67 see it and get to find mistakes. If you stumble over mistakes, inaccuracies, | |
68 clumsy wording, spelling/grammar errors or if you notice that something is | |
69 incomplete, please let us know, we'll fix it. Patches are more than welcome, | |
13065 | 70 of course. Do not, however, change the translation first, please get your |
71 update into the English version first. | |
14558 | 72 |
73 If you have CVS access and commit a translation update file, use something like | |
74 "synced with 1.XXX" as first line of the commit message so that it is possible | |
75 to tell with a glance at the cvs log or viewcvs if the translation is outdated | |
76 and which revision of the English master file it is equivalent to. |