1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-06-16 02:19:55 +00:00

Docs and tweaks for #2904

@saqimtiaz I added a dash to separate the words in the variable names
for consistency with other core variables.
This commit is contained in:
Jermolene 2017-06-29 08:47:26 +01:00
parent 5d74513a97
commit 2d0ac7245f
4 changed files with 30 additions and 4 deletions

View File

@ -60,8 +60,8 @@ NavigatorWidget.prototype.execute = function() {
// Get our parameters
this.storyTitle = this.getAttribute("story");
this.historyTitle = this.getAttribute("history");
this.setVariable("tv-storylist",this.storyTitle);
this.setVariable("tv-historylist",this.historyTitle);
this.setVariable("tv-story-list",this.storyTitle);
this.setVariable("tv-history-list",this.historyTitle);
// Construct the child widgets
this.makeChildWidgets();
};

View File

@ -0,0 +1,9 @@
created: 20170629074522030
modified: 20170629074609739
tags: Variables [[Core Variables]]
title: tv-history-list Variable
type: text/vnd.tiddlywiki
The <<.def tv-history-list>> [[variable|Variables]] is assigned by the [[NavigatorWidget]] to contain the title of the tiddler containing the current history list.
Compare <<.vlink tv-story-list>>.

View File

@ -0,0 +1,9 @@
created: 20170629074200301
modified: 20170629074520393
tags: Variables [[Core Variables]]
title: tv-story-list Variable
type: text/vnd.tiddlywiki
The <<.def tv-story-list>> [[variable|Variables]] is assigned by the [[NavigatorWidget]] to contain the title of the tiddler containing the current story list.
Compare <<.vlink tv-history-list>>.

View File

@ -1,9 +1,9 @@
caption: navigator
created: 20131024141900000
modified: 20150619154056283
modified: 20170629074415261
tags: Widgets
title: NavigatorWidget
type: text/vnd.tiddlywiki
caption: navigator
! Introduction
@ -32,3 +32,11 @@ The following [[Messages]] are handled by the navigator widget:
</li>
</$list>
</ul>
! Variables
The following [[Variables]] are assigned by the navigator widget:
* <<.vlink tv-story-list>>, giving the name of the tiddler containing the story list
* <<.vlink tv-history-list>>, giving the name of the tiddler containing the history list