TiddlyWiki5/editions/tw5.com/tiddlers/concepts/PermaLinks.tid

created: 20140502213500000
modified: 20140502213500000
tags: concepts
title: PermaLinks
type: text/vnd.tiddlywiki

Permalinks allow direct links to individual tiddlers within a TiddlyWiki.

! Simple Permalinks

The simplest form of permalink is a single target tiddler title appended to the base URL with `#`:

http://tiddlywiki.com/#HelloThere

The tiddler title can contain spaces if required:

[[http://tiddlywiki.com/#Using TiddlyWiki on Node.js]]

Note that double square brackets are not required around the target tiddler title; however, if present they are silently removed.

! Story Permalinks

The permalink can also specify the story list of tiddlers that should be opened alongside the target tiddler as a [[TiddlerFilter|TiddlerFilters]]:

[[http://tiddlywiki.com/#TiddlerFields:Tiddlers TiddlerTags TiddlerFields ContentType]]

If the target tiddler isn't present in the story list then it is automatically inserted at the top. This means that the following two examples both target the tiddler `Tiddlers` within the story sequence `Tiddlers`, `Tags`, `TiddlerFields`:

[[http://tiddlywiki.com/#Tiddlers:Tags TiddlerFields]]

[[http://tiddlywiki.com/#Tiddlers:Tiddlers Tags TiddlerFields]]

It is also possible to specify a story filter without specifying a target tiddler for navigation:

<a href="http://tiddlywiki.com/#:[tags[task]]">~http://tiddlywiki.com/#:[tags[task]]</a>

! About URL encoding

There are technical restrictions on the legal characters in an URL fragment. To allow all tiddler titles to be addressed, illegal characters are subject to a process called "URL encoding" whereby problematic characters are replaced by their numeric code. For example, the space character is replaced with `%20`.

Both the target tiddler title and the story filter should be URL encoded (but not the separating colon). TiddlyWiki generates properly encoded URLs which can look quite ugly. However, in practice browsers will usually perfectly happily process arbitrary characters in URL fragments. Thus when creating permalinks manually you can choose to ignore URL encoding.
Start adding support for permalinks At this point we respect any permalink at startup, but we don’t yet dynamically update the permalink, nor do we respond to ongoing permalink changes. The permalink separator being `%00` seems like it might be a bit controversial. It buys us not having to wrap tiddler titles in double square brackets if they contain spaces. Another thing is that this scheme doesn’t support tiddler filters; the plan is to support them like this: http://tiddlywiki.com/#!Target%00%00[tag[task]sort[created]] 2014-05-02 18:21:32 +00:00			`created: 20140502213500000`
			`modified: 20140502213500000`
			`tags: concepts`
			`title: PermaLinks`
			`type: text/vnd.tiddlywiki`

			`Permalinks allow direct links to individual tiddlers within a TiddlyWiki.`

Adopt new URL scheme for permalinks Instead of using `%00` as a separator we do the more conventional `#!<target-title>:<story filter>`. 2014-05-03 10:32:55 +00:00			`! Simple Permalinks`

Add support for onhashchange Now we respond dynamically to changes in the location hash in the URL bar. It means that you can do links in HTML as `<a href=“#HelloThere”>go</a>` and in Markdown as `[example link](#HelloThere).` We still need to make startup.js more modular 2014-05-03 11:20:28 +00:00			The simplest form of permalink is a single target tiddler title appended to the base URL with `#`:
Start adding support for permalinks At this point we respect any permalink at startup, but we don’t yet dynamically update the permalink, nor do we respond to ongoing permalink changes. The permalink separator being `%00` seems like it might be a bit controversial. It buys us not having to wrap tiddler titles in double square brackets if they contain spaces. Another thing is that this scheme doesn’t support tiddler filters; the plan is to support them like this: http://tiddlywiki.com/#!Target%00%00[tag[task]sort[created]] 2014-05-02 18:21:32 +00:00
Add support for onhashchange Now we respond dynamically to changes in the location hash in the URL bar. It means that you can do links in HTML as `<a href=“#HelloThere”>go</a>` and in Markdown as `[example link](#HelloThere).` We still need to make startup.js more modular 2014-05-03 11:20:28 +00:00			`http://tiddlywiki.com/#HelloThere`
Start adding support for permalinks At this point we respect any permalink at startup, but we don’t yet dynamically update the permalink, nor do we respond to ongoing permalink changes. The permalink separator being `%00` seems like it might be a bit controversial. It buys us not having to wrap tiddler titles in double square brackets if they contain spaces. Another thing is that this scheme doesn’t support tiddler filters; the plan is to support them like this: http://tiddlywiki.com/#!Target%00%00[tag[task]sort[created]] 2014-05-02 18:21:32 +00:00
			`The tiddler title can contain spaces if required:`

Add support for onhashchange Now we respond dynamically to changes in the location hash in the URL bar. It means that you can do links in HTML as `<a href=“#HelloThere”>go</a>` and in Markdown as `[example link](#HelloThere).` We still need to make startup.js more modular 2014-05-03 11:20:28 +00:00			`[[http://tiddlywiki.com/#Using TiddlyWiki on Node.js]]`
Start adding support for permalinks At this point we respect any permalink at startup, but we don’t yet dynamically update the permalink, nor do we respond to ongoing permalink changes. The permalink separator being `%00` seems like it might be a bit controversial. It buys us not having to wrap tiddler titles in double square brackets if they contain spaces. Another thing is that this scheme doesn’t support tiddler filters; the plan is to support them like this: http://tiddlywiki.com/#!Target%00%00[tag[task]sort[created]] 2014-05-02 18:21:32 +00:00
Adopt new URL scheme for permalinks Instead of using `%00` as a separator we do the more conventional `#!<target-title>:<story filter>`. 2014-05-03 10:32:55 +00:00			`Note that double square brackets are not required around the target tiddler title; however, if present they are silently removed.`

			`! Story Permalinks`
Start adding support for permalinks At this point we respect any permalink at startup, but we don’t yet dynamically update the permalink, nor do we respond to ongoing permalink changes. The permalink separator being `%00` seems like it might be a bit controversial. It buys us not having to wrap tiddler titles in double square brackets if they contain spaces. Another thing is that this scheme doesn’t support tiddler filters; the plan is to support them like this: http://tiddlywiki.com/#!Target%00%00[tag[task]sort[created]] 2014-05-02 18:21:32 +00:00
Adopt new URL scheme for permalinks Instead of using `%00` as a separator we do the more conventional `#!<target-title>:<story filter>`. 2014-05-03 10:32:55 +00:00			`The permalink can also specify the story list of tiddlers that should be opened alongside the target tiddler as a [[TiddlerFilter\|TiddlerFilters]]:`
Start adding support for permalinks At this point we respect any permalink at startup, but we don’t yet dynamically update the permalink, nor do we respond to ongoing permalink changes. The permalink separator being `%00` seems like it might be a bit controversial. It buys us not having to wrap tiddler titles in double square brackets if they contain spaces. Another thing is that this scheme doesn’t support tiddler filters; the plan is to support them like this: http://tiddlywiki.com/#!Target%00%00[tag[task]sort[created]] 2014-05-02 18:21:32 +00:00
Add support for onhashchange Now we respond dynamically to changes in the location hash in the URL bar. It means that you can do links in HTML as `<a href=“#HelloThere”>go</a>` and in Markdown as `[example link](#HelloThere).` We still need to make startup.js more modular 2014-05-03 11:20:28 +00:00			`[[http://tiddlywiki.com/#TiddlerFields:Tiddlers TiddlerTags TiddlerFields ContentType]]`
Start adding support for permalinks At this point we respect any permalink at startup, but we don’t yet dynamically update the permalink, nor do we respond to ongoing permalink changes. The permalink separator being `%00` seems like it might be a bit controversial. It buys us not having to wrap tiddler titles in double square brackets if they contain spaces. Another thing is that this scheme doesn’t support tiddler filters; the plan is to support them like this: http://tiddlywiki.com/#!Target%00%00[tag[task]sort[created]] 2014-05-02 18:21:32 +00:00
			If the target tiddler isn't present in the story list then it is automatically inserted at the top. This means that the following two examples both target the tiddler `Tiddlers` within the story sequence `Tiddlers`, `Tags`, `TiddlerFields`:

Add support for onhashchange Now we respond dynamically to changes in the location hash in the URL bar. It means that you can do links in HTML as `<a href=“#HelloThere”>go</a>` and in Markdown as `[example link](#HelloThere).` We still need to make startup.js more modular 2014-05-03 11:20:28 +00:00			`[[http://tiddlywiki.com/#Tiddlers:Tags TiddlerFields]]`
Adopt new URL scheme for permalinks Instead of using `%00` as a separator we do the more conventional `#!<target-title>:<story filter>`. 2014-05-03 10:32:55 +00:00
Add support for onhashchange Now we respond dynamically to changes in the location hash in the URL bar. It means that you can do links in HTML as `<a href=“#HelloThere”>go</a>` and in Markdown as `[example link](#HelloThere).` We still need to make startup.js more modular 2014-05-03 11:20:28 +00:00			`[[http://tiddlywiki.com/#Tiddlers:Tiddlers Tags TiddlerFields]]`
Adopt new URL scheme for permalinks Instead of using `%00` as a separator we do the more conventional `#!<target-title>:<story filter>`. 2014-05-03 10:32:55 +00:00
			`It is also possible to specify a story filter without specifying a target tiddler for navigation:`

Add support for onhashchange Now we respond dynamically to changes in the location hash in the URL bar. It means that you can do links in HTML as `<a href=“#HelloThere”>go</a>` and in Markdown as `[example link](#HelloThere).` We still need to make startup.js more modular 2014-05-03 11:20:28 +00:00			`<a href="http://tiddlywiki.com/#:[tags[task]]">~http://tiddlywiki.com/#:[tags[task]]</a>`
Adopt new URL scheme for permalinks Instead of using `%00` as a separator we do the more conventional `#!<target-title>:<story filter>`. 2014-05-03 10:32:55 +00:00
			`! About URL encoding`

			There are technical restrictions on the legal characters in an URL fragment. To allow all tiddler titles to be addressed, illegal characters are subject to a process called "URL encoding" whereby problematic characters are replaced by their numeric code. For example, the space character is replaced with `%20`.

			`Both the target tiddler title and the story filter should be URL encoded (but not the separating colon). TiddlyWiki generates properly encoded URLs which can look quite ugly. However, in practice browsers will usually perfectly happily process arbitrary characters in URL fragments. Thus when creating permalinks manually you can choose to ignore URL encoding.`