From 04d26e6fae20671a6d455e113f7b0afedabc7122 Mon Sep 17 00:00:00 2001
From: Jermolene <jeremy@osmosoft.com>
Date: Mon, 27 Oct 2014 21:50:25 +0000
Subject: [PATCH] First pass at an `--editions` command
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Also added a “description” field for wiki folders.

Right now there’s too many editions listed. I think we should by
default only list editions whose `tiddlywiki.info` file has
`showInListings` set to `true`, and have an `--editions all` command
that lists everything.

@pmario please could you check that the editions in your
`TIDDLYWIKI_EDITION_PATH` are correctly listed?
---
 core/language/en-GB/Help/editions.tid      |  8 +++
 core/language/en-GB/Help/init.tid          |  2 +-
 core/modules/commands/editions.js          | 62 ++++++++++++++++++++++
 editions/classicparserdemo/tiddlywiki.info |  1 +
 editions/codemirrordemo/tiddlywiki.info    |  1 +
 editions/d3demo/tiddlywiki.info            |  1 +
 editions/de-AT-server/tiddlywiki.info      |  1 +
 editions/de-AT/tiddlywiki.info             |  1 +
 editions/de-DE/tiddlywiki.info             |  1 +
 editions/dev/tiddlywiki.info               |  1 +
 editions/empty/tiddlywiki.info             |  1 +
 editions/fr-FR/tiddlywiki.info             |  1 +
 editions/highlightdemo/tiddlywiki.info     |  1 +
 editions/katexdemo/tiddlywiki.info         |  1 +
 editions/markdowndemo/tiddlywiki.info      |  1 +
 editions/prerelease/tiddlywiki.info        |  1 +
 editions/server/tiddlywiki.info            |  1 +
 editions/tahoelafs/tiddlywiki.info         |  1 +
 editions/test/tiddlywiki.info              |  1 +
 editions/testcommonjs/tiddlywiki.info      |  1 +
 editions/translators/tiddlywiki.info       |  1 +
 editions/tw2/tiddlywiki.info               |  1 +
 editions/tw5.com-server/tiddlywiki.info    |  1 +
 editions/tw5.com/tiddlywiki.info           |  1 +
 editions/tw5tank/tiddlywiki.info           |  1 +
 editions/tw5tiddlyweb/tiddlywiki.info      |  1 +
 editions/upgrade/tiddlywiki.info           |  1 +
 editions/zh-Hans/tiddlywiki.info           |  1 +
 editions/zh-Hant/tiddlywiki.info           |  1 +
 languages/de-DE/Help/init.tid              |  2 +-
 languages/fr-FR/Help/init.tid              |  2 +-
 languages/it-IT/Help/init.tid              |  2 +-
 languages/ja-JP/Help/init.tid              |  2 +-
 languages/ru-RU/Help/init.tid              |  2 +-
 languages/zh-Hans/Help/init.tid            |  2 +-
 languages/zh-Hant/Help/init.tid            |  2 +-
 36 files changed, 104 insertions(+), 8 deletions(-)
 create mode 100644 core/language/en-GB/Help/editions.tid
 create mode 100644 core/modules/commands/editions.js

diff --git a/core/language/en-GB/Help/editions.tid b/core/language/en-GB/Help/editions.tid
new file mode 100644
index 000000000..42ccab998
--- /dev/null
+++ b/core/language/en-GB/Help/editions.tid
@@ -0,0 +1,8 @@
+title: $:/language/Help/editions
+description: Lists the available editions of TiddlyWiki
+
+Lists the names and descriptions of the available editions. You can create a new wiki of a specified edition with the `--init` command.
+
+```
+--editions
+```
diff --git a/core/language/en-GB/Help/init.tid b/core/language/en-GB/Help/init.tid
index 71a7be224..c144b0d68 100644
--- a/core/language/en-GB/Help/init.tid
+++ b/core/language/en-GB/Help/init.tid
@@ -20,4 +20,4 @@ Note:
 * The init command will fail if the wiki folder is not empty
 * The init command removes any `includeWikis` definitions in the edition's `tiddlywiki.info` file
 * When multiple editions are specified, editions initialised later will overwrite any files shared with earlier editions (so, the final `tiddlywiki.info` file will be copied from the last edition)
-* `--help editions` returns a list of available editions
+* `--editions` returns a list of available editions
diff --git a/core/modules/commands/editions.js b/core/modules/commands/editions.js
new file mode 100644
index 000000000..271b62e71
--- /dev/null
+++ b/core/modules/commands/editions.js
@@ -0,0 +1,62 @@
+/*\
+title: $:/core/modules/commands/editions.js
+type: application/javascript
+module-type: command
+
+Command to list the available editions
+
+\*/
+(function(){
+
+/*jslint node: true, browser: true */
+/*global $tw: false */
+"use strict";
+
+exports.info = {
+	name: "editions",
+	synchronous: true
+};
+
+var Command = function(params,commander) {
+	this.params = params;
+	this.commander = commander;
+};
+
+Command.prototype.execute = function() {
+	var fs = require("fs"),
+		path = require("path"),
+		self = this;
+	// Enumerate the edition paths
+	var editionPaths = $tw.getLibraryItemSearchPaths($tw.config.editionsPath,$tw.config.editionsEnvVar),
+		editions = {};
+	for(var editionIndex=0; editionIndex<editionPaths.length; editionIndex++) {
+		var editionPath = editionPaths[editionIndex];
+		// Enumerate the folders
+		var entries = fs.readdirSync(editionPath);
+		for(var entryIndex=0; entryIndex<entries.length; entryIndex++) {
+			var entry = entries[entryIndex];
+			// Check if directories have a valid tiddlywiki.info
+			if(!editions[entry] && $tw.utils.isDirectory(path.resolve(editionPath,entry))) {
+				var info;
+				try {
+					info = JSON.parse(fs.readFileSync(path.resolve(editionPath,entry,"tiddlywiki.info"),"utf8"));
+				} catch(ex) {
+				}
+				if(info) {
+					editions[entry] = info.description || "";
+				}
+			}
+		}
+	}
+	// Output the list
+	this.commander.streams.output.write("Available editions:\n\n");
+	$tw.utils.each(editions,function(description,name) {
+		self.commander.streams.output.write("    " + name + ": " + description + "\n");
+	});
+	this.commander.streams.output.write("\n");
+	return null;
+};
+
+exports.Command = Command;
+
+})();
diff --git a/editions/classicparserdemo/tiddlywiki.info b/editions/classicparserdemo/tiddlywiki.info
index f2cecd1cf..44d5993c5 100644
--- a/editions/classicparserdemo/tiddlywiki.info
+++ b/editions/classicparserdemo/tiddlywiki.info
@@ -1,4 +1,5 @@
 {
+	"description": "Demo of the experimental TiddlyWiki Classic parser plugin",
 	"plugins": [
 		"tiddlywiki/tw2parser"
 	],
diff --git a/editions/codemirrordemo/tiddlywiki.info b/editions/codemirrordemo/tiddlywiki.info
index 6ec827bad..bd07c052b 100644
--- a/editions/codemirrordemo/tiddlywiki.info
+++ b/editions/codemirrordemo/tiddlywiki.info
@@ -1,4 +1,5 @@
 {
+	"description": "Demo of the CodeMirror plugin",
 	"plugins": [
 		"tiddlywiki/codemirror"
 	],
diff --git a/editions/d3demo/tiddlywiki.info b/editions/d3demo/tiddlywiki.info
index 1c756289f..e7a4dc3f8 100644
--- a/editions/d3demo/tiddlywiki.info
+++ b/editions/d3demo/tiddlywiki.info
@@ -1,4 +1,5 @@
 {
+	"description": "Demo of the D3 plugin",
 	"plugins": [
 		"tiddlywiki/d3"
 	],
diff --git a/editions/de-AT-server/tiddlywiki.info b/editions/de-AT-server/tiddlywiki.info
index 8478e81eb..59780efac 100644
--- a/editions/de-AT-server/tiddlywiki.info
+++ b/editions/de-AT-server/tiddlywiki.info
@@ -1,4 +1,5 @@
 {
+	"description": "Server configuration of the German (Österreich) edition",
 	"plugins": [
 		"tiddlywiki/tiddlyweb",
 		"tiddlywiki/filesystem"
diff --git a/editions/de-AT/tiddlywiki.info b/editions/de-AT/tiddlywiki.info
index e598ceba2..602f96579 100755
--- a/editions/de-AT/tiddlywiki.info
+++ b/editions/de-AT/tiddlywiki.info
@@ -1,4 +1,5 @@
 {
+	"description": "German (Österreich) edition",
 	"plugins": [
 		"tiddlywiki/github-fork-ribbon",
 		"tiddlywiki/browser-sniff"],
diff --git a/editions/de-DE/tiddlywiki.info b/editions/de-DE/tiddlywiki.info
index 51acd7258..f006e5feb 100755
--- a/editions/de-DE/tiddlywiki.info
+++ b/editions/de-DE/tiddlywiki.info
@@ -1,4 +1,5 @@
 {
+	"description": "Base German edition",
 	"plugins": [
 		"tiddlywiki/github-fork-ribbon",
 		"tiddlywiki/browser-sniff"],
diff --git a/editions/dev/tiddlywiki.info b/editions/dev/tiddlywiki.info
index d737e127b..887ecf56a 100644
--- a/editions/dev/tiddlywiki.info
+++ b/editions/dev/tiddlywiki.info
@@ -1,4 +1,5 @@
 {
+	"description": "Developer documentation from http://tiddlywiki.com/dev/",
 	"plugins": [
 		"tiddlywiki/cecily",
 		"tiddlywiki/googleanalytics",
diff --git a/editions/empty/tiddlywiki.info b/editions/empty/tiddlywiki.info
index 7f28043c5..6d24d2bd1 100644
--- a/editions/empty/tiddlywiki.info
+++ b/editions/empty/tiddlywiki.info
@@ -1,4 +1,5 @@
 {
+	"description": "Empty edition",
 	"plugins": [
 	],
 	"themes": [
diff --git a/editions/fr-FR/tiddlywiki.info b/editions/fr-FR/tiddlywiki.info
index 4ed881b2c..5f9201963 100644
--- a/editions/fr-FR/tiddlywiki.info
+++ b/editions/fr-FR/tiddlywiki.info
@@ -1,4 +1,5 @@
 {
+	"description": "French (France) edition",
 	"plugins": [
 	],
 	"themes": [
diff --git a/editions/highlightdemo/tiddlywiki.info b/editions/highlightdemo/tiddlywiki.info
index 304067204..de3b00a24 100644
--- a/editions/highlightdemo/tiddlywiki.info
+++ b/editions/highlightdemo/tiddlywiki.info
@@ -1,4 +1,5 @@
 {
+	"description": "Demo of the highlight plugin",
 	"plugins": [
 		"tiddlywiki/highlight"
 	],
diff --git a/editions/katexdemo/tiddlywiki.info b/editions/katexdemo/tiddlywiki.info
index b45c7b950..17233e8d0 100644
--- a/editions/katexdemo/tiddlywiki.info
+++ b/editions/katexdemo/tiddlywiki.info
@@ -1,4 +1,5 @@
 {
+	"description": "Demo of the KaTeX plugin",
 	"plugins": [
 		"tiddlywiki/katex"
 	],
diff --git a/editions/markdowndemo/tiddlywiki.info b/editions/markdowndemo/tiddlywiki.info
index bc6c0366f..39298101c 100644
--- a/editions/markdowndemo/tiddlywiki.info
+++ b/editions/markdowndemo/tiddlywiki.info
@@ -1,4 +1,5 @@
 {
+	"description": "Demo of the Markdown plugin",
 	"plugins": [
 		"tiddlywiki/markdown"
 	],
diff --git a/editions/prerelease/tiddlywiki.info b/editions/prerelease/tiddlywiki.info
index 85e38ccce..5f9115c22 100644
--- a/editions/prerelease/tiddlywiki.info
+++ b/editions/prerelease/tiddlywiki.info
@@ -1,4 +1,5 @@
 {
+	"description": "Content for the current prerelease",
 	"plugins": [
 		"tiddlywiki/cecily",
 		"tiddlywiki/googleanalytics",
diff --git a/editions/server/tiddlywiki.info b/editions/server/tiddlywiki.info
index b82b28fae..17e38fdcd 100644
--- a/editions/server/tiddlywiki.info
+++ b/editions/server/tiddlywiki.info
@@ -1,4 +1,5 @@
 {
+	"description": "Basic client-server edition",
 	"plugins": [
 		"tiddlywiki/tiddlyweb",
 		"tiddlywiki/filesystem",
diff --git a/editions/tahoelafs/tiddlywiki.info b/editions/tahoelafs/tiddlywiki.info
index c56c82b27..53675187e 100644
--- a/editions/tahoelafs/tiddlywiki.info
+++ b/editions/tahoelafs/tiddlywiki.info
@@ -1,4 +1,5 @@
 {
+	"description": "Demo of TahoeLAFS plugin",
 	"plugins": [
 		"tiddlywiki/tahoelafs"
 	],
diff --git a/editions/test/tiddlywiki.info b/editions/test/tiddlywiki.info
index 88e26eb9d..c53b289ce 100644
--- a/editions/test/tiddlywiki.info
+++ b/editions/test/tiddlywiki.info
@@ -1,4 +1,5 @@
 {
+	"description": "TiddlyWiki core tests",
 	"plugins": [
 		"tiddlywiki/jasmine"
 	],
diff --git a/editions/testcommonjs/tiddlywiki.info b/editions/testcommonjs/tiddlywiki.info
index e84f1fb9e..864410aeb 100644
--- a/editions/testcommonjs/tiddlywiki.info
+++ b/editions/testcommonjs/tiddlywiki.info
@@ -1,4 +1,5 @@
 {
+	"description": "TiddlyWiki Common-JS tests",
 	"plugins": [
 	],
 	"themes": [
diff --git a/editions/translators/tiddlywiki.info b/editions/translators/tiddlywiki.info
index 8deca55e6..1666fd67c 100644
--- a/editions/translators/tiddlywiki.info
+++ b/editions/translators/tiddlywiki.info
@@ -1,4 +1,5 @@
 {
+	"description": "Edition for people translating TiddlyWiki",
 	"plugins": [
 		"tiddlywiki/translators"
 	],
diff --git a/editions/tw2/tiddlywiki.info b/editions/tw2/tiddlywiki.info
index 0fa65c9f1..6362b6414 100644
--- a/editions/tw2/tiddlywiki.info
+++ b/editions/tw2/tiddlywiki.info
@@ -1,4 +1,5 @@
 {
+	"description": "Tools for building TiddlyWiki Classic files from individual tiddlers",
 	"plugins": [
 		"tiddlywiki/classictools"
 	]
diff --git a/editions/tw5.com-server/tiddlywiki.info b/editions/tw5.com-server/tiddlywiki.info
index fc60e20d7..77030be28 100644
--- a/editions/tw5.com-server/tiddlywiki.info
+++ b/editions/tw5.com-server/tiddlywiki.info
@@ -1,4 +1,5 @@
 {
+	"description": "Server configuration of the tw5.com edition",
 	"plugins": [
 		"tiddlywiki/tiddlyweb",
 		"tiddlywiki/filesystem",
diff --git a/editions/tw5.com/tiddlywiki.info b/editions/tw5.com/tiddlywiki.info
index 8ddc7ce10..133ad31b2 100644
--- a/editions/tw5.com/tiddlywiki.info
+++ b/editions/tw5.com/tiddlywiki.info
@@ -1,4 +1,5 @@
 {
+	"description": "Documentation from http://tiddlywiki.com",
 	"plugins": [
 		"tiddlywiki/cecily",
 		"tiddlywiki/googleanalytics",
diff --git a/editions/tw5tank/tiddlywiki.info b/editions/tw5tank/tiddlywiki.info
index b8874c65b..e1c730f2a 100644
--- a/editions/tw5tank/tiddlywiki.info
+++ b/editions/tw5tank/tiddlywiki.info
@@ -1,4 +1,5 @@
 {
+	"description": "Demo of Tank integration",
 	"plugins": [
 		"tiddlywiki/tiddlyweb"
 	],
diff --git a/editions/tw5tiddlyweb/tiddlywiki.info b/editions/tw5tiddlyweb/tiddlywiki.info
index 85caac4a0..7e5bd9a05 100644
--- a/editions/tw5tiddlyweb/tiddlywiki.info
+++ b/editions/tw5tiddlyweb/tiddlywiki.info
@@ -1,4 +1,5 @@
 {
+	"description": "Base edition for TiddlySpace integration",
 	"plugins": [
 		"tiddlywiki/tiddlyweb"
 	],
diff --git a/editions/upgrade/tiddlywiki.info b/editions/upgrade/tiddlywiki.info
index 34e2987de..d2b8effb7 100644
--- a/editions/upgrade/tiddlywiki.info
+++ b/editions/upgrade/tiddlywiki.info
@@ -1,4 +1,5 @@
 {
+	"description": "TiddlyWiki upgrader edition",
 	"plugins": [
 		"tiddlywiki/upgrade"
 	],
diff --git a/editions/zh-Hans/tiddlywiki.info b/editions/zh-Hans/tiddlywiki.info
index 6e926f6d8..f53efea22 100644
--- a/editions/zh-Hans/tiddlywiki.info
+++ b/editions/zh-Hans/tiddlywiki.info
@@ -1,4 +1,5 @@
 {
+	"description": "Chinese (Simplified) edition",
 	"plugins": [
 	],
 	"themes": [
diff --git a/editions/zh-Hant/tiddlywiki.info b/editions/zh-Hant/tiddlywiki.info
index f65bfce72..3148f747f 100644
--- a/editions/zh-Hant/tiddlywiki.info
+++ b/editions/zh-Hant/tiddlywiki.info
@@ -1,4 +1,5 @@
 {
+	"description": "Chinese (Traditional) edition",
 	"plugins": [
 	],
 	"themes": [
diff --git a/languages/de-DE/Help/init.tid b/languages/de-DE/Help/init.tid
index d15e0508f..5549f2d21 100644
--- a/languages/de-DE/Help/init.tid
+++ b/languages/de-DE/Help/init.tid
@@ -21,4 +21,4 @@ Anmerkung:
 * Der --init Befehl löscht alle `includeWikis` Definitionen aus der neuen `tiddlywiki.info` Datei
 * Wenn mehrere Editionen importiert werden, wird die zuletzt importierte `tidlywiki.info` Datei aktiv sein. Alle anderen weden überschrieben.
 
-* `--help editions` listet alle verfügbaren Editionen auf.
+* `--editions` listet alle verfügbaren Editionen auf.
diff --git a/languages/fr-FR/Help/init.tid b/languages/fr-FR/Help/init.tid
index 3c6fdcd09..d8bb6aff7 100644
--- a/languages/fr-FR/Help/init.tid
+++ b/languages/fr-FR/Help/init.tid
@@ -20,4 +20,4 @@ Note :
 * La commande //init// échoue si le dossier wiki n'est pas vide
 * La commande //init// supprime les éventuelles définitions `includeWikis` du fichier `tiddlywiki.info` de l'édition spécifiée
 * Lorsque plusieurs éditions sont spécifiées, chaque édition écrase les fichiers qu'elle a en commun avec les précédentes (par conséquent, le fichier `tiddlywiki.info` proviendra de la dernière édition spécifiée)
-* `--help editions` renvoie une liste des éditions disponibles
+* `--editions` renvoie une liste des éditions disponibles
diff --git a/languages/it-IT/Help/init.tid b/languages/it-IT/Help/init.tid
index 931cd8053..dd63258e1 100644
--- a/languages/it-IT/Help/init.tid
+++ b/languages/it-IT/Help/init.tid
@@ -20,4 +20,4 @@ Note:
 * Il comando init fallir&agrave; se la direcotry del wiki non &egrave; vuota
 * Il comando init rimuove qualsiasi definizione `includeWikis` nell'edizione del file `tiddlywiki.info`
 * Se sono specificate edizioni multiple, l'edizione inizializzata dopo sovrascrive tutti i file condivisi con le edizioni precedenti (il file finale `tiddlywiki.info` sar&agrave; copiato dall'ultima edizione)
-* `--help editions` restituisce una lista delle edizioni disponibili
+* `--editions` restituisce una lista delle edizioni disponibili
diff --git a/languages/ja-JP/Help/init.tid b/languages/ja-JP/Help/init.tid
index 98ac682f2..86bb9ea48 100644
--- a/languages/ja-JP/Help/init.tid
+++ b/languages/ja-JP/Help/init.tid
@@ -20,4 +20,4 @@ tiddlywiki ./MyWikiFolder --init empty
 * wiki フォルダが空ではない場合、init コマンドは失敗します。
 * init コマンドは指定エディションの `tiddlywiki.info` ファイルに指定されている `includeWikis` は除外します。
 * 複数のエディションを指定した場合、先に指定したエディションに含まれているファイルは、後に指定したエディションに同名のファイルが含まれていると上書きされます。つまり最終的な `tiddlywiki.info` は最後に指定したエディションのものが使用されます。
-* `--help editions` で使用できるエディションの一覧を表示します。
+* `--editions` で使用できるエディションの一覧を表示します。
diff --git a/languages/ru-RU/Help/init.tid b/languages/ru-RU/Help/init.tid
index 71a7be224..c144b0d68 100644
--- a/languages/ru-RU/Help/init.tid
+++ b/languages/ru-RU/Help/init.tid
@@ -20,4 +20,4 @@ Note:
 * The init command will fail if the wiki folder is not empty
 * The init command removes any `includeWikis` definitions in the edition's `tiddlywiki.info` file
 * When multiple editions are specified, editions initialised later will overwrite any files shared with earlier editions (so, the final `tiddlywiki.info` file will be copied from the last edition)
-* `--help editions` returns a list of available editions
+* `--editions` returns a list of available editions
diff --git a/languages/zh-Hans/Help/init.tid b/languages/zh-Hans/Help/init.tid
index 5c6205d36..6c5dcbcc8 100644
--- a/languages/zh-Hans/Help/init.tid
+++ b/languages/zh-Hans/Help/init.tid
@@ -20,4 +20,4 @@ tiddlywiki ./MyWikiFolder --init empty
 * 若 wiki 文件夹不是空的，则初始化命令将失败
 * 初始化命令会删除 'tiddlywiki.info' 文件内所有 'includeWikis' 的定义。
 * 当指定多个版本时，这些版本于初始化后，将覆写早期版本共用的所有文件 (故此最终的 `tiddlywiki.info` 文件将是从最近的版本复制而得)
-* `--help editions` 传回所有可用版本的清单。
+* `--editions` 传回所有可用版本的清单。
diff --git a/languages/zh-Hant/Help/init.tid b/languages/zh-Hant/Help/init.tid
index b7cfccfe5..77d46ef8b 100644
--- a/languages/zh-Hant/Help/init.tid
+++ b/languages/zh-Hant/Help/init.tid
@@ -20,4 +20,4 @@ tiddlywiki ./MyWikiFolder --init empty
 * 若 wiki 資料夾不是空的，則初始化命令將失敗
 * 初始化命令會刪除 'tiddlywiki.info' 檔內所有 'includeWikis' 的定義。
 * 當指定多個版本時，這些版本於初始化後，將覆寫早期版本共用的所有檔案 (故此最終的 `tiddlywiki.info` 檔案將是從最近的版本複製而得)
-* `--help editions` 傳回所有可用版本的清單。
+* `--editions` 傳回所有可用版本的清單。