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)
This commit is contained in:
Jermolene 2015-09-15 13:37:01 +01:00
parent 803d70225a
commit 746aab2cf6
6 changed files with 55 additions and 0 deletions

View File

@ -0,0 +1,3 @@
title: $:/DefaultTiddlers
[[Improving TiddlyWiki Documentation]]

View File

@ -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}}/>

View File

@ -0,0 +1,11 @@
{
"tiddlers": [
{
"file": "../../../tw5.com/tiddlers/system/DefaultTiddlers.tid",
"fields": {
"title": "$:/tw5.com/DefaultTiddlers"
},
"isTiddlerFile": true
}
]
}

View File

@ -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"]
}
}

View File

@ -0,0 +1,5 @@
{
"directories": [
"../../../../editions/tw5.com/tiddlers"
]
}

View File

@ -0,0 +1,7 @@
{
"title": "$:/plugins/tiddlywiki/tw5.com-docs",
"description": "Documentation from tiddlywiki.com",
"author": "JeremyRuston",
"core-version": ">=5.0.0",
"list": ""
}