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

Refactored file save filter docs

Browse Source 
@danielo515 I hope this still makes sense.
This commit is contained in:
Jermolene 2015-07-10 17:02:27 +01:00
parent c2342fce7a
commit 7ae5eab3a8
2 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
editions/tw5.com/tiddlers/mechanisms/SavingMechanism.tid Normal file
View File

@ -0,0 +1,18 @@
created: 20150709150749755
modified: 20150710154938284
tags: Mechanisms
title: SavingMechanism
type: text/vnd.tiddlywiki
The SavingMechanism is the mechanism by which TiddlyWiki generates a new HTML file and stores it. It is different from the SyncMechanism, which is concerned with synchronising changes to individual tiddlers back to a server.
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 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 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 [[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

10
editions/tw5.com/tiddlers/mechanisms/SingleFileSaveFilters.tid
View File

@ -1,10 +0,0 @@
created: 20150709150749755
modified: 20150709150806031
tags: Mechanisms
title: Filters involved in saving of single file eddition
type: text/vnd.tiddlywiki
There are two filters controlling saving TiddlyWiki as a standalone file.
* $:/config/SaverFilter determines which modified tiddlers trigger the dirty state
* $:/core/save/all determines which tiddlers are saved in the file