util/README

   1 Utilities
   2
   3 typo.php  - is a crude syntax checker to avoid checking in files with simple
   4 typos. It basically just loads each of our project files at once. Run from
   5 cmdline and see if any parsing errors are reported.
   6
   7
   8
   9 Internationalisation
  10
  11 extract.php - extracts translatable strings from our project files. It
  12 currently doesn't pick up strings in other libraries we might be using such as
  13 tinymce, simplepie, and the HTML parsers.
  14
  15 In order for extract to do its job, every use of the t() translation function
  16 must be preceded by one space. The string also can not contain parentheses. If
  17 parens are required in a string which requires translation, please use hex escapes.
  18
  19 \x28 = (
  20 \x29 = )
  21
  22 This only applies to English. Other languages may use parens in strings
  23 because they don't require extraction.
  24
  25 strings.php - a recent run of the strings program. This provides output that
  26 is suitable for direct inclusion in the program.
  27
  28 There are also translatable strings in the various files in the view/en
  29 directory. By setting $lang = 'something' in .htconfig.php, the application
  30 will search for view/something/filename prior to the English version in
  31 view/en/filename when loading templates and view files.
  32
  33 The translated string table should be placed in view/$lang/strings.php for
  34 automatic inclusion.
  35
  36 You are not restricted to using known languages. You may also use this to
  37 translate the software into "pirate", "surfer" or merely to replace certain
  38 text which you don't care for.
  39
  40 Note: The view/en directory contains many HTML template files, some of which
  41 only have a few words of English text amongst the HTML. Over time we will move
  42 the translation to the replace_macros() function which calls these files and
  43 then relocate the files to the view directory. The files in the top-level view
  44 directory are template files which do not require translation.
  45
  46
  47
  48