X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=doc%2Ftranslating_help.txt;h=a7e10e726174a37eca5f010bf38f42bf3e763a0d;hp=435ae63e6291c3a9d20378eee984141a0e3dd952;hb=f99c446918b4b7452891d487df62e871ea03f19b;hpb=390372b45bd353cbfc6843382bc7f4291544fc49 diff --git a/doc/translating_help.txt b/doc/translating_help.txt index 435ae63e..a7e10e72 100644 --- a/doc/translating_help.txt +++ b/doc/translating_help.txt @@ -5,24 +5,23 @@ I have tried to write the help files in plain english with good grammer. Since English is not my strong point you probably can't tell, but I hope it helps. -The help files, at this point, are devided into functional areas. -Each .hlp file represents a different functional block of how the program looks -to the user. +The help files, at this point, are divided into functional areas. Each .hlp +file represents a different functional block of how the program looks to the +user. -I put each sentance on a line of its own because I thought it might make -it easier to translate. Hopefully as SquirrelMail is more widely used, -non-english translations will be used to make other non-english translations. -You might want to keep this in mind when writing yours. Remember that these will -be used all over the world and in many different environments so local language -dialects might confuse someone else. +Hopefully as SquirrelMail gets more widely used, non-english translations will +be used to make other non-english translations. You might want to keep this +in mind when writing yours. Remember that these will be used all over the +world and in many different environments so local language dialects might +confuse someone else. File Structure ============== -All translated files should be placed under the help directory. Under the help -directory create another directory. This directory MUST be named to the two letter -standard abbreviation for the language. English is "en" and Polish would be "pl" -for example. +All translated files should be placed under the help directory. Under the +help directory create another directory. This directory MUST be named in the +two letter standard abbreviation for the language. English is "en" and Polish +would be "pl" for example. The help files are written in a basic xml format. Don't worry, XML isn't hard at all. All it does is contain values inside tags like and . @@ -33,7 +32,7 @@ For these help files, the tags must be on their own line like this: There are two types of main tags: and
. There can be only one tag in a .hlp file. However, there can be many
tags. -Inside both of these tags, their can be any combination of any of the following +Inside each of these tags, there can be any combination of any of the following tags: , <description>, <summary>. Here is an example: | <chapter> @@ -54,11 +53,11 @@ tags: <title>, <description>, <summary>. Here is an example: Translating =========== -To translate, just copy all the .hlp files from help/en into your new directory +To translate, just copy all the .hlp files from help/en into the new directory that you created for this language (i.e. help/pl). You only need to translate -what is inbetween the tags. Do not translate the actual tags such as <chapter> +what is between the tags. Do not translate the actual tags such as <chapter> or <summary>. The tag names need to remain in English. You should only translate -the test between tags. +the text between tags. Often there may be other HTML tags such as <b> for bold or <a href...> to make a link. If you see any of these tags, just leave them and don't translate