diff options
Diffstat (limited to 'util/README')
| -rw-r--r-- | util/README | 25 |
1 files changed, 18 insertions, 7 deletions
diff --git a/util/README b/util/README index 5dca64265..285358b28 100644 --- a/util/README +++ b/util/README @@ -4,6 +4,10 @@ typo.php - is a crude syntax checker to avoid checking in files with simple typos. It basically just loads each of our project files at once. Run from cmdline and see if any parsing errors are reported. + + +Internationalisation + extract.php - extracts translatable strings from our project files. It currently doesn't pick up strings in other libraries we might be using such as tinymce, simplepie, and the HTML parsers. @@ -15,22 +19,29 @@ parens are required in a string which requires translation, please use hex escap \x28 = ( \x29 = ) - +This only applies to English. Other languages may use parens in strings +because they don't require extraction. + strings.php - a recent run of the strings program. This provides output that -is suitable for direct inclusion in the program once the app has been -initialised. +is suitable for direct inclusion in the program. -There are also translatable strings in the various files in the view +There are also translatable strings in the various files in the view/en directory. By setting $lang = 'something' in .htconfig.php, the application will search for view/something/filename prior to the English version in -view/filename when loading templates and view files. The translated string table -should be placed in view/$lang/strings.php for automatic inclusion. +view/en/filename when loading templates and view files. + +The translated string table should be placed in view/$lang/strings.php for +automatic inclusion. You are not restricted to using known languages. You may also use this to translate the software into "pirate", "surfer" or merely to replace certain text which you don't care for. - +Note: The view/en directory contains many HTML template files, some of which +only have a few words of English text amongst the HTML. Over time we will move +the translation to the replace_macros() function which calls these files and +then relocate the files to the view directory. The files in the top-level view +directory are template files which do not require translation. |