From fbc1f5e5f6c02b8a19217b6d166219892d96a241 Mon Sep 17 00:00:00 2001 From: Jeremy Ruston Date: Thu, 31 Oct 2013 22:03:40 +0000 Subject: [PATCH] Lots and lots and lots of docs updates Now we've got up-to-date skeleton documentation for all the widgets --- .../mechanisms/EncryptionMechanism.tid | 6 +- .../tw5.com/tiddlers/widgets/BrowseWidget.tid | 14 +++ .../tw5.com/tiddlers/widgets/ButtonWidget.tid | 29 +++++++ .../tiddlers/widgets/CheckboxWidget.tid | 18 ++++ .../tw5.com/tiddlers/widgets/CountWidget.tid | 17 ++++ .../tiddlers/widgets/DropzoneWidget.tid | 28 ++++++ .../tiddlers/widgets/EditBitmapWidget.tid | 17 ++++ .../tiddlers/widgets/EditTextWidget.tid | 28 ++++++ .../tw5.com/tiddlers/widgets/EditWidget.tid | 20 +++++ .../tiddlers/widgets/EncryptWidget.tid | 17 ++++ .../tiddlers/widgets/FieldManglerWidget.tid | 23 +++++ .../tw5.com/tiddlers/widgets/FieldsWidget.tid | 31 +++++++ .../tiddlers/widgets/LinkCatcherWidget.tid | 24 ++++++ .../tw5.com/tiddlers/widgets/LinkWidget.tid | 2 +- .../tw5.com/tiddlers/widgets/ListWidget.tid | 50 +++++------ .../tiddlers/widgets/MacroCallWidget.tid | 26 ++++++ .../tiddlers/widgets/NavigatorWidget.tid | 86 +++++++++++++++++++ .../tiddlers/widgets/PasswordWidget.tid | 17 ++++ .../tw5.com/tiddlers/widgets/RevealWidget.tid | 26 ++++++ .../tiddlers/widgets/SetVariableWidget.tid | 18 ++++ .../tiddlers/widgets/VersionWidget.tid | 14 +++ .../tw5.com/tiddlers/widgets/ViewWidget.tid | 33 +++++++ 22 files changed, 513 insertions(+), 31 deletions(-) create mode 100644 editions/tw5.com/tiddlers/widgets/BrowseWidget.tid create mode 100644 editions/tw5.com/tiddlers/widgets/ButtonWidget.tid create mode 100644 editions/tw5.com/tiddlers/widgets/CheckboxWidget.tid create mode 100644 editions/tw5.com/tiddlers/widgets/CountWidget.tid create mode 100644 editions/tw5.com/tiddlers/widgets/DropzoneWidget.tid create mode 100644 editions/tw5.com/tiddlers/widgets/EditBitmapWidget.tid create mode 100644 editions/tw5.com/tiddlers/widgets/EditTextWidget.tid create mode 100644 editions/tw5.com/tiddlers/widgets/EditWidget.tid create mode 100644 editions/tw5.com/tiddlers/widgets/EncryptWidget.tid create mode 100644 editions/tw5.com/tiddlers/widgets/FieldManglerWidget.tid create mode 100644 editions/tw5.com/tiddlers/widgets/FieldsWidget.tid create mode 100644 editions/tw5.com/tiddlers/widgets/LinkCatcherWidget.tid create mode 100644 editions/tw5.com/tiddlers/widgets/MacroCallWidget.tid create mode 100644 editions/tw5.com/tiddlers/widgets/NavigatorWidget.tid create mode 100644 editions/tw5.com/tiddlers/widgets/PasswordWidget.tid create mode 100644 editions/tw5.com/tiddlers/widgets/RevealWidget.tid create mode 100644 editions/tw5.com/tiddlers/widgets/SetVariableWidget.tid create mode 100644 editions/tw5.com/tiddlers/widgets/VersionWidget.tid create mode 100644 editions/tw5.com/tiddlers/widgets/ViewWidget.tid diff --git a/editions/tw5.com/tiddlers/mechanisms/EncryptionMechanism.tid b/editions/tw5.com/tiddlers/mechanisms/EncryptionMechanism.tid index e0c745e5c..b975a335e 100644 --- a/editions/tw5.com/tiddlers/mechanisms/EncryptionMechanism.tid +++ b/editions/tw5.com/tiddlers/mechanisms/EncryptionMechanism.tid @@ -1,6 +1,6 @@ created: 201308251542 creator: JeremyRuston -modified: 201308251543 +modified: 201310311543 modifier: JeremyRuston tags: mechanism title: EncryptionMechanism @@ -11,10 +11,10 @@ For instructions on how to use TiddlyWiki5's encryption features, see [[How to u The EncryptionMechanism is implemented with the following elements: -* A crypto "password vault" within the BootMechanism that holds the current encryption password +* A PasswordVault within the BootMechanism that holds the current encryption password * The ability of the BootMechanism to read a block of encrypted tiddlers from the TiddlyWiki file, to prompt the user for a password, and to decrypt the tiddlers * Handlers for the messages SetPasswordMessage and ClearPasswordMessage that handle the user interface for password changes -* The `<$encrypt>` widget within the main file template that encrypts a filtered list of tiddlers with the currently held password +* The EncryptWidget within the main file template that encrypts a filtered list of tiddlers with the currently held password * The [[$:/isEncrypted]] tiddler that contains "yes" or "no" according to whether there is a password in the password vault ** The availability of this tiddler allows the RevealWidget to be used to selectively display user interface elements according to whether encryption is in force * The [[$:/snippets/encryptionstatus]] snippet displays the current encryption status diff --git a/editions/tw5.com/tiddlers/widgets/BrowseWidget.tid b/editions/tw5.com/tiddlers/widgets/BrowseWidget.tid new file mode 100644 index 000000000..e01a53cc2 --- /dev/null +++ b/editions/tw5.com/tiddlers/widgets/BrowseWidget.tid @@ -0,0 +1,14 @@ +title: BrowseWidget +created: 201310241419 +creator: JeremyRuston +modified: 201310300837 +modifier: JeremyRuston +tags: widget + +! Introduction + +The browse widget displays an HTML file browser button that allows the user to choose one or more files to import. It sends a [[WidgetMessage: tw-import-tiddlers]] carrying a JSON representation of the tiddlers imported from the files up through its parents. This message usually trapped by the NavigatorWidget which adds the tiddlers to the store and updates the story to display them. + +! Content and Attributes + +The browse widget has no attributes, and ignores any contained content. diff --git a/editions/tw5.com/tiddlers/widgets/ButtonWidget.tid b/editions/tw5.com/tiddlers/widgets/ButtonWidget.tid new file mode 100644 index 000000000..3e9b9c471 --- /dev/null +++ b/editions/tw5.com/tiddlers/widgets/ButtonWidget.tid @@ -0,0 +1,29 @@ +title: ButtonWidget +created: 201310241419 +creator: JeremyRuston +modified: 201310300837 +modifier: JeremyRuston +tags: widget + +! Introduction + +The button widget displays an HTML `