From 8a2b3bc831906394ecca91290794d1a3278d855c Mon Sep 17 00:00:00 2001 From: Jermolene Date: Fri, 29 Nov 2013 12:26:48 +0000 Subject: [PATCH] Lotsa docs updates --- .../clientserver/tiddlers/GettingStarted.tid | 10 --- editions/tw5.com/tiddlers/Download.tid | 21 ++--- editions/tw5.com/tiddlers/Features.tid | 6 +- editions/tw5.com/tiddlers/GettingStarted.tid | 26 ++++++ .../tw5.com/tiddlers/Release 5.0.0alpha16.tid | 10 ++- .../tiddlers/TiddlyWiki5 on Node.js.tid | 20 +++++ .../tiddlers/concepts/TiddlyWikiFolders.tid | 7 +- .../tiddlers/definitions/TiddlyFox.tid | 9 +- .../tw5.com/tiddlers/definitions/node.js.tid | 9 +- ...orking with the TiddlyWiki5 repository.tid | 82 +++++++++++++++++++ .../TiddlyWiki5_Static_Site_Generation.tid | 7 +- .../TiddlyWiki5_in_the_Sky_for_TiddlyWeb.tid | 7 +- ...ing_classic_TiddlyWiki_with_TiddlyWiki.tid | 8 +- .../moduletypes/SyncAdaptorModules.tid | 5 +- editions/tw5.com/tiddlers/readme/ReadMe.tid | 7 +- editions/tw5.com/tiddlers/roadmap/RoadMap.tid | 11 +-- .../tiddlers/saving}/ClientServer Edition.tid | 0 .../tiddlers/saving/Saving on iPad_iPhone.tid | 24 ++++++ .../saving/Saving with Encryption.tid | 17 ++++ .../tiddlers/saving/Saving with TiddlyFox.tid | 23 ++++++ .../Saving with the HTML5 fallback saver.tid | 23 ++++++ editions/tw5.com/tiddlers/tags/command.tid | 7 +- .../tiddlers/tips/GoogleChromeTips.tid | 7 +- .../tw5.com/tiddlers/tips/TitlesPolicy.tid | 7 +- 24 files changed, 286 insertions(+), 67 deletions(-) delete mode 100644 editions/clientserver/tiddlers/GettingStarted.tid create mode 100644 editions/tw5.com/tiddlers/GettingStarted.tid create mode 100644 editions/tw5.com/tiddlers/TiddlyWiki5 on Node.js.tid create mode 100644 editions/tw5.com/tiddlers/dev/Working with the TiddlyWiki5 repository.tid rename editions/{clientserver/tiddlers => tw5.com/tiddlers/saving}/ClientServer Edition.tid (100%) create mode 100644 editions/tw5.com/tiddlers/saving/Saving on iPad_iPhone.tid create mode 100644 editions/tw5.com/tiddlers/saving/Saving with Encryption.tid create mode 100644 editions/tw5.com/tiddlers/saving/Saving with TiddlyFox.tid create mode 100644 editions/tw5.com/tiddlers/saving/Saving with the HTML5 fallback saver.tid diff --git a/editions/clientserver/tiddlers/GettingStarted.tid b/editions/clientserver/tiddlers/GettingStarted.tid deleted file mode 100644 index 528f8cfd6..000000000 --- a/editions/clientserver/tiddlers/GettingStarted.tid +++ /dev/null @@ -1,10 +0,0 @@ -created: 20131129090249275 -creator: JeremyRuston -modified: 20131129090636070 -modifier: JeremyRuston -title: GettingStarted -type: text/vnd.tiddlywiki - -TiddlyWiki is highly flexible, and there are many different ways to use it. Here we're focussing on using it as a standalone file in the browser, but for more options you can also run [[TiddlyWiki5 on Node.js]]. - -1. [[Download]] TiddlyWiki by clicking this button: diff --git a/editions/tw5.com/tiddlers/Download.tid b/editions/tw5.com/tiddlers/Download.tid index 8657b5a76..daeefa93a 100644 --- a/editions/tw5.com/tiddlers/Download.tid +++ b/editions/tw5.com/tiddlers/Download.tid @@ -1,26 +1,15 @@ -created: 201311191945 +created: 20131119194500000 creator: JeremyRuston -modified: 201311191945 +modified: 20131129094606811 modifier: JeremyRuston tags: introduction title: Download +type: text/vnd.tiddlywiki -! Download Single File Editions +Download single file editions of version ''<>'' of TiddlyWiki5: |{{$:/editions/tw5.com/snippets/download-empty-button}}|Get started with an empty wiki | |{{$:/snippets/download-wiki-button}}|Download a full copy of this site, including all the documentation | -! Download Node.js Edition - -For working on the command line with the Node.js edition of TiddlyWiki5, you can install TiddlyWiki via [[npm|http://npmjs.org]]: - -``` -npm -g install tiddlywiki -``` - -The `-g` flag causes TiddlyWiki to be installed globally. - -You can also download or fork the TiddlyWiki5 GitHub repo directly: - -https://github.com/Jermolene/TiddlyWiki5 +For more advanced configurations, you can run [[TiddlyWiki5 on Node.js]]. diff --git a/editions/tw5.com/tiddlers/Features.tid b/editions/tw5.com/tiddlers/Features.tid index 28f9d53d4..c858fa224 100644 --- a/editions/tw5.com/tiddlers/Features.tid +++ b/editions/tw5.com/tiddlers/Features.tid @@ -1,12 +1,12 @@ -created: 201308221728000 +created: 20130822172800000 creator: JeremyRuston -modified: 201311091532005 +modified: 20131129101043765 modifier: JeremyRuston tags: introduction title: Features type: text/vnd.tiddlywiki -* The ability to save changes on almost any desktop HTML5 compatible-browser, with custom apps to enable saving on [[iPad/iPhone|How to use TiddlyWiki5 as a standalone HTML file with TWEdit]] and [[Android|How to use TiddlyWiki5 as a standalone HTML file with AndTidWiki]], and a cross-platform [[Firefox extension|How to use TiddlyWiki5 as a standalone HTML file with TiddlyFox]] that even runs on Android +* The ability to save changes on almost any desktop HTML5 compatible-browser, with custom apps to enable [[Saving on iPad/iPhone]] and [[Android|How to use TiddlyWiki5 as a standalone HTML file with AndTidWiki]], and a cross-platform [[Firefox extension|Saving with TiddlyFox]] that even runs on Android * [[Bitmap images|Motovun Jack.jpg]] and [[SVG images|UsingSVG]] are first-class citizens alongside text * Concise and expressive WikiText that generates semantic HTML * Integrated [[AES encryption|How to use TiddlyWiki5 as a standalone HTML file with encryption]] diff --git a/editions/tw5.com/tiddlers/GettingStarted.tid b/editions/tw5.com/tiddlers/GettingStarted.tid new file mode 100644 index 000000000..e4f40e10e --- /dev/null +++ b/editions/tw5.com/tiddlers/GettingStarted.tid @@ -0,0 +1,26 @@ +created: 20131129090249275 +creator: JeremyRuston +modified: 20131129101018342 +modifier: JeremyRuston +title: GettingStarted +type: text/vnd.tiddlywiki + +TiddlyWiki is highly flexible, and there are many different ways to use it. Here we're focussing on using it as a standalone file in the browser, which is a good choice for most users as it doesn't require any special knowledge or tools. For more options you can also run [[TiddlyWiki5 on Node.js]]. + +! The 'works anywhere' method + +{{Saving with the HTML5 fallback saver}} + +! The convenient and fast method + +Saving changes as described above is quite a high friction process, and so this method is recommended for everyone who is able to use Mozilla's [[Firefox]] browser (including [[Firefox for Android]]). + +{{Saving with TiddlyFox}} + +! Other ways of saving changes + +[[Saving with Encryption]] explains how to use TiddlyWiki5's built-in encryption to protect your content with a password. + +You can also try: + +* [[Saving on iPad/iPhone]] diff --git a/editions/tw5.com/tiddlers/Release 5.0.0alpha16.tid b/editions/tw5.com/tiddlers/Release 5.0.0alpha16.tid index a36e7fcb1..13530cd24 100644 --- a/editions/tw5.com/tiddlers/Release 5.0.0alpha16.tid +++ b/editions/tw5.com/tiddlers/Release 5.0.0alpha16.tid @@ -1,17 +1,19 @@ -created: 201311191256007 +created: 20131119125600007 creator: JeremyRuston -modified: 201311191256007 +modified: 20131129095531749 modifier: JeremyRuston -title: Release 5.0.0-alpha.16 tags: releasenote +title: Release 5.0.0-alpha.16 +type: text/vnd.tiddlywiki //[[See GitHub for detailed change history of this release|https://github.com/Jermolene/TiddlyWiki5/compare/v5.0.0-alpha.15...v5.0.0-alpha.16]]// !! New Features and Improvements +* Significant updates to the structure and content of the user documentation * Added a new plugin for displaying corner ribbons; currently used for a version banner on tw5.com * Split ''Snow White'' theme into a base ''Vanilla'' theme with all the basic formatting, leaving the decorative bits to ''Snow White'' -** Existing WikiFolders will need updating to include ''Vanilla'' as an additional theme +** Existing TiddlyWikiFolders will need updating to include ''Vanilla'' as an additional theme * The page building blocks are now driven by the system tag `$:/tags/PageTemplate` ** [[$:/TopSideBar]] and [[$:/LeftSideBar]] are no longer specially treated; use the new tag instead * Fixed problem that prevented tag configured items from shadow tiddlers interleaving with items from ordinary tiddlers diff --git a/editions/tw5.com/tiddlers/TiddlyWiki5 on Node.js.tid b/editions/tw5.com/tiddlers/TiddlyWiki5 on Node.js.tid new file mode 100644 index 000000000..c71cd9b84 --- /dev/null +++ b/editions/tw5.com/tiddlers/TiddlyWiki5 on Node.js.tid @@ -0,0 +1,20 @@ +created: 20131129094353704 +creator: JeremyRuston +modified: 20131129100329076 +modifier: JeremyRuston +title: TiddlyWiki5 on Node.js +type: text/vnd.tiddlywiki + +! Installation + +For working on the command line with Node.js, you can install TiddlyWiki via [[npm|http://npmjs.org]]: + +``` +npm -g install tiddlywiki +``` + +The `-g` flag causes TiddlyWiki to be installed globally. + +! Working with the TiddlyWiki5 repository + +[[Working with the TiddlyWiki5 repository]] is recommended if you plan on forking the TiddlyWiki5 source code. diff --git a/editions/tw5.com/tiddlers/concepts/TiddlyWikiFolders.tid b/editions/tw5.com/tiddlers/concepts/TiddlyWikiFolders.tid index 2f113ec03..594f5ce30 100644 --- a/editions/tw5.com/tiddlers/concepts/TiddlyWikiFolders.tid +++ b/editions/tw5.com/tiddlers/concepts/TiddlyWikiFolders.tid @@ -1,11 +1,12 @@ -created: 201308252142 +created: 20130825214200000 creator: JeremyRuston -modified: 201308300920 +modified: 20131129095040600 modifier: JeremyRuston tags: dev title: TiddlyWikiFolders +type: text/vnd.tiddlywiki -As well as traditional single file wikis, TiddlyWiki5 [[under Node.js|TiddlyWiki5 Node Edition]] supports wikis that are stored as a folder of individual tiddler files. +As well as traditional single file wikis, [[TiddlyWiki5 on Node.js]] supports wikis that are stored as a folder of individual tiddler files. ! Wiki folder files and folders diff --git a/editions/tw5.com/tiddlers/definitions/TiddlyFox.tid b/editions/tw5.com/tiddlers/definitions/TiddlyFox.tid index f7441538e..2a181d024 100644 --- a/editions/tw5.com/tiddlers/definitions/TiddlyFox.tid +++ b/editions/tw5.com/tiddlers/definitions/TiddlyFox.tid @@ -1,10 +1,11 @@ -created: 201308251611 +created: 20130825161100000 creator: JeremyRuston -modified: 201308251611 +modified: 20131129093610165 modifier: JeremyRuston tags: definitions title: TiddlyFox +type: text/vnd.tiddlywiki -TiddlyFox is an extension for Firefox that allows standalone TiddlyWiki files to save their changes directly to the file system. TiddlyFox works on both desktop and smartphone versions of Firefox. +TiddlyFox is an extension for Firefox that allows standalone TiddlyWiki files to save their changes directly to the file system. TiddlyFox works on both desktop and smartphone versions of [[Firefox]]. -See [[How to use TiddlyWiki5 as a standalone HTML file with TiddlyFox]]. \ No newline at end of file +See [[Saving with TiddlyFox]]. \ No newline at end of file diff --git a/editions/tw5.com/tiddlers/definitions/node.js.tid b/editions/tw5.com/tiddlers/definitions/node.js.tid index b3847b066..53c51a8f0 100644 --- a/editions/tw5.com/tiddlers/definitions/node.js.tid +++ b/editions/tw5.com/tiddlers/definitions/node.js.tid @@ -1,5 +1,10 @@ -title: Node.js +created: 20131129094739786 +creator: JeremyRuston +modified: 20131129094745311 +modifier: JeremyRuston tags: definitions +title: Node.js +type: text/vnd.tiddlywiki [[Node.js]] is a downloadable application for your PC, Mac or Linux computer that lets it run JavaScript applications. Unlike JavaScript applications running in a web browser, [[Node.js]] code has full access to the file system and other resources of the computer, enabling it to perform the roles that have traditionally been the preserve of languages like Java, PHP and Python. See http://nodejs.org for more details. @@ -7,4 +12,4 @@ For TiddlyWiki, [[Node.js]] means that we can have a single code base that can r For end users, [[Node.js]] is no more complicated to install than a web browser, but unlocks powerful capabilities such as the ability to run TiddlyWiki as a web server that you can connect to from other devices. -See [[TiddlyWiki5 Node Edition]] for more details. +See [[TiddlyWiki5 on Node.js]] for more details. diff --git a/editions/tw5.com/tiddlers/dev/Working with the TiddlyWiki5 repository.tid b/editions/tw5.com/tiddlers/dev/Working with the TiddlyWiki5 repository.tid new file mode 100644 index 000000000..7a4ce5398 --- /dev/null +++ b/editions/tw5.com/tiddlers/dev/Working with the TiddlyWiki5 repository.tid @@ -0,0 +1,82 @@ +created: 20130825214500000 +creator: JeremyRuston +modified: 20131129095206930 +modifier: JeremyRuston +tags: edition +title: Working with the TiddlyWiki5 repository +type: text/vnd.tiddlywiki + +TiddlyWiki5 can be used on the command line to perform an extensive set of operations based on tiddlers, TiddlyWikiFolders, TiddlerFiles and TiddlyWikiFiles. For example, the following command loads the tiddlers from a TiddlyWiki HTML file and then saves one of them in HTML: + +``` +node tiddlywiki.js --verbose --load mywiki.html --rendertiddler ReadMe ./readme.html +``` + +In order to use TiddlyWiki5 on the command line you must first install node.js from http://nodejs.org/ + +!!Usage + +Running `tiddlywiki.js` from the command line boots the TiddlyWiki kernel, loads the core plugins and establishes an empty wiki store. It then sequentially processes the command line arguments from left to right. The arguments are separated with spaces. + +The first argument is the optional path to the [[TiddlyWikiFolder|TiddlyWikiFolders]] to be loaded. If not present, then the current directory is used. + +The commands and their individual arguments follow, each command being identified by the prefix `--`. + +``` +node tiddlywiki.js [] [-- [[,]]] +``` + +!! Script Files + +For trying TiddlyWiki5 out under Node.js, several scripts are provided (.sh for *nix and .cmd for Windows): + +!!! `bld`: builds tw5.com + +This script builds several variants of TiddlyWiki5 for deployment on tiddlywiki.com. + +By default, files are output to a folder called `jermolene.github.com`, sibling to the TiddlyWiki5 source directory. For example: + +``` +/TiddlyWork/ - Directory for working with TiddlyWiki5 + /TiddlyWiki5/ - Directory containing the TiddlyWiki5 repo from GitHub + /jermolene.github.com/ - Directory for output files +``` + +You can override the build output directory by defining the environment variable `TW5_BUILD_OUTPUT`. The easiest way to do this is to create a personal batch file to invoke TiddlyWiki5 that first sets the environment variable and then invokes `bld`. + +The files output by `bld` are: + +* `readme.md` main readme file, output to the TiddlyWiki5 directory +* `index.html` TiddlyWiki5 standalone HTML file with content from the `tw5.com` edition +* `empty.html` TiddlyWiki5 standalone HTML file with no content +* `encrypted.html` TiddlyWiki5 standalone HTML file encrypted with the password `password` +* `test.html` TiddlyWiki5 browser-based test suite (see TestingMechanism) +* `static.html` static HTML version of the DefaultTiddlers of the `tw5.com` edition +* `static/*.html` and `static/static.css` static HTML versions of individual tiddlers + +`bld` also runs the TiddlyWiki5 Node.js-based test suite (see TestingMechanism) + +!!! `serve.sh ` or `serve.cmd `: serves tw5.com + +This script starts TiddlyWiki5 running as an HTTP server with the content from the `clientserver` edition. By default, the Node.js serves on port 8080. If the optional `username` parameter is provided, it is used for signing edits. + +To experiment with this configuration, run the script and then visit `http://0.0.0.0:8080` in a browser. + +Changes made in the browser propagate to the server over HTTP (use the browser developer console to see these requests). The server then syncs changes to the file system (and logs each change to the screen). + +!!! `wbld`: builds TiddlyWiki5 for TiddlyWeb + +This script builds and deploys the code for [[TiddlyWiki5 in the Sky for TiddlyWeb]]. If you want to experiment with your own builds of TiddlyWiki5 for TiddlyWeb you could use this batch file as a base. + +!!! `2bld`: builds TiddlyWiki 2.6.5 + +This script builds TiddlyWiki 2.6.5 from the original source and then displays the differences between them (`diff` is used for *nix, `fc` for Windows). + +!!Commands + +The following commands are available: + +<$list filter="[tag[command]sort[title]]"> + !!! <$view field="title" format="link"/> + <$transclude /> + diff --git a/editions/tw5.com/tiddlers/editions/TiddlyWiki5_Static_Site_Generation.tid b/editions/tw5.com/tiddlers/editions/TiddlyWiki5_Static_Site_Generation.tid index dd5b36326..776033a2f 100644 --- a/editions/tw5.com/tiddlers/editions/TiddlyWiki5_Static_Site_Generation.tid +++ b/editions/tw5.com/tiddlers/editions/TiddlyWiki5_Static_Site_Generation.tid @@ -1,9 +1,10 @@ -created: 201308281902 +created: 20130828190200000 creator: JeremyRuston -modified: 201308281902 +modified: 20131129095228854 modifier: JeremyRuston -tags: edition +tags: howto title: TiddlyWiki5 Static Site Generation +type: text/vnd.tiddlywiki TiddlyWiki5 can be used to generate a static HTML representation of a TiddlyWiki that doesn't need JavaScript. diff --git a/editions/tw5.com/tiddlers/editions/TiddlyWiki5_in_the_Sky_for_TiddlyWeb.tid b/editions/tw5.com/tiddlers/editions/TiddlyWiki5_in_the_Sky_for_TiddlyWeb.tid index 1a1e06197..0fc68bd45 100644 --- a/editions/tw5.com/tiddlers/editions/TiddlyWiki5_in_the_Sky_for_TiddlyWeb.tid +++ b/editions/tw5.com/tiddlers/editions/TiddlyWiki5_in_the_Sky_for_TiddlyWeb.tid @@ -1,7 +1,10 @@ -tags: edition +created: 20131129100250644 +creator: JeremyRuston +modified: 20131129100250644 modifier: JeremyRuston +tags: howto title: TiddlyWiki5 in the Sky for TiddlyWeb -modified: 201305011456 +type: text/vnd.tiddlywiki The TiddlyWiki5 in the Sky for TiddlyWeb allows content to be synchronised between TiddlyWiki5 running in the browser and a TiddlyWeb (or TiddlySpace) server. Features include: diff --git a/editions/tw5.com/tiddlers/howtos/Building_classic_TiddlyWiki_with_TiddlyWiki.tid b/editions/tw5.com/tiddlers/howtos/Building_classic_TiddlyWiki_with_TiddlyWiki.tid index c9cef5655..adc5efb25 100644 --- a/editions/tw5.com/tiddlers/howtos/Building_classic_TiddlyWiki_with_TiddlyWiki.tid +++ b/editions/tw5.com/tiddlers/howtos/Building_classic_TiddlyWiki_with_TiddlyWiki.tid @@ -1,4 +1,10 @@ +created: 20131129094452285 +creator: JeremyRuston +modified: 20131129094514823 +modifier: JeremyRuston +tags: howto title: Building classic TiddlyWiki with TiddlyWiki5 +type: text/vnd.tiddlywiki TiddlyWiki5 can be used to build older 2.x.x versions of TiddlyWiki from their constituent components. Doing so involves these additional features over and above those used for building TiddlyWiki5: @@ -9,7 +15,7 @@ TiddlyWiki5 can be used to build older 2.x.x versions of TiddlyWiki from their c ! Usage -TiddlyWikiClassic is built from the command line by running TiddlyWiki5 under Node.js. A typical usage would be: +TiddlyWikiClassic is built from the command line by running [[TiddlyWiki5 on Node.js]]. A typical usage would be: ``` node ../../tiddlywiki.js \ diff --git a/editions/tw5.com/tiddlers/moduletypes/SyncAdaptorModules.tid b/editions/tw5.com/tiddlers/moduletypes/SyncAdaptorModules.tid index 3bedc31ae..3562dac8e 100644 --- a/editions/tw5.com/tiddlers/moduletypes/SyncAdaptorModules.tid +++ b/editions/tw5.com/tiddlers/moduletypes/SyncAdaptorModules.tid @@ -1,9 +1,10 @@ -created: 201308251621 +created: 20130825162100000 creator: JeremyRuston -modified: 201311011307 +modified: 20131129094907624 modifier: JeremyRuston tags: dev moduletypes title: SyncAdaptorModules +type: text/vnd.tiddlywiki ! Introduction diff --git a/editions/tw5.com/tiddlers/readme/ReadMe.tid b/editions/tw5.com/tiddlers/readme/ReadMe.tid index 1cf0e8aa8..e52eb521e 100644 --- a/editions/tw5.com/tiddlers/readme/ReadMe.tid +++ b/editions/tw5.com/tiddlers/readme/ReadMe.tid @@ -1,4 +1,9 @@ +created: 20131129094758194 +creator: JeremyRuston +modified: 20131129094808390 +modifier: JeremyRuston title: ReadMe +type: text/vnd.tiddlywiki \define tw-wikilink-template() http://five.tiddlywiki.com/static/$uri_encoded$.html ! Welcome to TiddlyWiki5 @@ -7,6 +12,6 @@ title: ReadMe ! Getting started with TiddlyWiki under Node.js -{{TiddlyWiki5 Node Edition}} +{{TiddlyWiki5 on Node.js}} //This readme file was automatically generated by TiddlyWiki5// diff --git a/editions/tw5.com/tiddlers/roadmap/RoadMap.tid b/editions/tw5.com/tiddlers/roadmap/RoadMap.tid index 59658dfdf..ffba948c2 100644 --- a/editions/tw5.com/tiddlers/roadmap/RoadMap.tid +++ b/editions/tw5.com/tiddlers/roadmap/RoadMap.tid @@ -1,6 +1,6 @@ -created: 201308232038000 +created: 20130823203800000 creator: JeremyRuston -modified: 201311091553002 +modified: 20131129100749891 modifier: JeremyRuston tags: planning title: RoadMap @@ -23,19 +23,16 @@ The following additional features are planned or under consideration for impleme * Multilanguage support * Aliases * Search and replace -* Generalise tag handling so that any field can be a list of tiddler titles, and add mechanisms for manipulating lists * Tiddler renaming * Rich link tooltips, incorporating a preview * Keyboard shortcuts -* Keyboard macro expansion in the text editor +* Keyboard snippet expansion in the text editor * Proper use of ARIA roles -* Simpler upgrading to new core versions * Import wizard allowing individual tiddlers to be selected for import * `[img[url]]` for remote image embedding, and `[ext[url]]` for explicit external links * Further WikiText features including block quotes * Facebook, Twitter, G+ and LinkedIn widgets * Integration with the browser back and forwards buttons -* Built in JavaScript syntax highlighting * Syntax highlighter plugin * Minification of plugins (JS and CSS) * List editor with drag and drop @@ -46,4 +43,4 @@ The following additional features are planned or under consideration for impleme ! 5.0 Release -Hopefully, TiddlyWiki5 will leave beta and become a full release while we're still in 2013. This is the point at which it is declared stable enough for general use. It will continue to improve and evolve after this point, although constrained to remain backwards compatible so that plugins and content created for version 5.0 will continue to work into the indefinite future. +TiddlyWiki5 will leave beta and become a full release early in 2014. That is the point at which it is declared stable enough for general use. It will continue to improve and evolve after this point, although constrained to remain backwards compatible so that plugins and content created for version 5.0 will continue to work into the indefinite future. diff --git a/editions/clientserver/tiddlers/ClientServer Edition.tid b/editions/tw5.com/tiddlers/saving/ClientServer Edition.tid similarity index 100% rename from editions/clientserver/tiddlers/ClientServer Edition.tid rename to editions/tw5.com/tiddlers/saving/ClientServer Edition.tid diff --git a/editions/tw5.com/tiddlers/saving/Saving on iPad_iPhone.tid b/editions/tw5.com/tiddlers/saving/Saving on iPad_iPhone.tid new file mode 100644 index 000000000..7424aa779 --- /dev/null +++ b/editions/tw5.com/tiddlers/saving/Saving on iPad_iPhone.tid @@ -0,0 +1,24 @@ +created: 20131129101027725 +creator: JeremyRuston +modified: 20131129101029966 +modifier: JeremyRuston +tags: howto +title: Saving on iPad/iPhone +type: text/vnd.tiddlywiki + +The iPad/iPhone app ''TWEdit'' makes it possible to edit and save changes to TiddlyWiki5, including working offline without a network connection. [[Download it here|https://itunes.apple.com/gb/app/twedit/id409607956?mt=8]]. + +Instructions for use: + +# Open TWEdit +# Touch the title in the centre of the toolbar in order +#* A text box should appear allowing you to enter a URL +# Enter the URL `http://five.tiddlywiki.com/empty.html` +# When the empty TiddlyWiki5 has loaded, touch the ''save'' icon (it's the second icon from the right on the top toolbar) +#* An alert box should appear allowing you to enter a local filename +# Enter the filename you wish to use for the document (ending with `.html`) +# Edit your TiddlyWiki as normal +# To save changes, click the ''save'' button in the sidebar +#* A confirmation message should appear at the upper right + +//Note that TWEdit is published independently of TiddlyWiki// \ No newline at end of file diff --git a/editions/tw5.com/tiddlers/saving/Saving with Encryption.tid b/editions/tw5.com/tiddlers/saving/Saving with Encryption.tid new file mode 100644 index 000000000..04d84b79a --- /dev/null +++ b/editions/tw5.com/tiddlers/saving/Saving with Encryption.tid @@ -0,0 +1,17 @@ +created: 20130825160900000 +creator: JeremyRuston +modified: 20131129095928309 +modifier: JeremyRuston +tags: howto +title: Saving with Encryption +type: text/vnd.tiddlywiki + +When used as a single HTML file, TiddlyWiki5 allows content to be encrypted using the [[Stanford JavaScript Crypto Library]]. + +# Switch to the ''Tools'' tab in the sidebar and look for the words //This wiki is not encrypted// and a button labelled ''Set password'' +# Click ''Set password'' +# Type a password and click the ''Set'' button (or use the enter key) +# The control panel should now say //This wiki is encrypted// with buttons for changing and clearing the password +# Save the wiki using the button in the sidebar +# Optionally, open the saved file in a text editor and verify that your data is encrypted +# Open the file in your browser. You will be prompted for a password before the content is displayed diff --git a/editions/tw5.com/tiddlers/saving/Saving with TiddlyFox.tid b/editions/tw5.com/tiddlers/saving/Saving with TiddlyFox.tid new file mode 100644 index 000000000..a5cc7b509 --- /dev/null +++ b/editions/tw5.com/tiddlers/saving/Saving with TiddlyFox.tid @@ -0,0 +1,23 @@ +created: 20131129092753119 +creator: JeremyRuston +modified: 20131129093227679 +modifier: JeremyRuston +tags: howto +title: Saving with TiddlyFox +type: text/vnd.tiddlywiki + +# Ensure you have the latest version of [[Firefox]] +# Install the TiddlyFox extension from: +#* https://addons.mozilla.org/en-US/firefox/addon/tiddlyfox/ +# Restart [[Firefox]] +# [[Download]] an empty TiddlyWiki by clicking this button: +#* {{$:/editions/tw5.com/snippets/download-empty-button}} +#* Your browser may ask you to accept the download before it begins +# Locate the file you just downloaded +## You may rename it, but be sure to keep the `.html` extension +# Open the file in [[Firefox]] +# Click ''OK'' in response to the prompt from TiddlyFox that asks whether to enable saving for this file +# Try creating a new tiddler using the ''plus'' button in the sidebar. Type some content for the tiddler, and click the ''tick'' button +# Save your changes by clicking the ''download'' button in the sidebar +#* Look for the yellow notification ''Saved wiki'' at the top right of the window +# Refresh the browser window to verify that your changes have been saved correctly diff --git a/editions/tw5.com/tiddlers/saving/Saving with the HTML5 fallback saver.tid b/editions/tw5.com/tiddlers/saving/Saving with the HTML5 fallback saver.tid new file mode 100644 index 000000000..a5df20ef8 --- /dev/null +++ b/editions/tw5.com/tiddlers/saving/Saving with the HTML5 fallback saver.tid @@ -0,0 +1,23 @@ +created: 20131129092604900 +creator: JeremyRuston +modified: 20131129093507691 +modifier: JeremyRuston +tags: howto +title: Saving with the HTML5 fallback saver +type: text/vnd.tiddlywiki + +This method of saving changes is clunky but has the advantage of working on almost all desktop browsers, and many mobile browsers. + +# [[Download]] an empty TiddlyWiki by clicking this button: +#* {{$:/editions/tw5.com/snippets/download-empty-button}} +#* Your browser may ask you to accept the download before it begins +# Locate the file you just downloaded +## You may rename it, but be sure to keep the `.html` extension +# Open the file in your browser +# Try creating a new tiddler using the ''plus'' button in the sidebar. Type some content for the tiddler, and click the ''tick'' button +# Save your changes by clicking the ''download'' button in the sidebar +# Your browser will download a new copy of the wiki incorporating your changes +# Locate the newly downloaded file and open it in your browser +# Refresh the browser window to verify that your changes have been saved correctly + +''Tip'': most browsers have an option to prompt each time for the download location. This allows you to select the existing version of the file and replace it. diff --git a/editions/tw5.com/tiddlers/tags/command.tid b/editions/tw5.com/tiddlers/tags/command.tid index 93248f865..91f89de22 100644 --- a/editions/tw5.com/tiddlers/tags/command.tid +++ b/editions/tw5.com/tiddlers/tags/command.tid @@ -1,8 +1,9 @@ color: #8bbec7 -created: 201308241531 +created: 20130824153100000 creator: JeremyRuston -modified: 201308241531 +modified: 20131129094148475 modifier: JeremyRuston title: command +type: text/vnd.tiddlywiki -When run under Node.js, TiddlyWiki supports a [[command line interface|TiddlyWiki5 Node Edition]] with these built-in commands. \ No newline at end of file +When run under Node.js, TiddlyWiki supports a [[command line interface|TiddlyWiki5 on Node.js]] with these built-in commands. \ No newline at end of file diff --git a/editions/tw5.com/tiddlers/tips/GoogleChromeTips.tid b/editions/tw5.com/tiddlers/tips/GoogleChromeTips.tid index 26508a00d..11edb6892 100644 --- a/editions/tw5.com/tiddlers/tips/GoogleChromeTips.tid +++ b/editions/tw5.com/tiddlers/tips/GoogleChromeTips.tid @@ -1,11 +1,12 @@ -created: 201308251604 +created: 20130825160400000 creator: JeremyRuston -modified: 201308251604 +modified: 20131129100426443 modifier: JeremyRuston tags: tips title: GoogleChromeTips +type: text/vnd.tiddlywiki -Some suggestions for streamlining [[using TiddlyWiki as a single file|How to use TiddlyWiki5 as a standalone HTML file]] with GoogleChrome. +Some suggestions for streamlining working with GoogleChrome. ! Download Prompts diff --git a/editions/tw5.com/tiddlers/tips/TitlesPolicy.tid b/editions/tw5.com/tiddlers/tips/TitlesPolicy.tid index 2a8bf0cab..7fff0c2c4 100644 --- a/editions/tw5.com/tiddlers/tips/TitlesPolicy.tid +++ b/editions/tw5.com/tiddlers/tips/TitlesPolicy.tid @@ -1,9 +1,10 @@ -created: 201308251033 +created: 20130825103300000 creator: JeremyRuston -modified: 201308251418 +modified: 20131129100159005 modifier: JeremyRuston tags: tips title: TitlesPolicy +type: text/vnd.tiddlywiki As the structures within your TiddlyWiki documents get more complex it can be hard to keep the titles of tiddlers consistent. For example, should terms be defined in the plural or the singular? Camel case or separate words? @@ -16,4 +17,4 @@ Recording a formal titling policy can help to reduce confusion. For example, the * Use separate words for titles that are full phrases or sentences, such as FAQs, howtos or tasks ** e.g. [[How to build a TiddlyWiki5 from individual tiddlers]] * Where TiddlyWiki or TiddlyWiki5 is used as a qualifier at the start of the title, always use separate words -** e.g. [[TiddlyWiki5 Editions]] +** e.g. [[Saving with TiddlyFox]]