From a4d74be3d8d60dbdc74093b4049ef01c735d7bf8 Mon Sep 17 00:00:00 2001 From: Jeremy Ruston Date: Sun, 10 Sep 2023 17:23:18 +0100 Subject: [PATCH] Update docs --- plugins/tiddlywiki/tour/globals.tid | 15 ++++++++------- plugins/tiddlywiki/tour/readme.tid | 4 ++++ 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/plugins/tiddlywiki/tour/globals.tid b/plugins/tiddlywiki/tour/globals.tid index 00cb784d1..a0e93d450 100644 --- a/plugins/tiddlywiki/tour/globals.tid +++ b/plugins/tiddlywiki/tour/globals.tid @@ -6,16 +6,17 @@ tags: $:/tags/Global The following state tiddlers control the tour. They should not be directly modified, but rather use the appropriate procedure to ensure that all the associated actions are performed. -$:/config/CurrentTour - title of current tour definition tiddler -$:/config/ShowTour - "show" (default) or "hide" -$:/state/tour/step - title of current step of the tour +$:/config/CurrentTour: title of current tour definition tiddler +$:/config/ShowTour: "show" (default) or "hide" +$:/state/tour/step: title of current step of the tour Tour definition tiddlers have the following fields: -tour-tag - name of tag used to define tour step sequence -logo - title of tiddler containing logo of tour - - +tags: must include $:/tags/Tour +tour-tag: name of tag used to define tour step sequence +logo: title of tiddler containing logo of tour +description: brief description of the tour +text: longer description of the tour --> diff --git a/plugins/tiddlywiki/tour/readme.tid b/plugins/tiddlywiki/tour/readme.tid index 4807aaa36..6df35d3ba 100644 --- a/plugins/tiddlywiki/tour/readme.tid +++ b/plugins/tiddlywiki/tour/readme.tid @@ -1,2 +1,6 @@ title: $:/plugins/tiddlywiki/tour/readme +The Tour Plugin for TiddlyWiki provides a framework for making interactive guided tours. An "Introduction to ~TiddlyWiki" tour is included in the plugin but it is also possible to load additional tours and switch between them. + + +