Setup of a new project

(Redirected from New project setup)
Jump to: navigation, search

Verify the project

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

  • License
  • Quality of strings
  • Message documentation
  • Activity and interest (releases, contact person)
  • File format
  • 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) [Legacy projects have access for @Nikerabbit and @Siebrand]
    • BitBucket: Give push access to Nikerabbit and Siebrand
    • Other: Discuss with Nikerabbit and Siebrand

Repository configuration

Edit repoconfig.json and repoconfig.commit.json, bin/EXTERNAL-PROJECTS, bin/REPONG-PROJECTS and bin/nike-export-all in the translatewiki repository. See an example of the needed patch.


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