From 6b457ee4998a466bdc5cfdabfa1d5542fa30909a Mon Sep 17 00:00:00 2001 From: Jermolene Date: Wed, 16 Jul 2014 10:06:31 +0100 Subject: [PATCH] Docs update --- .../tiddlers/mechanisms/UpgradeMechanism.tid | 4 ++-- .../WidgetMessage_ tw-import-tiddlers.tid | 15 ++++++++++----- .../messages/WidgetMessage_ tw-perform-import.tid | 14 ++++++++++++++ 3 files changed, 26 insertions(+), 7 deletions(-) create mode 100644 editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-perform-import.tid diff --git a/editions/tw5.com/tiddlers/mechanisms/UpgradeMechanism.tid b/editions/tw5.com/tiddlers/mechanisms/UpgradeMechanism.tid index ccc458dd5..fdcdac7be 100644 --- a/editions/tw5.com/tiddlers/mechanisms/UpgradeMechanism.tid +++ b/editions/tw5.com/tiddlers/mechanisms/UpgradeMechanism.tid @@ -25,8 +25,8 @@ tags: mechanism * Grouping plugins * Incoming tiddler preview -* Better display text for plugins -* Better handling of encrypted upgrades +* ~~Better display text for plugins~~ +* ~~Better handling of encrypted upgrades~~ * Docs * ~~Add upgrade plugin containing instructions and one-shot UI~~ * ~~Suppressing $:/UpgradeLibrary and upgrade plugin from save~~ diff --git a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-import-tiddlers.tid b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-import-tiddlers.tid index e1bd46db7..69328cda9 100644 --- a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-import-tiddlers.tid +++ b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-import-tiddlers.tid @@ -1,14 +1,19 @@ -created: 20140226084658099 -modified: 20140226195055502 +created: 20140716084658099 +modified: 20140716195055502 tags: message navigator-message title: WidgetMessage: tw-import-tiddlers 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 | |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. + +! 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 diff --git a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-perform-import.tid b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-perform-import.tid new file mode 100644 index 000000000..1053e02f5 --- /dev/null +++ b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-perform-import.tid @@ -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.