- Fixed the Filters plugin to allow commas in filter criteria text
[squirrelmail.git] / doc / translating_help.txt
CommitLineData
36c24f4f 1Translating the help files.
390372b4 2===========================
36c24f4f 3
4I have tried to write the help files in plain english with good grammer.
390372b4 5Since English is not my strong point you probably can't tell, but I hope it
6helps.
36c24f4f 7
1e63b430 8The help files, at this point, are divided into functional areas. Each .hlp
efb05555 9file represents a different functional block of how the program looks to the
10user.
36c24f4f 11
1e63b430 12Hopefully as SquirrelMail gets more widely used, non-english translations will
efb05555 13be used to make other non-english translations. You might want to keep this
14in mind when writing yours. Remember that these will be used all over the
15world and in many different environments so local language dialects might
16confuse someone else.
36c24f4f 17
390372b4 18File Structure
19==============
20
efb05555 21All translated files should be placed under the help directory. Under the
1e63b430 22help directory create another directory. This directory MUST be named in the
efb05555 23two letter standard abbreviation for the language. English is "en" and Polish
24would be "pl" for example.
390372b4 25
26The help files are written in a basic xml format. Don't worry, XML isn't hard
27at all. All it does is contain values inside tags like <start> and </start>.
28For these help files, the tags must be on their own line like this:
29 <tag>
30 Value for this tag
31 </tag>
32
33There are two types of main tags: <chapter> and <section>. There can be only
34one <chapter> tag in a .hlp file. However, there can be many <section> tags.
1e63b430 35Inside each of these tags, there can be any combination of any of the following
390372b4 36tags: <title>, <description>, <summary>. Here is an example:
37
38 | <chapter>
39 The title can only | <title>
40 be one line long | My first chapter
41 | </title>
42 Summary may be many | <summary>
43 lines, but is short | Just a brief summary
44 | </summary>
45 | <description>
46 Description can be | This is a more detailed description that
47 very long. It is | can span many lines. Usually this is the
48 the main part of | bulk of the help section or chapter description.
49 the help section. | </description>
50 | </chapter>
51
52
53Translating
54===========
55
1e63b430 56To translate, just copy all the .hlp files from help/en into the new directory
390372b4 57that you created for this language (i.e. help/pl). You only need to translate
1e63b430 58what is between the tags. Do not translate the actual tags such as <chapter>
390372b4 59or <summary>. The tag names need to remain in English. You should only translate
f4991a86 60the text between tags.
390372b4 61
62Often there may be other HTML tags such as <b> for bold or <a href...> to make
63a link. If you see any of these tags, just leave them and don't translate
64them either. Only what is contained inside them if needed.
65
66That should be all!!