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

Starting some serious doc updates

Browse Source
This commit is contained in:
Jeremy Ruston 2013-08-23 19:42:48 +01:00
parent 58fbed6fbc
commit 6c5239603c
11 changed files with 106 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
editions/clientserver/tiddlers/system/DefaultTiddlers.tid
View File

@ -1,8 +1,11 @@
created: 201308231804
creator: JeremyRuston
modified: 201308231806
modifier: JeremyRuston
title: $:/DefaultTiddlers
[[TiddlyWiki5 Personal Client Server Edition]]
HelloThere
Features
[[TiddlyWiki5 Editions]]
Demos
Improvements
Docs

22
editions/tw5.com/tiddlers/Features.tid Normal file
View File

@ -0,0 +1,22 @@
created: 201308221728
creator: JeremyRuston
modified: 201308231840
modifier: JeremyRuston
tags: docs introduction
title: Features
* [[Bitmap images|Motovun Jack.jpg]] and [[SVG images|Motovun Jack.svg]] 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]]
* TiddlyWiki isn't just a wiki - you can build custom applications with it like this TaskManagementExample
* Familiar user interface elements like <$button message="tw-modal" param="SampleWizard" class="btn btn-inverse">wizards</$button> and <$button message="tw-notify" param="SampleNotification" class="btn btn-inverse">notifications</$button>
* Easily [[import|ImportTiddlers]] content via drag and drop, copy and paste, or browsing for local files
* TiddlyWiki is [[surprisingly scalable|Scalability]] to many thousands of tiddlers and megabytes of content
* Explore the [[D3.js visualisation plugin|http://five.tiddlywiki.com/d3demo.html]]
* Many internal improvements:
** TiddlyWiki can now be run under [[node.js]] as well as in the browser, allowing it to be used as a personal web server
** An elegant [[microkernel architecture|PluginMechanism]], that allows infinite customisation by replacing and augmenting the core modules
** TiddlyWiki5 can directly build both itself and previous (2.x.x) versions of TiddlyWiki from their constituent separate files, without needing external tools
** Run the TiddlyWiki5 [[test suite|TestingMechanism]] from http://five.tiddlywiki.com/test.html
The deep internal changes mean that TiddlyWiki5 is not compatible with previous versions, using different plugins, themes and so on. Content prepared for previous versions of TiddlyWiki will need massaging to work properly in TiddlyWiki5.

10
editions/tw5.com/tiddlers/HelloThere.tid
View File

@ -1,4 +1,6 @@
modified: 201306051312
created: 201308221702
creator: JeremyRuston
modified: 201308231811
modifier: JeremyRuston
tags: introduction
title: HelloThere
@ -6,12 +8,10 @@ type: text/vnd.tiddlywiki
Welcome to TiddlyWiki5, a reboot of TiddlyWiki, the non-linear personal web notebook [[first released in 2004|History]]. It is a complete interactive wiki in JavaScript that can be run from a single HTML file in the browser or as a powerful [[node.js application|node.js]].
TiddlyWiki is designed to fit around your brain, providing a better way of managing the overflow than traditional documents and emails. The fundamental idea is that information is more useful and reusable if we cut it up into the smallest semantically meaningful chunks -- [[tiddlers|Tiddlers]] -- and give them titles so that they can be structured with links, tags and macros. TiddlyWiki aims to provide a fluid interface for working with tiddlers, allowing them to be aggregated and composed into longer narratives.
TiddlyWiki5 has many [[improvements|Improvements]] over the original. It is currently in alpha, meaning it is working but incomplete. It is a great time to get involved and support its [[future development|RoadMap]]. You can:
TiddlyWiki5 is currently in alpha, meaning it is working but incomplete. It is a great time to get involved and support its [[future development|RoadMap]]:
* Explore its features online at http://five.tiddlywiki.com/
* Get involved in the [[development on GitHub|https://github.com/Jermolene/TiddlyWiki5]]
* Join the discussions on [[the TiddlyWikiDev Google Group|http://groups.google.com/group/TiddlyWikiDev]]
* Get involved in the [[development on GitHub|https://github.com/Jermolene/TiddlyWiki5]]
* Follow [[@TiddlyWiki on Twitter|http://twitter.com/#!/TiddlyWiki]] for the latest news
* Learn how to [[help the TiddlyWiki project and community|HelpingTiddlyWiki]]

8
editions/tw5.com/tiddlers/Scalability.tid Normal file
View File

@ -0,0 +1,8 @@
created: 201308221734
creator: JeremyRuston
modified: 201308221734
modifier: JeremyRuston
tags: docs features
title: Scalability
You might expect that TiddlyWiki's architecture as a SinglePageApplication would make it unsuitable for large amounts of data. In fact, TiddlyWiki users regularly work with files that are 20 or 30 megabytes without problems - and successful experiments have been done up into the gigabytes.

12
editions/tw5.com/tiddlers/TiddlyWiki Hangouts.tid Normal file
View File

@ -0,0 +1,12 @@
created: 201308230917
creator: JeremyRuston
modified: 201308231750
modifier: JeremyRuston
tags: docs community
title: TiddlyWiki Hangouts
The TiddlyWiki community holds regular Google Hangouts. They are announced in the [[TiddlyWiki Google group|https://groups.google.com/d/forum/tiddlywiki]] and on the [[TiddlyWiki Twitter account|https://twitter.com/TiddlyWiki]].
Past Hangouts are archived in this YouTube playlist:
http://www.youtube.com/playlist?list=PLVT_2PPd-1p34gGCQ5qpwC8QdykxVAI3u

17
editions/tw5.com/tiddlers/concepts/SystemTags.tid Normal file
View File

@ -0,0 +1,17 @@
created: 201308220806
creator: JeremyRuston
modified: 201308220812
modifier: JeremyRuston
tags: docs
title: SystemTags
System tags are used to give special behaviour to tiddlers:
* [[$:/tags/stylesheet]]: indicates that a tiddler should be applied as a CSS stylesheet
* [[$:/tags/ViewTemplate]]: indicates that a tiddler is a template that should be included in the ViewTemplate
! System tags in use
These are the system tags in use in this wiki:
{{{ [is[shadow]tags[]prefix[$:/]] [!is[shadow]tags[]prefix[$:/]] +[sort[title]] }}}

12
editions/tw5.com/tiddlers/concepts/TiddlyWiki.tid
View File

@ -1,12 +1,12 @@
title: TiddlyWiki
created: 201308221707
creator: JeremyRuston
modified: 201308221707
modifier: JeremyRuston
modified: 20120211110622
tags: docs concepts
title: TiddlyWiki
TiddlyWiki is a rich, interactive interface for manipulating complex data with structure that doesn't easily fit into conventional tools like spreadsheets or wordprocessors.
TiddlyWiki is a rich, interactive tool for manipulating complex data with structure that doesn't easily fit into conventional tools like spreadsheets or wordprocessors.
TiddlyWiki is based on the idea of making information more useful by modelling it in the smallest meaningful semantic units, referred to as [[Tiddlers]]. Structure comes from links, tags, and sequences of tiddlers called stories. Tiddlers use a WikiText notation that concisely represents a wide range of text formatting and hypertext features.
TiddlyWiki is designed to fit around your brain, helping you deal with the things that won't fit. The fundamental idea is that information is more useful and reusable if we cut it up into the smallest semantically meaningful chunks -- [[tiddlers|Tiddlers]] -- and give them titles so that they can be structured with links, tags, lists and macros. Tiddlers use a WikiText notation that concisely represents a wide range of text formatting and hypertext features. TiddlyWiki aims to provide a fluid interface for working with tiddlers, allowing them to be aggregated and composed into longer narratives.
People [[love using|Raves]] TiddlyWiki. Because it can be used without any complicated server infrastructure, and because it is [[open source|OpenSource]], it has bought unprecedented freedom to people to keep their precious information under their own control. TiddlyWiki was originally created by JeremyRuston and is now a thriving [[open source|OpenSource]] project with a busy [[Community]] of independent developers.
See TiddlyWikiArchitecture and [[Introduction]].

13
editions/tw5.com/tiddlers/definitions/SingleFileApplication.tid Normal file
View File

@ -0,0 +1,13 @@
created: 201308221740
creator: JeremyRuston
modified: 201308231751
modifier: JeremyRuston
tags: definitions
title: SingleFileApplication
A SingleFileApplication is a web application where all of the assets are delivered in a single static file.
Every SingleFileApplication must also by definition be a SinglePageApplication, but the converse is not true.

10
editions/tw5.com/tiddlers/definitions/SinglePageApplication.tid Normal file
View File

@ -0,0 +1,10 @@
created: 201308221739
creator: JeremyRuston
modified: 201308231751
modifier: JeremyRuston
tags: definitions
title: SinglePageApplication
As defined by Wikipedia, a SinglePageApplication is a web application that presents itself as a single HTML document that dynamically loads additional content as the user browses the site. Frequently, single page applications are carefully designed to hide their nature, appearing and functioning as an ordinary static website by respecting the address bar and the back/forward navigation controls.
Unusually, TiddlyWiki is also a SingleFileApplication.

23
editions/tw5.com/tiddlers/howtos/How_to_use_TiddlyWiki5_as_a_standalone_HTML_file.tid
View File

@ -1,6 +1,9 @@
created: 201308220803
creator: JeremyRuston
modified: 201308220803
modifier: JeremyRuston
tags: docs howto
title: How to use TiddlyWiki5 as a standalone HTML file
modified: 201304050948
! On desktop browsers
@ -8,22 +11,10 @@ modified: 201304050948
#* http://five.tiddlywiki.com/empty
# Open the file in your browser
# Make some changes to it. For example:
#* Create new tiddlers by clicking the `New` button in the left sidebar
#* Edit existing tiddlers by clicking the `Edit` button at their upper right
# Save your changes by clicking the `Save` button in the left sidebar. What happens next depends on your browser:
#* Create new tiddlers by clicking the new tiddler "+" icon in the sidebar
#* Edit existing tiddlers by clicking the edit tiddler "pencil" icon at their upper right
# Save your changes by clicking the "download" icon in the sidebar. What happens next depends on your browser:
## Newer browsers will ask for confirmation and then begin downloading your newly modified TiddlyWiki file, placing it in the default `Downloads` directory.
##* See GoogleChromeTips for some suggestions to streamline this process
## For older browsers, TiddlyWiki displays a dialogue including a link that you need to right-click and save
! On mobile browsers
# Visit http://five.tiddlywiki.com/empty in your browser
# Make some changes. For example:
#* Create new tiddlers by clicking the `New` button in the left sidebar
#* Edit existing tiddlers by clicking the `Edit` button at their upper right
# Save your changes by clicking the `Save` button in the left sidebar
# TiddlyWiki displays a dialogue including a download link.
## If your browser allows, add the link as a bookmark
## Otherwise, open the link to open the page in a new browser tab, and then bookmark that page
To re-open your file, simply open the bookmark.

2
editions/tw5.com/tiddlers/system/DefaultTiddlers.tid
View File

@ -1,7 +1,7 @@
title: $:/DefaultTiddlers
HelloThere
Features
[[TiddlyWiki5 Editions]]
Demos
Improvements
Docs