From e81778f561ec23b0cfd27012cfcb6c69fa6d40aa Mon Sep 17 00:00:00 2001 From: rubenwardy Date: Sat, 26 Aug 2017 16:40:30 +0100 Subject: [PATCH] Add translation support --- README.md | 19 +++++++--- _data/languages.yml | 3 ++ _data/{links.yml => links_en.yml} | 3 -- _includes/header.html | 34 ++++++++++++------ {chapters => en/chapters}/abms.md | 2 +- {chapters => en/chapters}/chat.md | 2 +- {chapters => en/chapters}/chat_complex.md | 2 +- .../chapters}/creating_textures.md | 2 +- {chapters => en/chapters}/folders.md | 2 +- {chapters => en/chapters}/formspecs.md | 2 +- {chapters => en/chapters}/hud.md | 2 +- {chapters => en/chapters}/inventories.md | 2 +- {chapters => en/chapters}/itemstacks.md | 2 +- {chapters => en/chapters}/lua.md | 2 +- {chapters => en/chapters}/node_drawtypes.md | 2 +- {chapters => en/chapters}/node_metadata.md | 2 +- .../chapters}/nodes_items_crafting.md | 2 +- {chapters => en/chapters}/player_physics.md | 2 +- {chapters => en/chapters}/privileges.md | 2 +- {chapters => en/chapters}/readmore.md | 2 +- {chapters => en/chapters}/releasing.md | 2 +- index.md => en/index.md | 4 +-- index.html | 36 +++++++++++++++++++ thank_you.md | 10 ------ to_mediawiki.py | 30 ---------------- 25 files changed, 96 insertions(+), 77 deletions(-) create mode 100644 _data/languages.yml rename _data/{links.yml => links_en.yml} (95%) rename {chapters => en/chapters}/abms.md (99%) rename {chapters => en/chapters}/chat.md (99%) rename {chapters => en/chapters}/chat_complex.md (99%) rename {chapters => en/chapters}/creating_textures.md (99%) rename {chapters => en/chapters}/folders.md (99%) rename {chapters => en/chapters}/formspecs.md (99%) rename {chapters => en/chapters}/hud.md (99%) rename {chapters => en/chapters}/inventories.md (99%) rename {chapters => en/chapters}/itemstacks.md (99%) rename {chapters => en/chapters}/lua.md (99%) rename {chapters => en/chapters}/node_drawtypes.md (99%) rename {chapters => en/chapters}/node_metadata.md (99%) rename {chapters => en/chapters}/nodes_items_crafting.md (99%) rename {chapters => en/chapters}/player_physics.md (99%) rename {chapters => en/chapters}/privileges.md (99%) rename {chapters => en/chapters}/readmore.md (98%) rename {chapters => en/chapters}/releasing.md (99%) rename index.md => en/index.md (95%) create mode 100644 index.html delete mode 100644 thank_you.md delete mode 100644 to_mediawiki.py diff --git a/README.md b/README.md index 8b62646..0bcd73f 100644 --- a/README.md +++ b/README.md @@ -21,12 +21,21 @@ fit my idea of quality. ## Finding your way around -* _data/ - Contains the navigation bar file. +* `_data/` - Contains the navigation bar file. (a list of links and link text for the navbar.) -* _includes/ - Contains HTML templates. -* _layouts/ - You can safely ignore this. -* static/ - CSS, images, scripts. -* chapters/ - Markdown files for each chapter. +* `_includes/` - Contains HTML templates. +* `_layouts/` - You can safely ignore this. +* `static/` - CSS, images, scripts. +* `/` + * `chapters/` - Markdown files for each chapter. + +## Adding a new language + +* Add entry to `_data/languages.yml` +* Copy links_en, and customise it for your language +* Add your language to the if else in `_includes/header.html` +* Copy en/ to your language code +* Translate your language code folder ## Using Jeykll diff --git a/_data/languages.yml b/_data/languages.yml new file mode 100644 index 0000000..de6bc3a --- /dev/null +++ b/_data/languages.yml @@ -0,0 +1,3 @@ +- code: en + name: English (UK) + cta: This book is available in English diff --git a/_data/links.yml b/_data/links_en.yml similarity index 95% rename from _data/links.yml rename to _data/links_en.yml index c9b9d14..579b956 100644 --- a/_data/links.yml +++ b/_data/links_en.yml @@ -80,6 +80,3 @@ link: chapters/readmore.html - hr: true - -- title: Lua Modding API Reference - link: lua_api.html diff --git a/_includes/header.html b/_includes/header.html index c41237e..1386cb2 100644 --- a/_includes/header.html +++ b/_includes/header.html @@ -9,20 +9,34 @@ + {% assign pathsplit = page.dir | split: '/' %} + {% assign language = pathsplit[1] %} + + {% if language == "en" %} + {% assign links = site.data.links_en %} + + {% else %} + {% assign language = "en" %} + {% assign links = site.data.links_en %} + {% endif %} + +

{{ page.title }}

diff --git a/chapters/abms.md b/en/chapters/abms.md similarity index 99% rename from chapters/abms.md rename to en/chapters/abms.md index b4c62e4..369d268 100644 --- a/chapters/abms.md +++ b/en/chapters/abms.md @@ -1,7 +1,7 @@ --- title: Active Block Modifiers layout: default -root: ../ +root: ../../ --- ## Introduction diff --git a/chapters/chat.md b/en/chapters/chat.md similarity index 99% rename from chapters/chat.md rename to en/chapters/chat.md index 83d162e..88b3e5f 100644 --- a/chapters/chat.md +++ b/en/chapters/chat.md @@ -1,7 +1,7 @@ --- title: Chat and Commands layout: default -root: ../ +root: ../../ --- ## Introduction diff --git a/chapters/chat_complex.md b/en/chapters/chat_complex.md similarity index 99% rename from chapters/chat_complex.md rename to en/chapters/chat_complex.md index 0a6e10f..bb9235d 100644 --- a/chapters/chat_complex.md +++ b/en/chapters/chat_complex.md @@ -1,7 +1,7 @@ --- title: Complex Chat Commands layout: default -root: ../ +root: ../../ --- ## Introduction diff --git a/chapters/creating_textures.md b/en/chapters/creating_textures.md similarity index 99% rename from chapters/creating_textures.md rename to en/chapters/creating_textures.md index 765bef3..f9fd2eb 100644 --- a/chapters/creating_textures.md +++ b/en/chapters/creating_textures.md @@ -1,7 +1,7 @@ --- title: Creating Textures layout: default -root: ../ +root: ../../ --- ## Introduction diff --git a/chapters/folders.md b/en/chapters/folders.md similarity index 99% rename from chapters/folders.md rename to en/chapters/folders.md index ea3877f..0f3dd4e 100644 --- a/chapters/folders.md +++ b/en/chapters/folders.md @@ -1,7 +1,7 @@ --- title: Folder Structure layout: default -root: ../ +root: ../../ --- ## Introduction diff --git a/chapters/formspecs.md b/en/chapters/formspecs.md similarity index 99% rename from chapters/formspecs.md rename to en/chapters/formspecs.md index c548335..e3a4944 100644 --- a/chapters/formspecs.md +++ b/en/chapters/formspecs.md @@ -1,7 +1,7 @@ --- title: Formspecs layout: default -root: ../ +root: ../../ --- ## Introduction diff --git a/chapters/hud.md b/en/chapters/hud.md similarity index 99% rename from chapters/hud.md rename to en/chapters/hud.md index 06d6a7a..4580ad5 100644 --- a/chapters/hud.md +++ b/en/chapters/hud.md @@ -1,7 +1,7 @@ --- title: HUD layout: default -root: ../ +root: ../../ ---
diff --git a/chapters/inventories.md b/en/chapters/inventories.md similarity index 99% rename from chapters/inventories.md rename to en/chapters/inventories.md index 3158522..9686f1d 100644 --- a/chapters/inventories.md +++ b/en/chapters/inventories.md @@ -1,7 +1,7 @@ --- title: Inventories layout: default -root: ../ +root: ../../ --- ## Introduction diff --git a/chapters/itemstacks.md b/en/chapters/itemstacks.md similarity index 99% rename from chapters/itemstacks.md rename to en/chapters/itemstacks.md index 8620769..f3187f9 100644 --- a/chapters/itemstacks.md +++ b/en/chapters/itemstacks.md @@ -1,7 +1,7 @@ --- title: ItemStacks layout: default -root: ../ +root: ../../ --- ## Introduction diff --git a/chapters/lua.md b/en/chapters/lua.md similarity index 99% rename from chapters/lua.md rename to en/chapters/lua.md index 628b38b..1cc2079 100644 --- a/chapters/lua.md +++ b/en/chapters/lua.md @@ -1,7 +1,7 @@ --- title: Lua Scripts layout: default -root: ../ +root: ../../ --- ## Introduction diff --git a/chapters/node_drawtypes.md b/en/chapters/node_drawtypes.md similarity index 99% rename from chapters/node_drawtypes.md rename to en/chapters/node_drawtypes.md index 684b50a..f0d985d 100644 --- a/chapters/node_drawtypes.md +++ b/en/chapters/node_drawtypes.md @@ -1,7 +1,7 @@ --- title: Node Drawtypes layout: default -root: ../ +root: ../../ ---
diff --git a/chapters/node_metadata.md b/en/chapters/node_metadata.md similarity index 99% rename from chapters/node_metadata.md rename to en/chapters/node_metadata.md index 3fc162a..43a6646 100644 --- a/chapters/node_metadata.md +++ b/en/chapters/node_metadata.md @@ -1,7 +1,7 @@ --- title: Node Metadata layout: default -root: ../ +root: ../../ --- ## Introduction diff --git a/chapters/nodes_items_crafting.md b/en/chapters/nodes_items_crafting.md similarity index 99% rename from chapters/nodes_items_crafting.md rename to en/chapters/nodes_items_crafting.md index 1471dab..de52bfe 100644 --- a/chapters/nodes_items_crafting.md +++ b/en/chapters/nodes_items_crafting.md @@ -1,7 +1,7 @@ --- title: Nodes, Items, and Crafting layout: default -root: ../ +root: ../../ --- ## Introduction diff --git a/chapters/player_physics.md b/en/chapters/player_physics.md similarity index 99% rename from chapters/player_physics.md rename to en/chapters/player_physics.md index d13ce16..70100ca 100644 --- a/chapters/player_physics.md +++ b/en/chapters/player_physics.md @@ -1,7 +1,7 @@ --- title: Player Physics layout: default -root: ../ +root: ../../ --- ## Introduction diff --git a/chapters/privileges.md b/en/chapters/privileges.md similarity index 99% rename from chapters/privileges.md rename to en/chapters/privileges.md index c2c2c44..700081a 100644 --- a/chapters/privileges.md +++ b/en/chapters/privileges.md @@ -1,7 +1,7 @@ --- title: Privileges layout: default -root: ../ +root: ../../ --- ## Introduction diff --git a/chapters/readmore.md b/en/chapters/readmore.md similarity index 98% rename from chapters/readmore.md rename to en/chapters/readmore.md index d2f941c..5b49554 100644 --- a/chapters/readmore.md +++ b/en/chapters/readmore.md @@ -1,7 +1,7 @@ --- title: Read More layout: default -root: ../ +root: ../../ --- ## List of Resources diff --git a/chapters/releasing.md b/en/chapters/releasing.md similarity index 99% rename from chapters/releasing.md rename to en/chapters/releasing.md index 48dc6eb..95c603a 100644 --- a/chapters/releasing.md +++ b/en/chapters/releasing.md @@ -1,7 +1,7 @@ --- title: Releasing a Mod layout: default -root: ../ +root: ../../ --- ## Introduction diff --git a/index.md b/en/index.md similarity index 95% rename from index.md rename to en/index.md index 7892192..0968e19 100644 --- a/index.md +++ b/en/index.md @@ -1,14 +1,14 @@ --- title: Introduction -permalink: index.html layout: default +root: ../ --- Welcome ------- Minetest uses Lua scripts to provide modding support. -This online book aims to teach you how to create your own mods, +This online book aims to teach you how to create your own mods, starting from the basics. ### What you will need diff --git a/index.html b/index.html new file mode 100644 index 0000000..0bb44e4 --- /dev/null +++ b/index.html @@ -0,0 +1,36 @@ +--- +layout: none +--- + + + Redirecting... + + + + + diff --git a/thank_you.md b/thank_you.md deleted file mode 100644 index e0b4960..0000000 --- a/thank_you.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Thank You. -permalink: thank_you.html -layout: default ---- - -Thank you! ----------- - -Thank you for your feedback. We appreciate it. diff --git a/to_mediawiki.py b/to_mediawiki.py deleted file mode 100644 index 7956cd2..0000000 --- a/to_mediawiki.py +++ /dev/null @@ -1,30 +0,0 @@ -import pandoc, sys - -pandoc.PANDOC_PATH = '/usr/bin/pandoc' - -if len(sys.argv) != 2: - sys.stderr.write("USAGE: to_mediawiki.py path/to/chapter.md") - sys.exit(-1) - -sys.stderr.write("Reading from " + sys.argv[1] + "\n") - -ifile = open(sys.argv[1]) -input_t = "" -for line in ifile.readlines(): - if len(line.strip()) > 0 and line.strip()[len(line.strip()) - 1] == "\\": - sys.stderr.write("found 1!\n") - line = line.strip("\n").strip("\\") - line += "
\n" - input_t += line - -doc = pandoc.Document() - -input_t = input_t.replace("{% highlight lua %}", "
")
-input_t = input_t.replace("{% endhighlight %}", "
") -input_t = input_t.replace("{{ page.root }}/static/", "modding_book_") -input_t = input_t.replace("{{ page.root }}", "") - -doc.markdown = input_t - -sys.stdout.write("{{ ModdingBook }}\n\n") -sys.stdout.write(doc.mediawiki)