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 Placeholders
  48
  49 Do not translate placeholders in strings! Things like %s, %d, %1$s and $somename
  50 are used to add dynamic content to the string.
  51
  52 %s represents a dynamic string, like in "Welcome to %s"
  53 %d represents a dynamic number, like in "%d new messages"
  54 $somename is a variable like in php
  55 In %1$s %2$s,  the numbers are the position index of multiple dynamic content.
  56 You could swap position in string of indexed placeholders.
  57 e.g.
  58 "%1$s's %2$s" => "John's photo", "John's item"
  59 "%2$s di %1$s" => "foto di John", "elemento di John"
  60
  61
  62 Plural
  63
  64 The tt() function supports plural form. Script extract.php write this in
  65 strings.php as an array, one string for every plural form language supports:
  66
  67 $a->string["%d message sent"] = Array(
  68  0 => "%d message sent",
  69  1 => "%d messages sent",
  70 );
  71
  72 The function string_plural_select($n) defined in strings.php, return the string
  73 index to use, related to the numbers of item (value of $n).
  74
  75 This is modelled after ngettext function of GNU gettext.
  76 More info at http://www.gnu.org/software/hello/manual/gettext/Plural-forms.html
  77
  78
  79 Xgettext and .po workflow
  80
  81 1. Run util/run_xgettext.sh script (on *unix sistems, with GNU xgettext installed)
  82         This script runs xgettext on source tree, extracting strings from t() and tt()
  83         functions, and creates a util/messages.po file.
  84
  85         % cd util; ./run_xgettext.sh ../view/{language}/messages.po
  86
  87         Replace {language} with the language you are working on - e.g. 'es', 'fr', 'de', etc.
  88
  89 2. copy util/messages.po to view/<langauage>/messages.po
  90 3. open view/<langauage>/messages.po with a text editor and fill in infos in
  91         "Last-Translator: FULL NAME <EMAIL@ADDRESS>"
  92         "Language-Team: LANGUAGE <LL@li.org>\n"
  93         "Language: \n"
  94
  95         (eg:
  96         "Last-Translator: Guybrush Threepwood <gb@host.com>"
  97         "Language-Team: Pirate Friendika <pirate-friendika-ml@host.com>\n"
  98         "Language: pi\n"
  99         )
 100
 101         For the line
 102         "Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\n"
 103         read GNU gettext manual at
 104         http://www.gnu.org/software/hello/manual/gettext/Plural-forms.html
 105
 106 4. You could then translate the strings in text editor, but I suggest to use one
 107         of the many .po editors out there, like QtLinguist
 108
 109 5. run
 110         $ php util/po2php.php view/<language>/messages.po
 111         to create the strings.php file
 112
 113 When strings are added or modified in source, you could run
 114         $ cd util; ./run_xgettext.sh ../view/<language>/messages.po
 115         to extract strings from source files and join them with the existing .po file:
 116         new strings are added, the existing are not overwritten.
 117
 118 If you already translated Friendica using strings.php, you could import your old
 119 translation to messages.po. Run:
 120 $ php util/php2po.php view/<language>/strings.php
 121
 122
 123 You may also use the util/string_translator.php web interface to translate the string file, but it is disabled for website security reasons. The web server will need write permission to your language directories and the "Deny ..." line in util/.htaccess will need to be modified or commented to use the utility.
 124
 125
 126