1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-17 23:34:50 +00:00

Update docs

This commit is contained in:
Jeremy Ruston 2023-09-10 17:23:18 +01:00
parent 701a038559
commit a4d74be3d8
2 changed files with 12 additions and 7 deletions

View File

@ -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
-->

View File

@ -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.