N.B.: This has been superseded by the devstore.

StorageInterface intended to ease client-side plugin development

no revisions
uses .tid files for non-JavaScript content
supports JavaScript (.js) files

Setup Instructions

N.B.:
There is a script which automates the process described below.
It is called with an argument specifying the directory in which the new instance should be created (e.g. ./devinstance.sh /tmp/TiddlyWeb creates /tmp/TiddlyWeb/dev).

change to desired root directory

$ cd ~/tiddlyweb/

download dev store plugin

$ wget http://svn.tiddlywiki.org/Trunk/contributors/FND/TiddlyWeb/plugins/devtext.py

create TiddlyWeb configuration file

$ cat > tiddlywebconfig.py
config = {
"server_store": ["devtext", { "store_root": "store" }]
}
<CTRL+D>

create instance

$ twanager instance dev
$ cd dev/

set up instance to use dev store plugin

$ mv ../devtext.py ./
$ mv ../tiddlywebconfig.py ./

N.B.: Ideally, tiddlywebconfig.py should be merged with the existing configuration file.

create plugins bag

$ twanager bag plugins
<CTRL+D>

create plugin file

$ cat > store/plugins/helloworld.js
alert("Hello world!");
<CTRL+D>

create content bag

$ twanager bag content
<CTRL+D>

create content tiddler

$ twanager tiddler lipsum content
modifier: test user
tags: test tmp

lorem ipsum dolor sit amet
<CTRL+D>

create recipe

$ twanager recipe test
desc:
policy: { "read": [], "create": [], "manage": [], "write": [], "owner": null, "delete": [] }

/bags/system/tiddlers
/bags/plugins/tiddlers
/bags/content/tiddlers
<CTRL+D>

start server

$ twanager server

visit http://0.0.0.0:8080/recipes/test/tiddlers.wiki

N.B.: Instead of creating dedicated files within the respective bags, symlinks could be used to make a TiddlyWeb instance use existing directories (e.g. from a local Subversion checkout) as bags.