From 9d69c38611ecf72edda5095a57c53d7bd3d3faff Mon Sep 17 00:00:00 2001 From: Jermolene Date: Thu, 24 Jul 2014 15:49:18 +0100 Subject: [PATCH] Docs for permalink and permaview --- .../messages/WidgetMessage_ tw-permalink.tid | 15 +++++++++++++++ .../messages/WidgetMessage_ tw-permaview.tid | 15 +++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-permalink.tid create mode 100644 editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-permaview.tid diff --git a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-permalink.tid b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-permalink.tid new file mode 100644 index 000000000..6f1d0e486 --- /dev/null +++ b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-permalink.tid @@ -0,0 +1,15 @@ +created: 20140723103751357 +modified: 20140723103751357 +tags: message +title: WidgetMessage: tw-permalink +type: text/vnd.tiddlywiki + +The `tw-permalink` message changes the browser address bar to form a [[permalink|PermaLinks]] to a specified tiddler, defaulting to the current tiddler. + +The permalink message supports the following properties on the `event` object: + +|!Name |!Description | +|param |Title of the tiddler to be permalinked | +|tiddlerTitle |The current tiddler (used by default if the tiddler title isn't specified in the `param`) | + +The permalink message can be generated by the ButtonWidget, and is handled by the story mechanism. diff --git a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-permaview.tid b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-permaview.tid new file mode 100644 index 000000000..8c42b8249 --- /dev/null +++ b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-permaview.tid @@ -0,0 +1,15 @@ +created: 20140723103751357 +modified: 20140723103751357 +tags: message +title: WidgetMessage: tw-permaview +type: text/vnd.tiddlywiki + +The `tw-permaview` message changes the browser address bar to form a [[permaview|PermaLinks]] that specifies all the open tiddlers in the main story river, and the tiddler to be navigated, defaulting to the current tiddler. + +The permaview message supports the following properties on the `event` object: + +|!Name |!Description | +|param |Title of the tiddler to be navigated within the permaview | +|tiddlerTitle |The current tiddler (used by default if the tiddler title isn't specified in the `param`) | + +The permaview message can be generated by the ButtonWidget, and is handled by the story mechanism.