Loading...
 
Skip to main content

Update Translation documentation to 2022

Context

As of 2021-10: The interface translation process in Tiki needs some love. We have seen some failures like

  • Transifex (A volunteer started the project and then became unavailable)
  • i18n.tiki.org (which we are restarting now)

and some successes like

  • Translations Revamp
  • Migration of all related CLI scripts to php console.php translation:*
  • Some keen community members reporting issues with untranslatable strings


The current status is that it's confusing for translators to get started.

Let's clean this up.

Let's have a 2 hour online session with the experts of this topic and clarify the high-level direction, and 2 or 3 multilingual junior developers will start using, and refine the documentation as they go.

The most important point is to decide where to converge all the documentation related to translators: doc.tiki.org vs tiki.org vs dev.tiki.org vs translation.tiki.org Then, move/update all the docs while adding redirects to old pages.

Who


What

There should be at least 3 ways to contribute translations

  1. Via GitLab's web interface
  2. Via Git process that all devs use (CLI, IDE, etc.)
  3. i18n.tiki.org (for in-context translations and/or other non-tech savvy Users/Translators familiar interface everyone can use?)


There should be at least these sections:

  • How to edit/add strings to an existing translation
    • language.php
    • language.js
  • How to add a new language
  • How to contribute (and merge) 3rd party/external translations (e.g. made in-context on their local Tiki installation and exported from there)


Special cases:

  • Same term in English has more than one meaning in a translation, depending on context
    IE: The English word "Location" exist and is used for a place (geo-location trackeritem) while it also also exist in French for a place or renting an apartment.
  • I changed a string in English and I don't want to break translations
  • Contribute translations to trunk, and after, backport to a branch (ex.: Tiki21 LTS)


Everyone listed above, please review all documentation on *.tiki.org to make sure a new community member can contribute translations to trunk via GitLab. Developers can be sent to normal Git contribution workflow, while non coders should have a recipe to use the web interface.

All scripts are converging to console.php and docs need updating:
https://gitlab.com/tikiwiki/tiki/-/merge_requests/717
https://gitlab.com/tikiwiki/tiki/-/commit/be39ca6315a1432c019e5976ef796a4222edbdde

While documenting, let's think of opportunities for enhancements and automation. Ex.:

How to reduce waste disk space in Tiki source code?

  • GitLab is tracking many lines with English to English commented translations like
    Copy to clipboard
    // "Registration & Log in" => "Registration & Log in",
    • There was a parameter to clean up all commented out lines from language.php in getstrings script, no?


Running php console.php translation:getstrings as part of the CI would generate a lot of noise.

Maybe translators should have Translation Priorities and run translation:getstrings on their instance before contributing translations?

Keywords

The following is a list of keywords that should serve as hubs for navigation within the Tiki development and should correspond to documentation keywords.

Each feature in Tiki has a wiki page which regroups all the bugs, requests for enhancements, etc. It is somewhat a form of wiki-based project management. You can also express your interest in a feature by adding it to your profile. You can also try out the Dynamic filter.

Accessibility (WAI & 50😎
Accounting
Administration
Ajax
Articles & Submissions
Backlinks
Banner
Batch
BigBlueButton audio/video/chat/screensharing
Blog
Bookmark
Browser Compatibility
Calendar
Category
Chat
Comment
Communication Center
Consistency
Contacts Address book
Contact us
Content template
Contribution
Cookie
Copyright
Credits
Custom Home (and Group Home Page)
Database MySQL - MyISAM
Database MySQL - InnoDB
Date and Time
Debugger Console
Diagram
Directory (of hyperlinks)
Documentation link from Tiki to doc.tiki.org (Help System)
Docs
DogFood
Draw -superseded by Diagram
Dynamic Content
Preferences
Dynamic Variable
External Authentication
FAQ
Featured links
Feeds (RSS)
File Gallery
Forum
Friendship Network (Community)
Gantt
Group
Groupmail
Help
History
Hotword
HTML Page
i18n (Multilingual, l10n, Babelfish)
Image Gallery
Import-Export
Install
Integrator
Interoperability
Inter-User Messages
InterTiki
jQuery
Kaltura video management
Kanban
Karma
Live Support
Logs (system & action)
Lost edit protection
Mail-in
Map
Menu
Meta Tag
Missing features
Visual Mapping
Mobile
Mods
Modules
MultiTiki
MyTiki
Newsletter
Notepad
OS independence (Non-Linux, Windows/IIS, Mac, BSD)
Organic Groups (Self-managed Teams)
Packages
Payment
PDF
Performance Speed / Load / Compression / Cache
Permission
Poll
Profiles
Quiz
Rating
Realname
Report
Revision Approval
Scheduler
Score
Search engine optimization (SEO)
Search
Security
Semantic links
Share
Shopping Cart
Shoutbox
Site Identity
Slideshow
Smarty Template
Social Networking
Spam protection (Anti-bot CATPCHA)
Spellcheck
Spreadsheet
Staging and Approval
Stats
Survey
Syntax Highlighter (Codemirror)
Tablesorter
Tags
Task
Tell a Friend
Terms and Conditions
Theme
TikiTests
Federated Timesheets
Token Access
Toolbar (Quicktags)
Tours
Trackers
TRIM
User Administration
User Files
User Menu
Watch
Webmail and Groupmail
WebServices
Wiki History, page rename, etc
Wiki plugins extends basic syntax
Wiki syntax text area, parser, etc
Wiki structure (book and table of content)
Workspace and perspectives
WYSIWTSN
WYSIWYCA
WYSIWYG
XMLRPC
XMPP




Useful Tools

Show PHP error messages