Setup of a new project

Revision as of 12:50, 9 December 2017 by Nike (talk | contribs) (better link)
Jump to navigation Jump to search

Verify the project

Requirements and process: Translating:New project for details. Best practices we usually enforce (main pain point): Translating:Localisation for developers.

  • Content fit
    • Software interface messages
    • Some prose is okay, such as terms of service. But they should be split into smaller parts. In some cases it can be done using translatable wiki pages here in
    • For large amounts of prose, it is recommend to set up Translate extension for MediaWiki yourself
    • The software being translated has utility to general public. No personal websites or tools useful only to the author.
  • License
    • Should be a known open source license
  • Quality of strings
    • Should avoid spelling mistakes, bad grammar
    • No lego messages
    • Consistency with punctuation, letter casing
  • Message documentation
  • Activity and interest (releases, contact person)
    • Frequent deployment or frequent releases. Having to wait over a year without release or deployment is not acceptable.
  • File format is supported
  • Commit access for delivering translation updates:
    • Wikimedia Gerrit: Give push access to L10n-bot (C+2, V+2 and Submit)
    • GitHub: Give push access to @translatewiki (Create and merge commits; pull requests are not supported)
    • SourceForge: Make translatewiki a developer
    • BitBucket: Give push access to translatewiki
    • Other: Discuss with staff (Nikerabbit or Siebrand)

Repository configuration

Edit repoconfig.yaml in the translatewiki repository. See an example of the needed patch (Things have changed, update this when a new project is added).


Message group configuration

Lots of examples under groups/ in translatewiki repo. Old but mostly still valid documentation:

Need some info such as logo and message group description done in the next section.

Choosing a group id:

  • Practice is to use lowercase letters with dashes as level separators in case of multiple groups.
  • Prefix "out-" is deprecated and should not be used for new projects.
  • In case of multiple groups, the aggregate group should get the top level name, i.e. "blockly", and contain all groups named "blockly-*". Suffixes like "-0-all" are deprecated.
  • Do not use comma or asterisk or question mark! These have special meaning in places which accept group patterns.
  • Also avoid characters which are invalid in MediaWiki titles, as that breaks shortcuts such as Special:MessageGroupStats/foo (which may be used by the people, but not generated by Translate itself).

All message keys should be prefixed with mangler if it is likely that multiple message groups (remember that one file + its translations is one group).

Update TranslateSettings.php to register the yaml file, possibly add a new namespace (if none of the existing ones fit).

Wiki configuration

Translating:projectname needs to be created (copy template from Translating:FreeCol or other). Logo needs to be in Commons or uploaded to

Add descriptions to Group descriptions and mark the page for translation.

Other misc things:

See also