Changed regexps
[squirrelmail.git] / doc / translating_help.txt
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
36c24f4f 7
8The help files, at this point, are devided into functional areas.
390372b4 9Each .hlp file represents a different functional block of how the program looks
10to the user.
36c24f4f 11
f4991a86 12Hopefully as SquirrelMail is more widely used,
36c24f4f 13non-english translations will be used to make other non-english translations.
390372b4 14You might want to keep this in mind when writing yours. Remember that these will
15be used all over the world and in many different environments so local language
16dialects might confuse someone else.
36c24f4f 17
390372b4 18File Structure
21All translated files should be placed under the help directory. Under the help
22directory create another directory. This directory MUST be named to the two letter
23standard abbreviation for the language. English is "en" and Polish would be "pl"
24for example.
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>
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.
35Inside both of these tags, their can be any combination of any of the following
36tags: <title>, <description>, <summary>. Here is an example:
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>
56To translate, just copy all the .hlp files from help/en into your new directory
57that you created for this language (i.e. help/pl). You only need to translate
58what is inbetween the tags. Do not translate the actual tags such as <chapter>
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.
66That should be all!!