tiddlywebplugins.urls 0.6.1

Configuration

This plugin is a “system” and a “twanager” plugin. Type twanager usage in the command line. Your tiddlywebconfig.py should look similar to this configuration:

config = {
'system_plugins': ['tiddlywebwiki', 'tiddlywebplugins.urls' ],
'secret': 'XXXXXXXX',
'twanager_plugins': ['tiddlywebwiki', 'tiddlywebplugins.urls'],

# the tiddlywebwiki.friendlywiki function doesn't work with urls plugin,

# it needs to be disabled.
'tiddlywebwiki.friendlywiki': False,

#'url_bag':'__urls',
}

Note: All urls are stored in a bag called “urls” by default.

The name of this bag can be changed by adding “urls_bag” to tiddlywebconfig.py, but all tiddlers in the bag must be “url tiddlers” of the described format. If this bag doesn’t exists already, it will be created automatically.

Flexible Version

Using the above format you’d need to create one tiddler per recipe. This isn’t very “user friendly”. So we need to be more flexibe, using “placeholders” to define the relation. Now we want to map every recipe_name, that the user may enter eg: /wiki/anyRecipeName:

title:
/wiki/{recipe_name:segment}

text:
/recipes/{{ recipe_name }}/tiddlers.wiki

A URL http://example.com/wiki/myWiki will load http://example.com/recipes/myWiki/tiddlers.wiki

Link to a Single Page Application

It is possible to directly link to a single tiddler within a recipe or bag:

title:
/spa/{spa_name:segment}

text:
/recipes/my_recipe/tiddlers/{{ spa_name }}
or
/bags/my_bag/tiddlers/{{ spa_name }}

Be aware of the title /spa prefix. It is optional. Here it is used, to separate the function from the “Rewrite Recipe URL” configuration.

Redirect to internal URL

If you want to redirect instead of rewrite to an internal URL, you can add the tag “redirect”:

title:
/wiki/{user:segment}

tags:
redirect

text:
/recipes/{{ user }}/tiddlers.wiki

Be aware, that adding a user will not automatically add a user recipe. So if you need one, you need to create it.

Redirect to exernal URL

To create a short link to google.com, you might do the following. There is no need for the “redirect” tag:

title:
/google

text:
http://www.google.com