mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2026-08-03 01:18:55 +00:00
Code Issues Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Jeremy Ruston
2023-10-03 18:40:48 +01:00
parent 29575d01bf
commit 3254684dd6
4 changed files with 18 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/tiddlywiki/tour/docs.tid
+12
View File
@@ -0,0 +1,12 @@
title: $:/plugins/tiddlywiki/tour/docs
Tour definition tiddlers have the following fields:
|!Name |!Description |
|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 |
plugins/tiddlywiki/tour/globals.tid
+5 -14
View File
@@ -5,24 +5,15 @@ 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.
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
$:/state/tour/step: title of current step of the tour
* $:/config/CurrentTour: title of current tour definition tiddler
* $:/state/tour/step: title of current step of the tour
These config tiddlers may be changed directly as required:
$:/config/ShowTour: "show" (default) or "hide"
$:/config/AutoStartTour: "no" (default) or "yes"
Tour definition tiddlers have the following fields:
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
* $:/config/ShowTour: "show" (default) or "hide"
* $:/config/AutoStartTour: "no" (default) or "yes"
-->
plugins/tiddlywiki/tour/plugin.info
+1 -1
View File
@@ -2,6 +2,6 @@
"title": "$:/plugins/tiddlywiki/tour",
"name": "Tour",
"description": "A tour of TiddlyWiki",
"list": "readme settings",
"list": "readme docs settings",
"dependents": ["$:/plugins/tiddlywiki/confetti","$:/plugins/tiddlywiki/dynannotate"]
}
plugins/tiddlywiki/tour/readme.tid
-3
View File
@@ -1,6 +1,3 @@
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.