From 1ca3ba1e82b174889044a3f975e89d43031acb3a Mon Sep 17 00:00:00 2001
From: rubenwardy <rw@rubenwardy.com>
Date: Sun, 15 Jul 2018 15:28:10 +0100
Subject: [PATCH] Use Jekyll collections

---
 README.md                                     |   6 +-
 _config.yml                                   |   4 +
 _data/links_en.yml                            | 129 ------------------
 {en/chapters => _en/basics}/folders.md        |   4 +-
 {en/chapters => _en/basics}/lua.md            |   2 +
 {en => _en}/index.md                          |   1 +
 .../inventories}/inventories.md               |   3 +-
 .../inventories}/itemstacks.md                |   1 +
 .../items}/creating_textures.md               |   2 +
 {en/chapters => _en/items}/node_drawtypes.md  |   2 +
 .../items}/nodes_items_crafting.md            |   2 +
 {en/chapters => _en/map}/abms.md              |   2 +
 {en/chapters => _en/map}/environment.md       |   2 +
 {en/chapters => _en/map}/lvm.md               |   2 +
 {en/chapters => _en/map}/node_metadata.md     |   2 +
 {en/chapters => _en/players}/chat.md          |   2 +
 {en/chapters => _en/players}/chat_complex.md  |   2 +
 {en/chapters => _en/players}/formspecs.md     |   1 +
 {en/chapters => _en/players}/hud.md           |   1 +
 .../players}/player_physics.md                |   3 +-
 {en/chapters => _en/players}/privileges.md    |   4 +-
 {en/chapters => _en/players}/sfinv.md         |   1 +
 .../quality}/common_mistakes.md               |   1 +
 {en/chapters => _en/quality}/luacheck.md      |   2 +
 {en/chapters => _en/quality}/mvc.md           |   1 +
 {en/chapters => _en/quality}/readmore.md      |   1 +
 {en/chapters => _en/quality}/releasing.md     |   3 +-
 {en/chapters => _en/quality}/unit_testing.md  |   1 +
 _includes/header.html                         |  23 ++--
 sitemap.json                                  |   7 +-
 30 files changed, 66 insertions(+), 151 deletions(-)
 delete mode 100644 _data/links_en.yml
 rename {en/chapters => _en/basics}/folders.md (96%)
 rename {en/chapters => _en/basics}/lua.md (99%)
 rename {en => _en}/index.md (99%)
 rename {en/chapters => _en/inventories}/inventories.md (99%)
 rename {en/chapters => _en/inventories}/itemstacks.md (99%)
 rename {en/chapters => _en/items}/creating_textures.md (95%)
 rename {en/chapters => _en/items}/node_drawtypes.md (99%)
 rename {en/chapters => _en/items}/nodes_items_crafting.md (98%)
 rename {en/chapters => _en/map}/abms.md (97%)
 rename {en/chapters => _en/map}/environment.md (99%)
 rename {en/chapters => _en/map}/lvm.md (98%)
 rename {en/chapters => _en/map}/node_metadata.md (97%)
 rename {en/chapters => _en/players}/chat.md (98%)
 rename {en/chapters => _en/players}/chat_complex.md (98%)
 rename {en/chapters => _en/players}/formspecs.md (99%)
 rename {en/chapters => _en/players}/hud.md (99%)
 rename {en/chapters => _en/players}/player_physics.md (98%)
 rename {en/chapters => _en/players}/privileges.md (97%)
 rename {en/chapters => _en/players}/sfinv.md (99%)
 rename {en/chapters => _en/quality}/common_mistakes.md (99%)
 rename {en/chapters => _en/quality}/luacheck.md (98%)
 rename {en/chapters => _en/quality}/mvc.md (99%)
 rename {en/chapters => _en/quality}/readmore.md (98%)
 rename {en/chapters => _en/quality}/releasing.md (99%)
 rename {en/chapters => _en/quality}/unit_testing.md (99%)

diff --git a/README.md b/README.md
index 26b1bed..b1d1d88 100644
--- a/README.md
+++ b/README.md
@@ -32,10 +32,10 @@ fit my idea of quality.
 ## 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
+* Copy `_en/` to your language code
+* Translate your language code folder.
+  You can translate the file paths, just make sure you keep any ids the same.
 
 ## Using Jeykll
 
diff --git a/_config.yml b/_config.yml
index 3c957d5..62aa90f 100644
--- a/_config.yml
+++ b/_config.yml
@@ -4,3 +4,7 @@ sass:
 
 gems:
   - jekyll-sitemap
+
+collections:
+  en:
+    output: true
diff --git a/_data/links_en.yml b/_data/links_en.yml
deleted file mode 100644
index 4695619..0000000
--- a/_data/links_en.yml
+++ /dev/null
@@ -1,129 +0,0 @@
-- title: Introduction
-  link:  index.html
-
-- hr: true
-
-- title: Folder Structure
-  description: Learn how to make a mod folder, including init.lua, depends.txt and more.
-  num:   1
-  link:  chapters/folders.html
-
-- title: Lua Scripts
-  description: A basic introduction to Lua, including a guide on global/local scope.
-  num:   2
-  link:  chapters/lua.html
-
-- hr: true
-
-- title: Nodes, Items, and Crafting
-  description: Learn how to register node, items, and craft recipes using register_node, register_item, and register_craft.
-  num:   3
-  link:  chapters/nodes_items_crafting.html
-
-- title: Creating Textures
-  description: An introduction to making textures in your editor of choice, an a guide on GIMP.
-  num:   4
-  link:  chapters/creating_textures.html
-
-- title: Node Drawtypes
-  description: Guide to all drawtypes, including node boxes/nodeboxes and mesh nodes.
-  num:   5
-  link:  chapters/node_drawtypes.html
-
-- hr: true
-
-- title: Basic Map Operations
-  description: Basic operations like set_node and get_node
-  num:   6
-  link:  chapters/environment.html
-
-- title: Active Block Modifiers
-  description: Learn how to make ABMs to change blocks.
-  num:   7
-  link:  chapters/abms.html
-
-- title: Node Metadata
-  description: Using get_meta to obtain a NodeMetaRef
-  num:   8
-  link:  chapters/node_metadata.html
-
-- title: Lua Voxel Manipulators
-  description: Learn how to use LVMs to speed up map operations.
-  num:   9
-  link:  chapters/lvm.html
-
-- hr: true
-
-- title: Privileges
-  description: Registering privs
-  num:   10
-  link:  chapters/privileges.html
-
-- title: Chat and Commands
-  description: Register a chatcommand
-  num:   11
-  link:  chapters/chat.html
-
-- title: Chat Command Builder
-  description: Use ChatCmdBuilder to make a complex chat command
-  num:   12
-  link:  chapters/chat_complex.html
-
-- title: Player Physics
-  num:   13
-  link:  chapters/player_physics.html
-
-- title: Formspecs
-  num:   14
-  link:  chapters/formspecs.html
-
-- title: HUD
-  num:   15
-  link:  chapters/hud.html
-
-- title: "SFINV: Inventory Formspec"
-  num:   16
-  link:  chapters/sfinv.html
-
-- hr: true
-
-- title: ItemStacks
-  num:   17
-  link:  chapters/itemstacks.html
-
-- title: Inventories
-  num:   18
-  link:  chapters/inventories.html
-
-- hr: true
-
-- title: Common Mistakes
-  num: 19
-  link: chapters/common_mistakes.html
-
-- title: Automatic Error Checking
-  description: Use LuaCheck as a linter to find errors
-  num: 20
-  link: chapters/luacheck.html
-
-- title: Intro to Clean Architectures
-  description: Separate logic from data and API calls using the MVC pattern - Model View Controller.
-  num: 21
-  link: chapters/mvc.html
-
-- title: Automatic Unit Testing
-  description: Write tests for your mods using Busted.
-  num: 22
-  link: chapters/unit_testing.html
-
-- hr: true
-
-- title: Releasing a Mod
-  num: 23
-  link: chapters/releasing.html
-
-- title: More Resources
-  num: 24
-  link: chapters/readmore.html
-
-- hr: true
diff --git a/en/chapters/folders.md b/_en/basics/folders.md
similarity index 96%
rename from en/chapters/folders.md
rename to _en/basics/folders.md
index 6c5eea3..235b36c 100644
--- a/en/chapters/folders.md
+++ b/_en/basics/folders.md
@@ -2,6 +2,8 @@
 title: Folder Structure
 layout: default
 root: ../../
+idx: 1.1
+description: Learn how to make a mod folder, including init.lua, depends.txt and more.
 ---
 
 ## Introduction
@@ -23,7 +25,7 @@ minetest/mods.
 ![Find the mod's folder]({{ page.root }}/static/folder_modfolder.jpg)
 
 A "mod name" is used to refer to a mod. Each mod should have a unique mod name.
-Mod names can include letters, numbers, and underscores. A good mod name should 
+Mod names can include letters, numbers, and underscores. A good mod name should
 describe what the mod does, and the folder which contains the components of a mod
 needs to be given the same name as the mod name.
 
diff --git a/en/chapters/lua.md b/_en/basics/lua.md
similarity index 99%
rename from en/chapters/lua.md
rename to _en/basics/lua.md
index 19e7a79..84e228b 100644
--- a/en/chapters/lua.md
+++ b/_en/basics/lua.md
@@ -2,6 +2,8 @@
 title: Lua Scripts
 layout: default
 root: ../../
+idx: 1.2
+description: A basic introduction to Lua, including a guide on global/local scope.
 ---
 
 ## Introduction
diff --git a/en/index.md b/_en/index.md
similarity index 99%
rename from en/index.md
rename to _en/index.md
index 1a6b6c1..d5a7fe8 100644
--- a/en/index.md
+++ b/_en/index.md
@@ -4,6 +4,7 @@ layout: default
 homepage: true
 no_header: true
 root: ../
+idx: 0.1
 ---
 
 <div id="header">
diff --git a/en/chapters/inventories.md b/_en/inventories/inventories.md
similarity index 99%
rename from en/chapters/inventories.md
rename to _en/inventories/inventories.md
index 0b9b014..e7ee920 100644
--- a/en/chapters/inventories.md
+++ b/_en/inventories/inventories.md
@@ -2,6 +2,7 @@
 title: Inventories
 layout: default
 root: ../../
+idx: 5.2
 ---
 
 ## Introduction
@@ -63,7 +64,7 @@ There are three types of inventory:
 ### Player Inventories
 
 A player inventory usually has two grids, one for the main inventory and one for crafting.
-Press i in game to see your player inventory. 
+Press i in game to see your player inventory.
 
 Use a player's name to get their inventory:
 
diff --git a/en/chapters/itemstacks.md b/_en/inventories/itemstacks.md
similarity index 99%
rename from en/chapters/itemstacks.md
rename to _en/inventories/itemstacks.md
index 669d683..0a4e55a 100644
--- a/en/chapters/itemstacks.md
+++ b/_en/inventories/itemstacks.md
@@ -2,6 +2,7 @@
 title: ItemStacks
 layout: default
 root: ../../
+idx: 5.1
 ---
 
 ## Introduction
diff --git a/en/chapters/creating_textures.md b/_en/items/creating_textures.md
similarity index 95%
rename from en/chapters/creating_textures.md
rename to _en/items/creating_textures.md
index e4a294a..16c1e19 100644
--- a/en/chapters/creating_textures.md
+++ b/_en/items/creating_textures.md
@@ -2,6 +2,8 @@
 title: Creating Textures
 layout: default
 root: ../../
+idx: 2.2
+description: An introduction to making textures in your editor of choice, an a guide on GIMP.
 ---
 
 ## Introduction
diff --git a/en/chapters/node_drawtypes.md b/_en/items/node_drawtypes.md
similarity index 99%
rename from en/chapters/node_drawtypes.md
rename to _en/items/node_drawtypes.md
index be2b674..9b69927 100644
--- a/en/chapters/node_drawtypes.md
+++ b/_en/items/node_drawtypes.md
@@ -2,6 +2,8 @@
 title: Node Drawtypes
 layout: default
 root: ../../
+idx: 2.3
+description: Guide to all drawtypes, including node boxes/nodeboxes and mesh nodes.
 ---
 
 ## Introduction
diff --git a/en/chapters/nodes_items_crafting.md b/_en/items/nodes_items_crafting.md
similarity index 98%
rename from en/chapters/nodes_items_crafting.md
rename to _en/items/nodes_items_crafting.md
index 6515b9b..77a5ba2 100644
--- a/en/chapters/nodes_items_crafting.md
+++ b/_en/items/nodes_items_crafting.md
@@ -2,6 +2,8 @@
 title: Nodes, Items, and Crafting
 layout: default
 root: ../../
+idx: 2.1
+description: Learn how to register node, items, and craft recipes using register_node, register_item, and register_craft.
 ---
 
 ## Introduction
diff --git a/en/chapters/abms.md b/_en/map/abms.md
similarity index 97%
rename from en/chapters/abms.md
rename to _en/map/abms.md
index 9d4e96b..cb8cad8 100644
--- a/en/chapters/abms.md
+++ b/_en/map/abms.md
@@ -2,6 +2,8 @@
 title: Active Block Modifiers
 layout: default
 root: ../../
+idx: 3.2
+description: Learn how to make ABMs to change blocks.
 ---
 
 ## Introduction
diff --git a/en/chapters/environment.md b/_en/map/environment.md
similarity index 99%
rename from en/chapters/environment.md
rename to _en/map/environment.md
index cb1b544..1e1b89b 100644
--- a/en/chapters/environment.md
+++ b/_en/map/environment.md
@@ -2,6 +2,8 @@
 title: Basic Map Operations
 layout: default
 root: ../../
+idx: 3.1
+description: Basic operations like set_node and get_node
 ---
 
 ## Introduction
diff --git a/en/chapters/lvm.md b/_en/map/lvm.md
similarity index 98%
rename from en/chapters/lvm.md
rename to _en/map/lvm.md
index be0959c..5781980 100644
--- a/en/chapters/lvm.md
+++ b/_en/map/lvm.md
@@ -2,6 +2,8 @@
 title: Lua Voxel Manipulators
 layout: default
 root: ../../
+idx: 3.4
+description: Learn how to use LVMs to speed up map operations.
 ---
 
 ## Introduction
diff --git a/en/chapters/node_metadata.md b/_en/map/node_metadata.md
similarity index 97%
rename from en/chapters/node_metadata.md
rename to _en/map/node_metadata.md
index 2f65a57..d1b73bf 100644
--- a/en/chapters/node_metadata.md
+++ b/_en/map/node_metadata.md
@@ -2,6 +2,8 @@
 title: Node Metadata
 layout: default
 root: ../../
+idx: 3.3
+description: Using get_meta to obtain a NodeMetaRef.
 ---
 
 ## Introduction
diff --git a/en/chapters/chat.md b/_en/players/chat.md
similarity index 98%
rename from en/chapters/chat.md
rename to _en/players/chat.md
index 7544b90..af81e93 100644
--- a/en/chapters/chat.md
+++ b/_en/players/chat.md
@@ -2,6 +2,8 @@
 title: Chat and Commands
 layout: default
 root: ../../
+idx: 4.2
+description: Registering a chatcommand and handling chat messages with register_on_chat_message
 ---
 
 ## Introduction
diff --git a/en/chapters/chat_complex.md b/_en/players/chat_complex.md
similarity index 98%
rename from en/chapters/chat_complex.md
rename to _en/players/chat_complex.md
index cba7697..d5b0c4c 100644
--- a/en/chapters/chat_complex.md
+++ b/_en/players/chat_complex.md
@@ -2,6 +2,8 @@
 title: Chat Command Builder
 layout: default
 root: ../../
+idx: 4.3
+description: Use ChatCmdBuilder to make a complex chat command
 ---
 
 ## Introduction
diff --git a/en/chapters/formspecs.md b/_en/players/formspecs.md
similarity index 99%
rename from en/chapters/formspecs.md
rename to _en/players/formspecs.md
index 3e27198..55ead9a 100644
--- a/en/chapters/formspecs.md
+++ b/_en/players/formspecs.md
@@ -2,6 +2,7 @@
 title: Formspecs
 layout: default
 root: ../../
+idx: 4.5
 ---
 
 ## Introduction
diff --git a/en/chapters/hud.md b/_en/players/hud.md
similarity index 99%
rename from en/chapters/hud.md
rename to _en/players/hud.md
index 98882ca..05caa45 100644
--- a/en/chapters/hud.md
+++ b/_en/players/hud.md
@@ -2,6 +2,7 @@
 title: HUD
 layout: default
 root: ../../
+idx: 4.6
 ---
 
 ## Introduction
diff --git a/en/chapters/player_physics.md b/_en/players/player_physics.md
similarity index 98%
rename from en/chapters/player_physics.md
rename to _en/players/player_physics.md
index 11b9308..e9fe613 100644
--- a/en/chapters/player_physics.md
+++ b/_en/players/player_physics.md
@@ -2,6 +2,7 @@
 title: Player Physics
 layout: default
 root: ../../
+idx: 4.4
 ---
 
 ## Introduction
@@ -57,7 +58,7 @@ Two overrides are needed to fully restore old movement behaviour:
 * new_move: whether the player uses new movement (default: true)
 * sneak_glitch: whether the player can use 'sneak elevators' (default: false)
 
-## Mod Incompatibility 
+## Mod Incompatibility
 
 Please be warned that mods which override the same physics value of a player tend
 to be incompatible with each other. When setting an override, it overwrites
diff --git a/en/chapters/privileges.md b/_en/players/privileges.md
similarity index 97%
rename from en/chapters/privileges.md
rename to _en/players/privileges.md
index b397e4d..84e8d2b 100644
--- a/en/chapters/privileges.md
+++ b/_en/players/privileges.md
@@ -2,6 +2,8 @@
 title: Privileges
 layout: default
 root: ../../
+idx: 4.1
+description: Registering privs.
 ---
 
 ## Introduction
@@ -139,7 +141,7 @@ players privileges such as `give` and `server`, which have greater potential for
 
 To add a privilege to `basic_privs` and adjust which privileges your moderators can
 grant and revoke from other players, you must change the `basic_privs` setting.
-To do this, you must edit the minetest.conf file. 
+To do this, you must edit the minetest.conf file.
 
 By default `basic_privs` has the following value:
 
diff --git a/en/chapters/sfinv.md b/_en/players/sfinv.md
similarity index 99%
rename from en/chapters/sfinv.md
rename to _en/players/sfinv.md
index ebeb094..a4c3826 100644
--- a/en/chapters/sfinv.md
+++ b/_en/players/sfinv.md
@@ -2,6 +2,7 @@
 title: "SFINV: Inventory Formspec"
 layout: default
 root: ../../
+idx: 4.7
 ---
 
 ## Introduction
diff --git a/en/chapters/common_mistakes.md b/_en/quality/common_mistakes.md
similarity index 99%
rename from en/chapters/common_mistakes.md
rename to _en/quality/common_mistakes.md
index 11e12e4..e8f9740 100644
--- a/en/chapters/common_mistakes.md
+++ b/_en/quality/common_mistakes.md
@@ -2,6 +2,7 @@
 title: Common Mistakes
 layout: default
 root: ../../
+idx: 6.1
 ---
 
 ## Introduction
diff --git a/en/chapters/luacheck.md b/_en/quality/luacheck.md
similarity index 98%
rename from en/chapters/luacheck.md
rename to _en/quality/luacheck.md
index d0defd2..fee2e5b 100644
--- a/en/chapters/luacheck.md
+++ b/_en/quality/luacheck.md
@@ -2,6 +2,8 @@
 title: Automatic Error Checking
 layout: default
 root: ../../
+idx: 6.2
+description: Use LuaCheck to find errors
 ---
 
 ## Introduction
diff --git a/en/chapters/mvc.md b/_en/quality/mvc.md
similarity index 99%
rename from en/chapters/mvc.md
rename to _en/quality/mvc.md
index 4ad7874..057cb26 100644
--- a/en/chapters/mvc.md
+++ b/_en/quality/mvc.md
@@ -2,6 +2,7 @@
 title: Intro to Clean Architectures
 layout: default
 root: ../../
+idx: 6.3
 ---
 
 ## Introduction
diff --git a/en/chapters/readmore.md b/_en/quality/readmore.md
similarity index 98%
rename from en/chapters/readmore.md
rename to _en/quality/readmore.md
index ecbf49c..a841660 100644
--- a/en/chapters/readmore.md
+++ b/_en/quality/readmore.md
@@ -2,6 +2,7 @@
 title: Read More
 layout: default
 root: ../../
+idx: 6.6
 ---
 
 ## List of Resources
diff --git a/en/chapters/releasing.md b/_en/quality/releasing.md
similarity index 99%
rename from en/chapters/releasing.md
rename to _en/quality/releasing.md
index 492992f..ba9a851 100644
--- a/en/chapters/releasing.md
+++ b/_en/quality/releasing.md
@@ -2,6 +2,7 @@
 title: Releasing a Mod
 layout: default
 root: ../../
+idx: 6.5
 ---
 
 ## Introduction
@@ -155,7 +156,7 @@ best for you, as long as it meets these requirements:\\
 * **Stable**      - The hosting website should be unlikely to shutdown without warning.
 * **Direct link** - You should be able to click a link on the forum and download the file
                    without having to view another page.
-* **Virus Free**  - Mods with malicious content are not wanted. 
+* **Virus Free**  - Mods with malicious content are not wanted.
 
 ### Github, or another VCS
 
diff --git a/en/chapters/unit_testing.md b/_en/quality/unit_testing.md
similarity index 99%
rename from en/chapters/unit_testing.md
rename to _en/quality/unit_testing.md
index 4e2c9b3..46e5d4e 100644
--- a/en/chapters/unit_testing.md
+++ b/_en/quality/unit_testing.md
@@ -2,6 +2,7 @@
 title: Automatic Unit Testing
 layout: default
 root: ../../
+idx: 6.4
 ---
 
 ## Introduction
diff --git a/_includes/header.html b/_includes/header.html
index 1d126fb..846004a 100644
--- a/_includes/header.html
+++ b/_includes/header.html
@@ -14,25 +14,26 @@
 		{% assign language = pathsplit[1] %}
 
 		{% if language == "en" %}
-			{% assign links = site.data.links_en %}
+			{% assign links = site.en | sort: "idx" %}
 
 		{% else %}
 			{% assign language = "en" %}
-			{% assign links = site.data.links_en %}
+			{% assign links = site.en | sort: "idx" %}
 		{% endif %}
 
+		{% assign num = 0 %}
+
 		<div id="container">
 			<nav>
 				{% for link in links %}
-					{% if link.hr %}
-						{% assign hr = true %}
-					{% else %}
-						<li><a href="{{ page.root }}{{ language }}/{{ link.link }}"
-							class="{% if page.title == link.title %}selected{% endif %}{% if hr %} hr {% endif %}">
-							{% if link.num %} {{ link.num }} - {% endif %}
-							{{ link.title }}</a></li>
-						{% assign hr = false %}
-					{% endif %}
+					{% assign idsplit = link.id | split: '/' %}
+					{% assign section = idsplit[2] %}
+					<li><a href="{{ link.url }}"
+						class="{% if page.title == link.title %}selected{% endif %}{% if section != last_section and section != 'index' %} hr {% endif %}">
+						{% if section != "index" %}{{ num }} - {% endif %}
+						{{ link.title }}</a></li>
+					{% assign last_section = section %}
+					{% assign num = num | plus:1 %}
 				{% endfor %}
 
 				<li><a href="{{ page.root }}lua_api.html" class="hr">Lua Modding API Reference</a></li>
diff --git a/sitemap.json b/sitemap.json
index c7100a6..9892f1a 100644
--- a/sitemap.json
+++ b/sitemap.json
@@ -1,10 +1,12 @@
 ---
 ---
 
+{% assign pages = site.en | sort: "idx" %}
+
 [
-{% for link in site.data.links_en %}
-{% if link.hr != true %}
+{% for link in pages %}
 	{
+		"idx": {{ link.idx }},
 		"title": "{{ link.title }}",
 		"loc": "https://rubenwardy.com/minetest_modding_book/en/{{ link.link }}",
 		{% if link.description %}
@@ -13,7 +15,6 @@
 		"priority": 1
 		{% if link.num %}, "chapter_number": {{ link.num }}{% endif %}
 	},
-{% endif %}
 {% endfor %}
 
 	{