From 813bd2fe1d68056e10cbf72383ec7517ea609ddb Mon Sep 17 00:00:00 2001 From: Jermolene Date: Wed, 17 Sep 2014 08:36:39 +0100 Subject: [PATCH] More docs updates --- .../Creating and editing tiddlers.tid | 14 ++++---- editions/tw5.com/tiddlers/Empty Edition.tid | 11 +++++++ .../tiddlers/definitions/TiddlyDesktop.tid | 16 ++++++++-- .../tw5.com/tiddlers/editions/Editions.tid | 28 ++++------------ .../TiddlyWiki in the Sky for TiddlyWeb.tid | 8 +---- .../tw5.com/tiddlers/features/Features.tid | 2 +- .../gettingstarted/GettingStarted.tid | 4 +-- editions/tw5.com/tiddlers/howtos/Tagging.tid | 32 +++++++++---------- .../mechanisms/EncryptionMechanism.tid | 2 +- .../saving/Saving with Encryption.tid | 2 +- .../Using TiddlyWiki on TiddlyDesktop.tid | 14 -------- .../tocproject/Working with TiddlyWiki.tid | 2 +- .../Introducing TiddlyDesktop Video.tid | 2 +- 13 files changed, 61 insertions(+), 76 deletions(-) create mode 100644 editions/tw5.com/tiddlers/Empty Edition.tid delete mode 100644 editions/tw5.com/tiddlers/saving/Using TiddlyWiki on TiddlyDesktop.tid diff --git a/editions/tw5.com/tiddlers/Creating and editing tiddlers.tid b/editions/tw5.com/tiddlers/Creating and editing tiddlers.tid index 0aa01acd7..cdbf85ec4 100644 --- a/editions/tw5.com/tiddlers/Creating and editing tiddlers.tid +++ b/editions/tw5.com/tiddlers/Creating and editing tiddlers.tid @@ -4,25 +4,25 @@ tags: [[Working with TiddlyWiki]] title: Creating and editing tiddlers type: text/vnd.tiddlywiki -!Creating tiddlers +! Creating tiddlers You create a tiddler either by clicking the {{$:/core/images/new-button}} button in the sidebar, or by clicking on a link to a missing tiddler (links to missing tiddlers will appear in [[blue italic text]]). -!Editing tiddlers +! Editing tiddlers You can edit an existing tiddler by clicking the {{$:/core/images/edit-button}} button at the top right of the tiddler. -!The ~EditTemplate +! The ~EditTemplate Creating new tiddlers and editing existing tiddlers both open up the ~EditTemplate. This is your control panel for modifying the tiddler in different ways. The ~EditTemplate has several areas: *''The title editor'' Use this to edit the title of the tiddler -*''The tag editor'' Use this to add or remove tags to the tiddler. Type a tag name and either select a tag from the dropdown list or finish typing to create a new tag. Then click the 'add' button to add it to the tiddler. Delete tags from a tiddler by clicking the 'x' on the tag label. -*''The text editor'' Use this to add content to the tiddler. You can also use the preview button to preview changes to the tiddler text. +*''The tag editor'' Use this to add or remove tags to the tiddler. Type a tag name and either select a tag from the dropdown list or finish typing to create a new tag. Then click the 'add' button to add it to the tiddler. Delete tags from a tiddler by clicking the 'x' on the tag pill +*''The text editor'' Use this to add content to the tiddler. You can also use the preview button to preview changes to the tiddler text *''The type editor'' Use this when you have a specific type of content that needs to be displayed in a different way, such as an image. See ContentType for a list of possible content types. The default is text/vnd.tiddlywiki) -*''The field editor'' Use this to add fields to the tiddler. For example, you can use a [[list field|ListField]] to display the order of tiddlers tagged with the current tiddler's title in ways that are not alphabetical. +*''The field editor'' Use this to add fields to the tiddler. For example, you can use a [[list field|ListField]] to display the order of tiddlers tagged with the current tiddler's title in ways that are not alphabetical -!Save, cancel or delete +! Save, cancel or delete When you are finished editing, select the desired button at the top of the ~EditTemplate: diff --git a/editions/tw5.com/tiddlers/Empty Edition.tid b/editions/tw5.com/tiddlers/Empty Edition.tid new file mode 100644 index 000000000..4e2b24ca5 --- /dev/null +++ b/editions/tw5.com/tiddlers/Empty Edition.tid @@ -0,0 +1,11 @@ +created: 20140916213421041 +modified: 20140916213828557 +tags: Editions +title: Empty Edition +type: text/vnd.tiddlywiki + +The "empty" edition of TiddlyWiki is a vanilla distribution, with no additional plugins or configuration beyond the core code. + +The empty edition can be downloaded from: + +http://tiddlywiki.com/empty.html diff --git a/editions/tw5.com/tiddlers/definitions/TiddlyDesktop.tid b/editions/tw5.com/tiddlers/definitions/TiddlyDesktop.tid index ce9788e1a..a0bebca23 100644 --- a/editions/tw5.com/tiddlers/definitions/TiddlyDesktop.tid +++ b/editions/tw5.com/tiddlers/definitions/TiddlyDesktop.tid @@ -1,13 +1,23 @@ created: 20140126125259638 modified: 20140916131440645 -tags: Definitions Features +tags: Definitions Features Saving title: TiddlyDesktop type: text/vnd.tiddlywiki -TiddlyDesktop is an app for working with TiddlyWiki files (both TiddlyWikiClassic and TiddlyWiki version 5). It can be installed on Windows, Mac OS X or Linux. +TiddlyDesktop is an app for working with TiddlyWiki files (both TiddlyWikiClassic and TiddlyWiki version 5). It can be installed on Windows, Mac OS X or Linux. It is compatible with TiddlyWiki version 5 and the older TiddlyWikiClassic. + +See the [[Introducing TiddlyDesktop Video]] + +! Instructions + +# Install the latest release of TiddlyDesktop from https://github.com/Jermolene/TiddlyDesktop/releases +# Run TiddlyDesktop +# Use the browse button to open TiddlyWiki files +# Save changes within TiddlyWiki in the usual way + +! Source TiddlyDesktop is based on the OpenSource project [[node-webkit]]. The source is on GitHub: https://github.com/Jermolene/TiddlyDesktop/ -See [[Using TiddlyWiki on TiddlyDesktop]] for instructions. diff --git a/editions/tw5.com/tiddlers/editions/Editions.tid b/editions/tw5.com/tiddlers/editions/Editions.tid index 40610e3f8..e4feab980 100644 --- a/editions/tw5.com/tiddlers/editions/Editions.tid +++ b/editions/tw5.com/tiddlers/editions/Editions.tid @@ -1,28 +1,12 @@ -title: Editions +created: 20140908125500000 +list: [[Empty Edition]] [[TiddlyWiki in the Sky for TiddlyWeb]] +modified: 20140916213954298 tags: TableOfContents -created: 201409081255 -modified: 201409081255 +title: Editions +type: text/vnd.tiddlywiki TiddlyWiki is distributed in several different editions that are tuned for specific purposes. Each one consists of the same TiddlyWiki core components along with the required plugins, documentation and sample content. You can mix and match the components of these editions, to make a unique solution to your particular application. -
- -<$list filter="[tag[Editions]!sort[modified]]"> - -
- -! <$link><$view field="title"/> - -!!! <$text text={{!!url}}/> - -
Posted <$view field="modified" format="relativedate"/>
- -<$transclude/> - -
- - - -
+<> diff --git a/editions/tw5.com/tiddlers/editions/TiddlyWiki in the Sky for TiddlyWeb.tid b/editions/tw5.com/tiddlers/editions/TiddlyWiki in the Sky for TiddlyWeb.tid index 3afc3fe5f..c24f8647a 100644 --- a/editions/tw5.com/tiddlers/editions/TiddlyWiki in the Sky for TiddlyWeb.tid +++ b/editions/tw5.com/tiddlers/editions/TiddlyWiki in the Sky for TiddlyWeb.tid @@ -1,5 +1,5 @@ created: 20131129100250644 -modified: 20140206221253685 +modified: 20140916213415337 tags: [[Hosting your TiddlyWiki on the web]] Editions title: TiddlyWiki in the Sky for TiddlyWeb type: text/vnd.tiddlywiki @@ -11,12 +11,6 @@ TiddlyWiki in the Sky for TiddlyWeb allows content to be synchronised between Ti ** Synchronising from the server is accomplished by polling (currently every 60 seconds) * Throttling so that rapidly changing tiddlers don't overwhelm the server -The implementation is somewhat experimental, and includes these limitations: - -* Only works with tiddlers written in TiddlyWiki version 5 WikiText. Tiddlers in the old syntax will be parsed as TiddlyWikiClassic syntax -* New tiddlers are not saved to the server -* No way to delete tiddlers - To try out TiddlyWiki in the Sky for TiddlyWeb: # If necessary, create an account at http://tiddlyspace.com/ diff --git a/editions/tw5.com/tiddlers/features/Features.tid b/editions/tw5.com/tiddlers/features/Features.tid index 875062eae..24eb6aef6 100644 --- a/editions/tw5.com/tiddlers/features/Features.tid +++ b/editions/tw5.com/tiddlers/features/Features.tid @@ -19,7 +19,7 @@ Further information about specific TiddlyWiki features: * The ability to [[render static HTML snapshots|Generating Static Sites with TiddlyWiki]] that can be used without JavaScript * [[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|Saving with Encryption]] +* Integrated [[AES encryption|Encryption]] * TiddlyWiki isn't just a wiki - you can build custom applications with it like this TaskManagementExample * Full internationalization support, with TiddlyWiki itself available in several languages (see the [[control panel|$:/ControlPanel]]) * Familiar user interface elements like <>, <$button message="tm-modal" param="SampleWizard">wizards and <$button message="tm-notify" param="SampleNotification">notifications diff --git a/editions/tw5.com/tiddlers/gettingstarted/GettingStarted.tid b/editions/tw5.com/tiddlers/gettingstarted/GettingStarted.tid index 05e969478..bc283ac5c 100644 --- a/editions/tw5.com/tiddlers/gettingstarted/GettingStarted.tid +++ b/editions/tw5.com/tiddlers/gettingstarted/GettingStarted.tid @@ -15,7 +15,7 @@ Instructions for getting started using TiddlyWiki on the different platforms and See also: -* [[Saving with Encryption]] explains how to use TiddlyWiki's built-in encryption to protect your content with a password +* [[Encryption]] explains how to use TiddlyWiki's built-in encryption to protect your content with a password * [[Saving on TiddlySpot]], a free service that lets you use TiddlyWiki online -* [[Using TiddlyWiki on TiddlyDesktop]], a custom desktop application for working with TiddlyWiki +* Saving on TiddlyDesktop, a custom desktop application for working with TiddlyWiki * You can also download this full TiddlyWiki including all the documentation: ~http://tiddlywiki.com/index.html diff --git a/editions/tw5.com/tiddlers/howtos/Tagging.tid b/editions/tw5.com/tiddlers/howtos/Tagging.tid index 07866e840..3506be9f5 100644 --- a/editions/tw5.com/tiddlers/howtos/Tagging.tid +++ b/editions/tw5.com/tiddlers/howtos/Tagging.tid @@ -3,30 +3,30 @@ tags: [[Working with TiddlyWiki]] created: 201409040754 modified: 201409040754 -Tagging a tiddler assigns a tiddler to a category of your choosing (see [[Creating, tagging and editing tiddlers]] for instructions on how to tag). For example, tiddlers representing individuals might be tagged ''friend'', ''family'', ''colleague'' etc to indicate the relationship to the author. Multiple tags can be applied to the same tiddler. +Tagging a tiddler assigns a tiddler to a category of your choosing (see [[Creating and editing tiddlers]] for instructions on how to tag). For example, tiddlers representing individuals might be tagged ''friend'', ''family'', ''colleague'' etc to indicate the relationship to the author. Multiple tags can be applied to the same tiddler. Tagging tiddlers gives you numerous additional ways to view, navigate and organise your information: -*The coloured tag pills on a tagged tiddler gives you links to all the other tiddlers with the same tag, as well as to the tiddler representing the tag itself. -*The tagging tab in the TiddlerInfo area (accessed by clicking the {{$:/core/images/info-button}} button) gives you links to all the tiddlers tagged with the title of the current tiddler. -*You can use the tags tab in the 'More' sidebar tab to view all your tags and access your tagged tiddlers. -*You can use ListFilters to create lists of tiddlers based on tags, then display whichever combination of tiddler fields you wish. For example, you can create a list that shows both the title and the text of all tiddlers tagged 'Glossary.' Such lists can be formatted however you wish: for example: bulleted, numbered, or comma-separated. -*System tags can be used to customise the layout of tiddlers and the entire ~TiddlyWiki page. See [[Page and tiddler layout customisation]] for instructions. +* The coloured tag pills on a tagged tiddler gives you links to all the other tiddlers with the same tag, as well as to the tiddler representing the tag itself. +* The tagging tab in the TiddlerInfo area (accessed by clicking the {{$:/core/images/info-button}} button) gives you links to all the tiddlers tagged with the title of the current tiddler. +* You can use the tags tab in the 'More' sidebar tab to view all your tags and access your tagged tiddlers. +* You can use ListFilters to create lists of tiddlers based on tags, then display whichever combination of tiddler fields you wish. For example, you can create a list that shows both the title and the text of all tiddlers tagged 'Glossary.' Such lists can be formatted however you wish: for example: bulleted, numbered, or comma-separated. +* System tags can be used to customise the layout of tiddlers and the entire ~TiddlyWiki page. See [[Page and tiddler layout customisation]] for instructions. There are two more things you can do with tags: -!Assign colours and icons to a tag +! Assign colours and icons to a tag You can use the [[tag manager|$:/TagManager]], found in the 'Tags' tab of the 'More' sidebar tab, to assign background colours and/or icons to a tag. -*Colours can be assigned to a tag either by specifying the CSS colour value in the upper window in the colour column, or choosing a colour from the dropdown colour picker provided. -*Icons can be assigned to a tag by clicking the {{$:/core/images/down-arrow}} button in the icon column and choosing one of the icons listed. +* Colours can be assigned to a tag either by specifying the CSS colour value in the upper window in the colour column, or choosing a colour from the dropdown colour picker provided. +* Icons can be assigned to a tag by clicking the {{$:/core/images/down-arrow}} button in the icon column and choosing one of the icons listed. -!Use list fields to adjust the ordering of tag lists +! Use list fields to adjust the ordering of tag lists -*If you want to create a list of tagged tiddlers with a ListFilter, but want the tiddlers to be listed in a special order rather than the default alphabetical order, you can create a field called 'list' in the tag tiddler, and add the titles of the tiddlers to the field in the order you wish. ~TiddlyWiki will order lists of tagged tiddlers in the following order of priority: -**First, any tiddlers that are listed in the ListField of the tag tiddler are placed into a new list in the same order -**Second, any unplaced tiddlers that have the field ''list-before'' are placed before the tiddler specified in the field -***(if the ''list-before'' field is empty then the unplaced tiddler is placed at the start of the list) -**Third, if any unplaced tiddlers have the field ''list-after'' then they placed immediately after the tiddler specified in the field -**Finally, any remaining unplaced tiddlers are placed at the end of the list +* If you want to create a list of tagged tiddlers with a ListFilter, but want the tiddlers to be listed in a special order rather than the default alphabetical order, you can create a field called 'list' in the tag tiddler, and add the titles of the tiddlers to the field in the order you wish. ~TiddlyWiki will order lists of tagged tiddlers in the following order of priority: +** First, any tiddlers that are listed in the ListField of the tag tiddler are placed into a new list in the same order +** Second, any unplaced tiddlers that have the field ''list-before'' are placed before the tiddler specified in the field +*** (if the ''list-before'' field is empty then the unplaced tiddler is placed at the start of the list) +** Third, if any unplaced tiddlers have the field ''list-after'' then they placed immediately after the tiddler specified in the field +** Finally, any remaining unplaced tiddlers are placed at the end of the list diff --git a/editions/tw5.com/tiddlers/mechanisms/EncryptionMechanism.tid b/editions/tw5.com/tiddlers/mechanisms/EncryptionMechanism.tid index f41eafc14..20decff5f 100644 --- a/editions/tw5.com/tiddlers/mechanisms/EncryptionMechanism.tid +++ b/editions/tw5.com/tiddlers/mechanisms/EncryptionMechanism.tid @@ -6,7 +6,7 @@ type: text/vnd.tiddlywiki TiddlyWiki5 allows the entire content of a TiddlyWiki HTML file to be encrypted with the Stanford JavaScript Crypto Library. Opening an encrypted TiddlyWiki in the browser prompts for a password before decrypting and displaying the content. -For instructions on how to use TiddlyWiki5's encryption features, see [[Saving with Encryption]]. +For instructions on how to use TiddlyWiki5's encryption features, see [[Encryption]]. The EncryptionMechanism is implemented with the following elements: diff --git a/editions/tw5.com/tiddlers/saving/Saving with Encryption.tid b/editions/tw5.com/tiddlers/saving/Saving with Encryption.tid index 7106e0d5c..4a37f8ee6 100644 --- a/editions/tw5.com/tiddlers/saving/Saving with Encryption.tid +++ b/editions/tw5.com/tiddlers/saving/Saving with Encryption.tid @@ -1,7 +1,7 @@ created: 20130825160900000 modified: 20140912140822643 tags: Features [[Working with TiddlyWiki]] -title: Saving with Encryption +title: Encryption type: text/vnd.tiddlywiki When used as a single HTML file, TiddlyWiki5 allows content to be encrypted using the [[Stanford JavaScript Crypto Library]]. diff --git a/editions/tw5.com/tiddlers/saving/Using TiddlyWiki on TiddlyDesktop.tid b/editions/tw5.com/tiddlers/saving/Using TiddlyWiki on TiddlyDesktop.tid deleted file mode 100644 index d70951494..000000000 --- a/editions/tw5.com/tiddlers/saving/Using TiddlyWiki on TiddlyDesktop.tid +++ /dev/null @@ -1,14 +0,0 @@ -created: 20140126125532723 -modified: 20140912140912084 -tags: Saving Features -title: Using TiddlyWiki on TiddlyDesktop -type: text/vnd.tiddlywiki - -TiddlyDesktop is an app for Windows, Mac OS X and Linux that lets you work with TiddlyWiki files. - -# Install the latest release of TiddlyDesktop from https://github.com/Jermolene/TiddlyDesktop/releases -# Run TiddlyDesktop -# Use the browse button to open TiddlyWiki files -# Save changes within TiddlyWiki in the usual way - -See the [[Introducing TiddlyDesktop Video]] diff --git a/editions/tw5.com/tiddlers/tocproject/Working with TiddlyWiki.tid b/editions/tw5.com/tiddlers/tocproject/Working with TiddlyWiki.tid index 3123024cd..b5b4278fa 100644 --- a/editions/tw5.com/tiddlers/tocproject/Working with TiddlyWiki.tid +++ b/editions/tw5.com/tiddlers/tocproject/Working with TiddlyWiki.tid @@ -1,5 +1,5 @@ created: 20140904101100000 -list: [[The First Rule of Using TiddlyWiki]] GettingStarted [[Getting Started Video]] Upgrading [[Navigating between open tiddlers]] [[Using links to navigate between tiddlers]] [[Searching in TiddlyWiki]] [[Creating and editing tiddlers]] [[Formatting text in TiddlyWiki]] [[Structuring TiddlyWiki]] Tagging [[Images in TiddlyWiki]] ImportTiddlers [[Copying tiddlers between TiddlyWiki files]] [[Introduction to Filters]] KeyboardShortcuts Saving [[Saving with Encryption]] [[Sharing a TiddlyWiki on Dropbox]] [[Sharing your tiddlers with others]] [[Philosophy of Tiddlers]] +list: [[The First Rule of Using TiddlyWiki]] GettingStarted [[Getting Started Video]] Upgrading [[Navigating between open tiddlers]] [[Using links to navigate between tiddlers]] [[Searching in TiddlyWiki]] [[Creating and editing tiddlers]] [[Formatting text in TiddlyWiki]] [[Structuring TiddlyWiki]] Tagging [[Images in TiddlyWiki]] ImportTiddlers [[Copying tiddlers between TiddlyWiki files]] [[Introduction to Filters]] KeyboardShortcuts Saving [[Encryption]] [[Sharing a TiddlyWiki on Dropbox]] [[Sharing your tiddlers with others]] [[Philosophy of Tiddlers]] modified: 20140916132815529 tags: TableOfContents title: Working with TiddlyWiki diff --git a/editions/tw5.com/tiddlers/videos/Introducing TiddlyDesktop Video.tid b/editions/tw5.com/tiddlers/videos/Introducing TiddlyDesktop Video.tid index d3569c00e..3f7c5ea25 100644 --- a/editions/tw5.com/tiddlers/videos/Introducing TiddlyDesktop Video.tid +++ b/editions/tw5.com/tiddlers/videos/Introducing TiddlyDesktop Video.tid @@ -1,6 +1,6 @@ created: 20140126124827076 modified: 20140912150423506 -tags: Videos [[Using TiddlyWiki on TiddlyDesktop]] +tags: Videos TiddlyDesktop title: Introducing TiddlyDesktop Video type: text/vnd.tiddlywiki