mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-06-16 10:29:54 +00:00
Code Issues Releases Wiki Activity

Update SavingMechanism docs

Browse Source
This commit is contained in:
Jermolene 2015-07-12 09:08:19 +01:00
parent e0aacc84d5
commit 396af28d16
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
editions/tw5.com/tiddlers/mechanisms/SavingMechanism.tid
View File

@ -1,5 +1,5 @@
created: 20150709150749755
modified: 20150710154938284
modified: 20150712080651008
tags: Mechanisms
title: SavingMechanism
type: text/vnd.tiddlywiki
@ -8,11 +8,12 @@ The SavingMechanism is the mechanism by which TiddlyWiki generates a new HTML fi
The following steps are involved:
* The saver mechanism uses the filter defined in $:/config/SaverFilter to specify which modified tiddlers trigger the dirty state for the wiki
# The saver mechanism uses the filter defined in $:/config/SaverFilter to specify which modified tiddlers trigger the dirty state for the wiki
# The ButtonWidget is used to generate a [[tm-save-wiki|WidgetMessage: tm-save-wiki]] message to trigger the save operation
# The optional parameter for the message specifies the template that will be used for generating the HTML file, defaulting to $:/core/save/all
#* The plugin $:/plugins/tiddlywiki/tiddlyweb in the client-server configuration replaces the default template with $:/plugins/tiddlywiki/tiddlyweb/save/offline
# The template includes a variable assignment that specifies a filter to select the tiddlers that should be included in the saved file. It then transcludes the main page template `$:/core/templates/tiddlywiki5.html`
#* The template includes a reference to `$(publishFilter)$` that allows the filter to be customised via a global variable
# The [[tm-save-wiki|WidgetMessage: tm-save-wiki]] handler renders the template to generate the HTML file
# The message handler chooses the highest priority "saver" module that can handle saving the file
#* See http://tiddlywiki.com/dev/#Saver for more details