- added a hook at beginning of left_main
[squirrelmail.git] / doc / translating_help.txt
36c24f4f 1Translating the help files.
ca1a555e 2---------------------------
36c24f4f 3
4I have tried to write the help files in plain english with good grammer.
5Since English is not my strong point you probably can't tell, but I hope it helps.
7The help files, at this point, are devided into functional areas.
8Each .hlp file represents a different functional block of how the program looks to the user.
10I put each sentance on a line of its own because I thought it might make
11it easier to translate. Hopefully as SquirrelMail is more widely used,
12non-english translations will be used to make other non-english translations.
13You might want to keep this in mind when writing yours. Remember that these wil be used
14All over the world and in many different environments so local language dialects might
15confuse someone else.
17File Structure.
19All translated files should be placed under the hlp directory.
20Under the hlp directory create another directory. This directory MUST be named
21to the two letter standard abbreviation for the language. English is "en" and
22Spanish would be "sp" for example.
24The help files are written in the following format:
26<A NAME=some_name></A>
27<H1>Some Head</H1>
28Some text on some subject.
32<A NAME=some_name></A>
33<H3>Some Head</H3>
34Some text on some subject.
37This is important because the left menu is dynamically built from what is inside the .hlp files.
38All <A NAME></A>, <H1></H1>, and <H3></H3> tags MUST be on a line by themselves.
39No modifiers may be used for the <A> anchor tags. Modifiers other than the NAME modifier
40Will result in the additional modifier's inclusion in the left menu.
41Any other tags used such as <H4> will be ignored. I am currently working on making all the
42headers which are already listed in the po file translate automatically. We'll see how this goes.
43This will not work for files like FAQ.hlp and Basic.hlp which are not in the main program.
45At the current time no logic is in place to check if help is written on a certain subject.