Mercurial > mplayer.hg
annotate DOCS/tech/translations.txt @ 20233:ced7b10bbe9c
missing console messages are (also) replaced by English versions
author | kraymer |
---|---|
date | Sun, 15 Oct 2006 14:35:18 +0000 |
parents | 914fe29129be |
children | 6709c50d063e |
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 |
19657 | 14 you should subscribe to both, as the English documentation Subversion |
15 changelogs, which you need to keep the translation up to date, are sent | |
16 to MPlayer-DOCS. You can subscribe here: | |
11809 | 17 |
20232 | 18 http://lists.mplayerhq.hu/mailman/listinfo/mplayer-docs |
19 http://lists.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 | |
19658
5e98034a49ec
Add note about translating in teams and taking over unmaintained translations.
diego
parents:
19657
diff
changeset
|
24 Experience shows that translations work best when done by teams. Not only |
5e98034a49ec
Add note about translating in teams and taking over unmaintained translations.
diego
parents:
19657
diff
changeset
|
25 can the workload be shared, but there is also the chance to review the |
5e98034a49ec
Add note about translating in teams and taking over unmaintained translations.
diego
parents:
19657
diff
changeset
|
26 translation. So if possible try to find more people to help out with |
5e98034a49ec
Add note about translating in teams and taking over unmaintained translations.
diego
parents:
19657
diff
changeset
|
27 translating. |
5e98034a49ec
Add note about translating in teams and taking over unmaintained translations.
diego
parents:
19657
diff
changeset
|
28 |
5e98034a49ec
Add note about translating in teams and taking over unmaintained translations.
diego
parents:
19657
diff
changeset
|
29 Furthermore, if you take over an unmaintained translation, bring the existing |
5e98034a49ec
Add note about translating in teams and taking over unmaintained translations.
diego
parents:
19657
diff
changeset
|
30 parts up-to-date before translating new ones. Outdated information is worse |
20233
ced7b10bbe9c
missing console messages are (also) replaced by English versions
kraymer
parents:
20232
diff
changeset
|
31 than missing information. For console messages and the XML documentation |
ced7b10bbe9c
missing console messages are (also) replaced by English versions
kraymer
parents:
20232
diff
changeset
|
32 missing parts are automatically replaced by the English versions. |
19658
5e98034a49ec
Add note about translating in teams and taking over unmaintained translations.
diego
parents:
19657
diff
changeset
|
33 |
11809 | 34 Translations of MPlayer documentation consist of 3 parts in descending |
35 order of importance: | |
36 | |
37 1) console messages (help/help_mp-XX.h) | |
38 2) man page | |
39 3) XML documentation | |
40 | |
41 Please note that only doing 1) or 1) + 2) is perfectly fine. | |
42 | |
19657 | 43 You can find the latest versions of the help_mp-XX.h files in Subversion or |
11809 | 44 here: |
45 | |
18750 | 46 http://svn.mplayerhq.hu/mplayer/trunk/help/ |
11809 | 47 |
48 help_mp-en.h is the master file that you should use as a base for translations. | |
49 If you are adopting an already existing translation, please check it from top | |
18539 | 50 to bottom once. Later it should suffice to just translate missing messages. |
51 Additionally, please make sure that your translated messages fit on an 80 | |
52 character wide display to avoid overflowing output. | |
53 | |
54 TOOLS/mphelp_check.py is a small tool to check translated files. It will report | |
55 conflicting arguments, strings not present in the master file and (optionally) | |
56 strings missing from the translation. Running it as | |
11809 | 57 |
18539 | 58 mphelp_check.py help_mp-en.h help_mp-XX.h |
59 | |
60 will output errors to the screen, just substitute XX with your language code. | |
11809 | 61 |
18539 | 62 mphelp_check.py -missing help_mp-en.h help_mp-XX.h |
63 | |
64 will additionally print untranslated messages to the screen. | |
11809 | 65 |
12091
c67c28e4992e
How to handle incomplete translations of message files.
diego
parents:
11809
diff
changeset
|
66 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
|
67 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
|
68 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
|
69 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
|
70 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
|
71 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
|
72 missing messages, which eases further translation. |
c67c28e4992e
How to handle incomplete translations of message files.
diego
parents:
11809
diff
changeset
|
73 |
16791
fe601b7b10c8
Add a note about the "synce with 1.XXX" line that should be in every
diego
parents:
16120
diff
changeset
|
74 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
|
75 |
19704
338961243006
Some more CVS --> Subversion changes, explain what to do with the sync tag
diego
parents:
19658
diff
changeset
|
76 /* Synced with help_mp-en.h rXXX */ |
16791
fe601b7b10c8
Add a note about the "synce with 1.XXX" line that should be in every
diego
parents:
16120
diff
changeset
|
77 |
fe601b7b10c8
Add a note about the "synce with 1.XXX" line that should be in every
diego
parents:
16120
diff
changeset
|
78 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
|
79 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
|
80 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
|
81 |
11809 | 82 Translations are for documentation what porting is for code. Many more eyes |
83 see it and get to find mistakes. If you stumble over mistakes, inaccuracies, | |
84 clumsy wording, spelling/grammar errors or if you notice that something is | |
85 incomplete, please let us know, we'll fix it. Patches are more than welcome, | |
13065 | 86 of course. Do not, however, change the translation first, please get your |
87 update into the English version first. | |
14558 | 88 |
19657 | 89 If you have Subversion write access and commit a translation update file, |
19704
338961243006
Some more CVS --> Subversion changes, explain what to do with the sync tag
diego
parents:
19658
diff
changeset
|
90 use something like "synced with rXXX" as first line of the commit message |
338961243006
Some more CVS --> Subversion changes, explain what to do with the sync tag
diego
parents:
19658
diff
changeset
|
91 so that it is possible to tell with a glance at the Subversion log or ViewVC |
338961243006
Some more CVS --> Subversion changes, explain what to do with the sync tag
diego
parents:
19658
diff
changeset
|
92 if the translation is outdated and which revision of the English master file |
19657 | 93 it is equivalent to. |
19704
338961243006
Some more CVS --> Subversion changes, explain what to do with the sync tag
diego
parents:
19658
diff
changeset
|
94 |
338961243006
Some more CVS --> Subversion changes, explain what to do with the sync tag
diego
parents:
19658
diff
changeset
|
95 If you make (spelling/wording/consistency/etc) changes to a file without |
338961243006
Some more CVS --> Subversion changes, explain what to do with the sync tag
diego
parents:
19658
diff
changeset
|
96 adapting parts that changed in the English master file, leave the sync |
338961243006
Some more CVS --> Subversion changes, explain what to do with the sync tag
diego
parents:
19658
diff
changeset
|
97 tag as it is. |
20025 | 98 |
99 If you make changes to the XML documentation, doublecheck that the | |
100 documentation still builds by running make. |