dir/util/README

49 lines
1.8 KiB
Plaintext
Raw Normal View History

2010-09-30 03:35:21 +02:00
Utilities
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.
2010-11-21 00:23:41 +01:00
Internationalisation
2010-09-30 03:35:21 +02:00
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.
In order for extract to do its job, every use of the t() translation function
must be preceded by one space. The string also can not contain parentheses. If
2010-10-07 02:40:58 +02:00
parens are required in a string which requires translation, please use hex escapes.
\x28 = (
\x29 = )
2010-11-21 00:23:41 +01:00
This only applies to English. Other languages may use parens in strings
because they don't require extraction.
2010-09-30 03:35:21 +02:00
strings.php - a recent run of the strings program. This provides output that
2010-11-21 00:23:41 +01:00
is suitable for direct inclusion in the program.
2010-09-30 03:35:21 +02:00
2010-11-21 00:23:41 +01:00
There are also translatable strings in the various files in the view/en
2010-09-30 03:35:21 +02:00
directory. By setting $lang = 'something' in .htconfig.php, the application
will search for view/something/filename prior to the English version in
2010-11-21 00:23:41 +01:00
view/en/filename when loading templates and view files.
The translated string table should be placed in view/$lang/strings.php for
automatic inclusion.
2010-10-07 02:40:58 +02:00
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.
2010-11-21 00:23:41 +01:00
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.
2010-09-30 03:35:21 +02:00