mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-12-25 09:30:28 +00:00
Code Issues Releases Wiki Activity

Docs update

Browse Source
This commit is contained in:
Jermolene 2014-07-16 10:06:31 +01:00
parent e40a0c07b8
commit 6b457ee499
3 changed files with 26 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
editions/tw5.com/tiddlers/mechanisms/UpgradeMechanism.tid
View File

@ -25,8 +25,8 @@ tags: mechanism
* Grouping plugins * Grouping plugins
* Incoming tiddler preview * Incoming tiddler preview
* Better display text for plugins * ~~Better display text for plugins~~
* Better handling of encrypted upgrades * ~~Better handling of encrypted upgrades~~
* Docs * Docs
* ~~Add upgrade plugin containing instructions and one-shot UI~~ * ~~Add upgrade plugin containing instructions and one-shot UI~~
* ~~Suppressing $:/UpgradeLibrary and upgrade plugin from save~~ * ~~Suppressing $:/UpgradeLibrary and upgrade plugin from save~~

15
editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-import-tiddlers.tid
View File

@ -1,14 +1,19 @@
created: 20140226084658099 created: 20140716084658099
modified: 20140226195055502 modified: 20140716195055502
tags: message navigator-message tags: message navigator-message
title: WidgetMessage: tw-import-tiddlers title: WidgetMessage: tw-import-tiddlers
type: text/vnd.tiddlywiki type: text/vnd.tiddlywiki
The `tw-import-tiddlers` message inserts a list of tiddlers into the store. If multiple tiddlers are imported then a report is displayed; if only one tiddler is imported then it is displayed instead. The import message requires the following properties on the `event` object: The `tw-import-tiddlers` message inserts a list of tiddlers into the pending import tiddler [[$:/Import]]. It also applies any active ''upgrader'' modules to each tiddler as it arrives (see the UpgradeMechanism for more details).
|!Name |!Description | |!Name |!Description |
|param |JSON text of the array of tiddlers to be imported | |param |JSON text of the array of tiddlers to be imported |
This message is handled by the NavigatorWidget.
The import tiddlers message is usually generated with the DropzoneWidget or the BrowseWidget, and is handled by the NavigatorWidget. The import tiddlers message is usually generated with the DropzoneWidget or the BrowseWidget, and is handled by the NavigatorWidget.
! Configuration Variables
The variable `tw-auto-open-on-import` controls whether the `tw-import-tiddlers` message automatically triggers the display of the pending import tiddler [[$:/Import]]:
* ''no'': The pending import tiddler is not opened in the story
* ''yes'': The pending import tiddler is opened in th story. This is the default

14
editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-perform-import.tid Normal file
View File

@ -0,0 +1,14 @@
created: 20140716084242809
modified: 20140716084341303
tags: message navigator-message
title: WidgetMessage: tw-perform-import
type: text/vnd.tiddlywiki
The perform import message copies tiddlers from a specified plugin into the main store. See the UpgradeMechanism for an overview of how it is used by the core.
|!Name |!Description |
|param |Title of the pending import tiddler. Defaults to ''$:/Import'' |
To select which tiddlers are to be imported, fields with names formed from `selection-` plus the title of the tiddler are used. The value ''unchecked'' causes the tiddler to be skipped from the import.
The perform import message is usually generated with the ButtonWidget and is handled by the NavigatorWidget.