Mercurial > mplayer.hg

comparison DOCS/tech/translations.txt @ 26655:733f7ac7a855

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Move some blocks around for better text structuring.
author diego
date Thu, 08 May 2008 00:04:27 +0000
parents 12da50bb6292
children ceb7404032e2
comparison
equal deleted inserted replaced
26654:12da50bb6292 26655:733f7ac7a855
5 We always welcome new translations, but please be aware that 5 We always welcome new translations, but please be aware that
6 translations are not just one time jobs. They have to be maintained 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 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 8 obsolete, useless cruft. That said, we would be happy if you could
9 maintain a new documentation translation. 9 maintain a new documentation translation.
10
11 Experience shows that translations work best when done by teams. Not only
12 can the workload be shared, but there is also the chance to review the
13 translation. So if possible try to find more people to help out with
14 translating.
15
16 Furthermore, if you take over an unmaintained translation, bring the existing
17 parts up-to-date before translating new ones. Outdated information is worse
18 than missing information. For console messages and the XML documentation,
19 missing parts are automatically replaced by the English versions.
10 20
11 Documentation related discussions happen on the MPlayer-DOCS mailing list, 21 Documentation related discussions happen on the MPlayer-DOCS mailing list,
12 while documentation translation related discussions happen on the 22 while documentation translation related discussions happen on the
13 MPlayer-translations mailing list. If you want to maintain a translation 23 MPlayer-translations mailing list. If you want to maintain a translation
14 you should subscribe to both, as the English documentation Subversion 24 you should subscribe to both, as the English documentation Subversion
19 http://lists.mplayerhq.hu/mailman/listinfo/mplayer-translations 29 http://lists.mplayerhq.hu/mailman/listinfo/mplayer-translations
20 30
21 Send updates and patches to this mailing list or directly to the translation 31 Send updates and patches to this mailing list or directly to the translation
22 coordination maintainer, see DOCS/tech/MAINTAINERS for details. 32 coordination maintainer, see DOCS/tech/MAINTAINERS for details.
23 33
24 Experience shows that translations work best when done by teams. Not only
25 can the workload be shared, but there is also the chance to review the
26 translation. So if possible try to find more people to help out with
27 translating.
28
29 Furthermore, if you take over an unmaintained translation, bring the existing
30 parts up-to-date before translating new ones. Outdated information is worse
31 than missing information. For console messages and the XML documentation,
32 missing parts are automatically replaced by the English versions.
33
34 Translations of MPlayer documentation consist of 3 parts in descending 34 Translations of MPlayer documentation consist of 3 parts in descending
35 order of importance: 35 order of importance:
36 36
37 1) console messages (help/help_mp-XX.h) 37 1) console messages (help/help_mp-XX.h)
38 2) man page 38 2) man page
39 3) XML documentation 39 3) XML documentation
40 40
41 Please note that only doing 1) or 1) + 2) is perfectly fine. 41 Please note that only doing 1) or 1) + 2) is perfectly fine.
42
43
44 general:
45 ~~~~~~~~
46
47 Please note that the help_mp files and the XML documentation are both encoded
48 in UTF-8. Editing these files in a program which uses a different encoding
49 will result in breaking console messages and HTML.
50
51 Translations are for documentation what porting is for code. Many more eyes
52 see it and get to find mistakes. If you stumble over mistakes, inaccuracies,
53 clumsy wording, spelling/grammar errors or if you notice that something is
54 incomplete, please let us know, we'll fix it. Patches are more than welcome,
55 of course. Do not, however, change the translation first, please get your
56 update into the English version first.
57
58 If you have Subversion write access and commit a translation update, use
59 something like "synced with rXXX" as first line of the commit message so
60 that it is possible to tell with a glance at the Subversion log or ViewVC
61 if the translation is outdated and which revision of the English master
62 file it is equivalent to.
63
64 If you make (spelling/wording/consistency/etc) changes to a file without
65 adapting parts that changed in the English master file, leave the sync
66 tag as it is.
42 67
43 68
44 console messages: 69 console messages:
45 ~~~~~~~~~~~~~~~~~ 70 ~~~~~~~~~~~~~~~~~
46 71
83 to the file header, replacing XXX with the revision of help_mp-en.h that your 108 to the file header, replacing XXX with the revision of help_mp-en.h that your
84 translation is in sync with. This way we can easily tell if the translation 109 translation is in sync with. This way we can easily tell if the translation
85 is up to date or not. 110 is up to date or not.
86 111
87 112
88 general:
89 ~~~~~~~~
90
91 Please note that the help_mp files and the XML documentation are both encoded
92 in UTF-8. Editing these files in a program which uses a different encoding
93 will result in breaking console messages and HTML.
94
95 Translations are for documentation what porting is for code. Many more eyes
96 see it and get to find mistakes. If you stumble over mistakes, inaccuracies,
97 clumsy wording, spelling/grammar errors or if you notice that something is
98 incomplete, please let us know, we'll fix it. Patches are more than welcome,
99 of course. Do not, however, change the translation first, please get your
100 update into the English version first.
101
102 If you have Subversion write access and commit a translation update,
103 use something like "synced with rXXX" as first line of the commit message
104 so that it is possible to tell with a glance at the Subversion log or ViewVC
105 if the translation is outdated and which revision of the English master file
106 it is equivalent to.
107
108 If you make (spelling/wording/consistency/etc) changes to a file without
109 adapting parts that changed in the English master file, leave the sync
110 tag as it is.
111
112
113 XML documentation: 113 XML documentation:
114 ~~~~~~~~~~~~~~~~~~ 114 ~~~~~~~~~~~~~~~~~~
115 115
116 If you make changes to the XML documentation, doublecheck that the 116 If you make changes to the XML documentation, doublecheck that the
117 documentation still builds by running 'make' in the DOCS/xml/ subdirectory. 117 documentation still builds by running 'make' in the DOCS/xml/ subdirectory.