From 746aab2cf6bbe3c1905efd5caf80e40e23b914b0 Mon Sep 17 00:00:00 2001 From: Jermolene Date: Tue, 15 Sep 2015 13:37:01 +0100 Subject: [PATCH] Create a plugin and edition for tw5.com docs By making the docs available as a plugin we make it easier for people to fork their own copy of the docs without losing the ability to get updates in the future (which can be done just be updating the docs plugin) --- .../tw5.com-docs/tiddlers/DefaultTiddlers.tid | 3 +++ .../Improving TiddlyWiki Documentation.tid | 15 +++++++++++++++ .../tiddlers/external/tiddlywiki.files | 11 +++++++++++ editions/tw5.com-docs/tiddlywiki.info | 14 ++++++++++++++ .../tw5.com-docs/files/tiddlywiki.files | 5 +++++ plugins/tiddlywiki/tw5.com-docs/plugin.info | 7 +++++++ 6 files changed, 55 insertions(+) create mode 100644 editions/tw5.com-docs/tiddlers/DefaultTiddlers.tid create mode 100644 editions/tw5.com-docs/tiddlers/Improving TiddlyWiki Documentation.tid create mode 100644 editions/tw5.com-docs/tiddlers/external/tiddlywiki.files create mode 100644 editions/tw5.com-docs/tiddlywiki.info create mode 100644 plugins/tiddlywiki/tw5.com-docs/files/tiddlywiki.files create mode 100644 plugins/tiddlywiki/tw5.com-docs/plugin.info diff --git a/editions/tw5.com-docs/tiddlers/DefaultTiddlers.tid b/editions/tw5.com-docs/tiddlers/DefaultTiddlers.tid new file mode 100644 index 000000000..c28e1286d --- /dev/null +++ b/editions/tw5.com-docs/tiddlers/DefaultTiddlers.tid @@ -0,0 +1,3 @@ +title: $:/DefaultTiddlers + +[[Improving TiddlyWiki Documentation]] diff --git a/editions/tw5.com-docs/tiddlers/Improving TiddlyWiki Documentation.tid b/editions/tw5.com-docs/tiddlers/Improving TiddlyWiki Documentation.tid new file mode 100644 index 000000000..f79961d4f --- /dev/null +++ b/editions/tw5.com-docs/tiddlers/Improving TiddlyWiki Documentation.tid @@ -0,0 +1,15 @@ +title: Improving TiddlyWiki Documentation + +This edition of TiddlyWiki is a tool to help people make and submit improvements to the main documentation on http://tiddlywiki.com/ + +In this wiki, all the tiddlers from http://tiddlywiki.com (to be precise, all the tiddlers [[from here|https://github.com/Jermolene/TiddlyWiki5/tree/master/editions/tw5.com/tiddlers]]) are packed into a plugin: + +[[$:/plugins/tiddlywiki/tw5.com-docs]] + +This means that the original documentation tiddlers become //shadow tiddlers//: if you edit them, you can just delete your modified copy to revert to the shadow value. + +Note that currently some functionality doesn't work properly because of macros and filters written expecting all the content tiddlers to be non-shadow tiddlers. For example, see [[Community]]. + +''Default tiddlers from tiddlywiki.com'': + +<$macrocall $name="list-links" filter={{$:/tw5.com/DefaultTiddlers}}/> diff --git a/editions/tw5.com-docs/tiddlers/external/tiddlywiki.files b/editions/tw5.com-docs/tiddlers/external/tiddlywiki.files new file mode 100644 index 000000000..d28531274 --- /dev/null +++ b/editions/tw5.com-docs/tiddlers/external/tiddlywiki.files @@ -0,0 +1,11 @@ +{ + "tiddlers": [ + { + "file": "../../../tw5.com/tiddlers/system/DefaultTiddlers.tid", + "fields": { + "title": "$:/tw5.com/DefaultTiddlers" + }, + "isTiddlerFile": true + } + ] +} \ No newline at end of file diff --git a/editions/tw5.com-docs/tiddlywiki.info b/editions/tw5.com-docs/tiddlywiki.info new file mode 100644 index 000000000..1a80ab6a4 --- /dev/null +++ b/editions/tw5.com-docs/tiddlywiki.info @@ -0,0 +1,14 @@ +{ + "description": "Documentation from tw5.com edition", + "plugins": [ + "tiddlywiki/tw5.com-docs" + ], + "themes": [ + "tiddlywiki/vanilla", + "tiddlywiki/snowwhite" + ], + "build": { + "index": [ + "--rendertiddler","$:/core/save/all","index.html","text/plain"] + } +} diff --git a/plugins/tiddlywiki/tw5.com-docs/files/tiddlywiki.files b/plugins/tiddlywiki/tw5.com-docs/files/tiddlywiki.files new file mode 100644 index 000000000..95b2ff7c8 --- /dev/null +++ b/plugins/tiddlywiki/tw5.com-docs/files/tiddlywiki.files @@ -0,0 +1,5 @@ +{ + "directories": [ + "../../../../editions/tw5.com/tiddlers" + ] +} \ No newline at end of file diff --git a/plugins/tiddlywiki/tw5.com-docs/plugin.info b/plugins/tiddlywiki/tw5.com-docs/plugin.info new file mode 100644 index 000000000..10eaa3c98 --- /dev/null +++ b/plugins/tiddlywiki/tw5.com-docs/plugin.info @@ -0,0 +1,7 @@ +{ + "title": "$:/plugins/tiddlywiki/tw5.com-docs", + "description": "Documentation from tiddlywiki.com", + "author": "JeremyRuston", + "core-version": ">=5.0.0", + "list": "" +}