Work on Internationalization

[Olivier Borowski <olivier.borowski@…>]

I'm working on some changes to translate messages and actions.

- convert all string to constants defined with : define ('AN_EXAMPLE', 'An example');

- move all "define" to an external file (e.g. english.php) loaded by wikka.php

First step is already partially included in trunk. The second would make language switching easier.

Some patchs are following...

[Olivier Borowski <olivier.borowski@…>]

External file for internationalization support

[Olivier Borowski <olivier.borowski@…>]

Detailed proposal:

- move all if (!defined('STRING')) define ('STRING', 'string'); to a separate file, for example : [english.php].

- maybe remove if (!defined('STRING')) as a string should never be redeclared.

- special pages name (like RecentChanges) are defined as a constant (RECENT_CHANGES) in english.php.

- in Wakka.class.php, LoadPage() replace RECENT_CHANGES with "RecentChanges", so a translated URL "../DerniersChangements" is interpreted as same as "../RecentChanges". See the code here : [LoadPage.txt]

- choose a default language in wikka.config.php and let the user choose his preferred language in UserSettings.

[Olivier Borowski <olivier.borowski@…>]

External file for internationalization support (updated)

[Olivier Borowski <olivier.borowski@…>]

Changes to LoadPage();

[DarTar]

The idea of creating 'aliases' for default pages instead of (as we were planning) creating different sets of pages (based on different SQL dumps) for different languages is an interesting one. But we should consider the consequences on the overall architecture of Wikka.

[Olivier Borowski <olivier.borowski@…>]

Fixed a bug in the previous LoadPage() proposal.

[NilsLindenberg]

see [273] (unfortunately marked with 344 instead of this :(

[DarTar]

since it seems that most of this ticket will be done soon (at least the l10n strings in lang/en.inc.php), I mark it for 1.1.7.

[anonymous]

Hello. Please, tell me what files of Wiki must be translated, a'll translate that to Russian. But there is problem with unicode/UTF-8. May be, i can use formatter from WackaWiki?

[JavaWoman]

I've extended the 'todo' list in the language file (lang/en.inc.php), to conform with previously-agreed guidelines for defining language strings:

@todo remove all HTML & Wikka formatting (marked with @@@):

leave text + % s replacement vars only

@todo make sure that punctuation is always part of defined phrase @todo document all replacement vars @todo use single quotes whenever possible

[DarTar]

Thanks! Please remember to cross-reference tickets and commits in both directions (SVN comments and ticket comments) for ease of management: [286]

[NilsLindenberg]

@anonymus: To translate wikka into russian, you'll have to copy lang/en.inc.php and translate the strings there. Note that the file is not complete yet, so you'll better wait for the release of 1.1.7.

No, you can't use the formatter from Wackowiki. As for UTF-8, yes there are some problems. It may work if you search for all places with a language definition and set them to utf8 (especially the mysql connection) but I am not sure this will resolve all the problems.

[DarTar]

[291] fixes a wrongly closed bracket in [286], which was breaking the output. Please test changes locally before committing them to the repository.

[JavaWoman]

Big jump ahead with changeset [294], so large (46 files involved!) it was not possible to test it all quickly. ;) So (thanks to testing by NilsLindenberg and DarTar) the big change was quickly followed by a few small bugfixes in [295], [299] and [301].

See the commit message on [294] for what it all involves.

[DarTar]

I see that at the end of the lang file there's a todo section marked with "Setup". Please don't spend time working on the installer, because this is currently being rewritten, so we'll have to make GUI string l10n-ready anyway.

[DarTar]

[302] adds some preliminary instructions on how to correctly document language translation strings from a phpdoc point of view (see #244) .

[DarTar]

[303] [304] fix issues with the phpdoc header

[JavaWoman]

Added docblock templates to groups of defines in the language file ([307]). This should provide some documentation consistently for each define in the group.

Note that the short description ('define group.') is there only to make the real description the 'long' description: when docblock templates are merged, short descriptions are discarded and only long descriptions are used.

The long descriptions link to the file(s) where the defines are used with an inline {@link} to provide at least one-way linking without necessarily having to use a @uses tag for each define in the file that uses it (though that would be nice to add eventually :)).

[JavaWoman]

Replying to DarTar:

I see that at the end of the lang file there's a todo section marked with "Setup". Please don't spend time working on the installer, because this is currently being rewritten, so we'll have to make GUI string l10n-ready anyway.

Don't worry - I added the TODO section deliberately as a reminder that this needs to be done (maybe in a separate language file?) - not intending to spend any time on it. ;)

[DarTar]

After compiling with phpdoc, I'm removing the useless 'define group' lines previously added by JavaWoman and adding a todo with further instructions on how to crosslink translation strings. [310]

[DarTar]

[314] and [315] fix some further (minor) issues in phpdoc docblocks for the language file that were breaking the layout of the compiled documentation (group descriptions are treated as short descs and must be hence put on a single line).

[DarTar]

[313] fixes a wrongly spelled constant name in usersettings.php

[DarTar]

[316] removes an obsolete constant formerly used in {{diff.php}} and already merged by marjolein with an identical shared constant.

[DarTar]

Shouldn't we encode the language file as UTF-8 so it's ready to support translation in different languages?

[JavaWoman]

[319] fixes a number of problems with the strings in fullscreen.php (found while testing fixes for #417).

[JavaWoman]

Replying to DarTar:

Shouldn't we encode the language file as UTF-8 so it's ready to support translation in different languages?

I agree we should - not sure if it stays that way when checking out or committing, but let's try. (Line endings seem to end up being DOS when checking out to a Windows machine, but getting converted back to Unix when committing - that confused me a lot...)

[JavaWoman]

[322] has two minor fixes in mindmap.php and fullscreen.php. (sorry, referred to wrong ticket in there)

[JavaWoman]

[323] has some fixes for the RSS feeds

[JavaWoman]

[328] minor fix for textsearch(expanded)

[JavaWoman]

[329] minor fix for category action

[DarTar]

(In [414]) Fixing wrong link resulting from i18n works, refs #340

[DarTar]

(In [444]) Missing l10n constant for {{system}} action. refs #340

[DarTar]

(In [447]) Added fieldset and legend to form (refs #388) and fixed missing l10n strings (refs #340).

[DarTar]

(In [449]) Fixing incorrect l10n strings and preliminary cleanup of {{feedback}} action with support for registered users. refs #486 and #340

[DarTar]

(In [450]) Adding support for custom recipient in feedback form (read phpdoc header for detailed explanation); automatic replacement of sender data for registered users; adding a few configurable options; fixing l10n strings; refs #486 and #340 and closes #472

[DotMG]

(In [454]) refs #486 and #340 [449] has a bug (redefining ERROR_EMPTY_COMMENT), fixed in this changeset.

[DarTar]

(In [505]) Fixing wrong l10n strings, refs #340

[DarTar]

(In [507]) Minor changes to newpage action:

• fixing and consolidating l10n strings, refs #340
• adding accessibility options, refs #388
• adding page existence check
• adding styling options, refs #380

[DarTar]

(In [563]) Fix misspelled l10n string in footer, refs #340

[JavaWoman]

Replying to Olivier Borowski <olivier.borowski@gmail.com>:

Detailed proposal: (...) - special pages name (like RecentChanges) are defined as a constant (RECENT_CHANGES) in english.php. - in Wakka.class.php, LoadPage() replace RECENT_CHANGES with "RecentChanges", so a translated URL "../DerniersChangements" is interpreted as same as "../RecentChanges". See the code here : [LoadPage.txt]

I like the idea, not the implementation: this would mean every time we add a new "system" page (created by the installer) the LoadPage() function would need to be changed. We need an implementation that makes loading of system pages independent of the implementation of the Loadpage() function. A single change to enable this for all future changes would be OK, but not updating the function every time we add or remove installer-created pages.

[JavaWoman]

adding keyword: current work on this is actually internationalization, not localization.

[JavaWoman]

(In [667]) "Relocatable Wikka" - part 6 (last of this set)

Handlers.

refs #470, #545

• comments.xml.php:
  • use new config variable "feedcreator_path" (which may contain a relocated path) instead of string literal to build URI path to the FeedCreator class
  • uses instantiate() for PHP-version-dependent method to return an object reference
  • uses new object variable "base_url" instead of OBSOLETE configuration value "base_url" to use as source location

• delete.php:
  • reformatted queries (slightly - needs more work)
  • uses new object variable "base_url" instead of OBSOLETE configuration value "base_url"

• edit.php:
  • commented out dummy generation of header and footer since links aren't tracked there any more anyway
  • uses new config variable "wikiedit_uripath" (which may contain a relocated path) instead of string literal to build URI paths to the WikiEdit scripts
  • uses new config variable "wikiedit_uripath" (which may contain a relocated path) to build the variable $wikiedit_imgpath to pass as fourth parameter to the init() function of the WikiEdit object, so it can find its own images even if relocated. Note: WikiEdit already had this fourth parameter; it was just unused till now!

• mindmap_fullscreen.php:
  • use constants WIKKA_LANG_PATH and CONFIG_DEFAULT_LANGUAGE to build paths to language file for selected default language and fallback language file (using system default language)
  • use constant ERROR_LANGUAGE_FILE_MISSING (in wikka.php) to generate error message if no language file can be found
  • use new config variable "freemind_uripath" instead of string literal to build URI path to the Freemind applet
  • a little cleanup (whitespace, naming)

• recentchanges.xml.php:
  • use new config variable "feedcreator_path" (which may contain a relocated path) instead of string literal to build URI path to the FeedCreator class
  • uses instantiate() for PHP-version-dependent method to return an object reference
  • uses new object variable "base_url" instead of OBSOLETE configuration value "base_url" to use as source location

• recentchanges.xml.php (note that even with the listed i18n changes i18n is not yet complete for this handler):
  • use FIRST_NODE_LABEL instead of string literal (i18n - refs #340)
  • use new object variable "wikka_url" instead of (OBSOLETE) config variable "base path" and constant WIKKA_URL_EXTENSION to build link to the current page
  • use WIKKA_ERROR_CAPTION and WIKKA_ERROR_ACL_READ_INFO instead of string literals to build error message (i18n - refs #340)
  • considerable cleanup (whitespace, coding guidelines)

[DarTar]

(In [708]) Slight rewording of message for history handler (oldest edit=page creation), refs #340

[JavaWoman]

(In [719]) Advanced FormOpen()

• Wakka.class.php:
  • replacing FormOpen() by an adapted version of the "advanced" version available and operational on wikkawiki.org
  • adding a new existsHandler() method to support this
• files.php action:
  • now uses advanced FormOpen() to build upload form - refs #72
• more work on internationalization - refs #340

• language file (en.inc.php)
  • standardized and expanded strings for files action - refs #340

Note:

The new FormOpen() now does away completely with the silly "hidden" field that seems to have been "necessary" at some time in the past to make form submission work when rewrite_mode is not on. It is no longer necessary: FormOpen() uses Href() which provides a complete action URL including a wakka parameter. Another case of replacing addressing symptoms by addressing causes...

refs #496

[DarTar]

Retargeting to 1.3. Code for this ticket may have already been committed to trunk, from which 1.3 will be branched. Consider backporting urgent issues to 1.2.X

[MasinAlDujaili]

I am currently working on isolating string constants in files where they are still hard coded. Where shall I put my efforts? I'll append actions/category.php & actions/checkversion.php.

[MasinAlDujaili]

update

[DarTar]

(In [1652]) [m] Removed redundant punctuation from search tips, refs #340

[DarTar]

(In [1655]) Converting German lang file to UTF-8, refs #684 and #340

[DarTar]

(In [1656]) Replacing hardcoded string, refs #340