mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-23 10:07:19 +00:00
Code Issues Releases Wiki Activity

Documentation for translators

Browse Source 
I’d appreciate help with putting together more complete and foolproof
instructions.
This commit is contained in:
Jermolene 2014-02-17 22:46:30 +00:00
parent c999d82a23
commit 3f89d2d0fa
3 changed files with 62 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
editions/tw5.com/tiddlers/deserializers/MultiTiddlerFiles.tid
View File

@ -25,6 +25,6 @@ Basics/Caption: Basics
Basics/Version: ~TiddlyWiki Version
```
This example defines two tiddlers, ''"""$:/language/ControlPanel/Basics/Caption"""'' and ''"""$:/language/ControlPanel/Basics/Version"""''.
This example defines two tiddlers, [[$:/language/ControlPanel/Basics/Caption]] and [[$:/language/ControlPanel/Basics/Version]].
If a `title` field is specified in the header then it is treated as a prefix for the individual tiddlers defined in the title.

44
editions/tw5.com/tiddlers/howtos/How to create a translation for TiddlyWiki.tid Normal file
View File

@ -0,0 +1,44 @@
created: 20140217173715829
modified: 20140217173730646
tags: howto
title: How to create a translation for TiddlyWiki
type: text/vnd.tiddlywiki
Making a translation
Prerequisites:
* [[TiddlyWiki on Node.js]]
* A GitHub account to submit the translation to tiddlywiki.com
Quick and dirty instructions:
# Fork the TiddlyWiki GitHub repository (https://github.com/Jermolene/TiddlyWiki5)
#* If your GitHub username is JoeBloggs, your fork will be https://github.com/JoeBloggs/TiddlyWiki5
# Create a branch with the name of the translation you intend to create (eg "cy-GB" for "Welsh (United Kingdom)")
#* IETF language codes: http://www.lingoes.net/en/translator/langcode.htm
# Clone your forked repository to your computer (eg, `/MyTranslation/TiddlyWiki5`)
# Create a sibling directory `/MyTranslation/jermolene.github.com`
# Create a new folder in `<repo>/languages` for your translation
# Copy the contents of `<repo>/core/language/en-GB` into your translation folder
# Create a `plugin.info` file (see below) in your translation folder
# Edit `<repo>/editions/tw5.com/tiddlywiki.info` to add your language to the list
# Run `./qbld.sh` to build TiddlyWiki
# Open the TiddlyWiki file at `/MyTranslation/jermolene.github.com/index.html`
# You should see your translation listed in the control panel, but the text of the translation will still be in British English
# Edit the `.tid` and `.tids` files in your language folder to translate the English text
Content of `plugin.info` for Joe Bloggs' Welsh translation:
```
{
"title": "$:/languages/cy-GB",
"name": "cy-GB",
"plugin-type": "language",
"description": "Welsh (British)",
"author": "JoeBloggs",
"core-version": ">=5.0.0"
}
```
MultiTiddlerFiles make it possible to pack the text of several tiddlers in a single text file, simplifying some editing tasks.

17
editions/tw5.com/tiddlers/mechanisms/TranslationMechanism.tid Normal file
View File

@ -0,0 +1,17 @@
created: 20140217173700918
modified: 20140217173713987
tags: mechanism
title: TranslationMechanism
type: text/vnd.tiddlywiki
The translation mechanism of TiddlyWiki manages and switches between language plugins that provide translations of the TiddlyWiki user interface.
The title of the current language plugin is read from the tiddler [[$:/language]]. If the selected plugin changes then any displayed translateable text automatically changes.
Translation plugins are bundles of tiddlers that each contain an indepedent translatable string. The strings are transcluded as needed.
Translatable strings are generally in the namespace `$:/language/`, for example:
* [[$:/language/ControlPanel/Tools/Encryption/ChangePassword/Button]]
* [[$:/language/Docs/ModuleTypes/isfilteroperator]]
* [[$:/language/EditTemplate/Fields/Add/Value/Placeholder]]