2014-02-17 22:46:30 +00:00
created: 20140217173715829
2014-10-22 15:08:06 +00:00
modified: 20141022145259278
2014-02-17 22:46:30 +00:00
tags: howto
title: How to create a translation for TiddlyWiki
type: text/vnd.tiddlywiki
2014-07-31 08:40:25 +00:00
! Prerequisites
2014-02-17 22:46:30 +00:00
2017-11-11 11:56:20 +00:00
* [[TiddlyWiki on Node.js|https://tiddlywiki.com/#TiddlyWiki%20on%20Node.js]]
2014-02-17 22:46:30 +00:00
* A GitHub account to submit the translation to tiddlywiki.com
2014-07-31 08:40:25 +00:00
! Setting Up
2014-02-17 22:46:30 +00:00
# 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`)
2014-10-22 15:08:06 +00:00
# Create a sibling directory `/MyTranslation/jermolene.github.io`
2014-02-17 22:46:30 +00:00
# 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
2014-10-17 15:29:27 +00:00
# Run `../build.jermolene.github.io/quick-bld.sh` to build TiddlyWiki
2014-10-22 15:08:06 +00:00
# Open the TiddlyWiki file at `/MyTranslation/jermolene.github.io/index.html`
2014-02-17 22:46:30 +00:00
# You should see your translation listed in the control panel, but the text of the translation will still be in British English
2014-02-20 10:27:02 +00:00
# Edit the `.tid` and `.multids` files in your language folder to translate the English text
2014-02-17 22:46:30 +00:00
Content of `plugin.info` for Joe Bloggs' Welsh translation:
2014-11-28 10:06:17 +00:00
```js
2014-02-17 22:46:30 +00:00
{
"title": "$:/languages/cy-GB",
"name": "cy-GB",
"plugin-type": "language",
"description": "Welsh (British)",
"author": "JoeBloggs",
"core-version": ">=5.0.0"
}
```
2017-11-11 11:56:20 +00:00
[[MultiTiddlerFiles|https://tiddlywiki.com/#MultiTiddlerFiles]] make it possible to pack the text of several tiddlers in a single text file, simplifying some editing tasks.
2014-07-31 08:40:25 +00:00
! Handling Updates
Sometimes the master en-GB language tiddlers are updated with revised content or new items. The best way to keep track of language-related commits to ~TiddlyWiki5:master is to monitor this RSS/Atom feed:
https://github.com/Jermolene/TiddlyWiki5/commits/master/core/language.atom
