mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-23 10:07:19 +00:00
Code Issues Releases Wiki Activity

Docs updates

Browse Source
This commit is contained in:
Jeremy Ruston 2012-06-22 12:25:10 +01:00
parent 14e433a11d
commit 5819c36d90
7 changed files with 47 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
readme.md
View File

File diff suppressed because one or more lines are too long

6
tw5.com/tiddlers/AllTiddlers.tid Normal file
View File

@ -0,0 +1,6 @@
title: AllTiddlers
tags: navigation
Current tiddlers:
<<list all>>

12
tw5.com/tiddlers/HelloThere.tid
View File

@ -3,6 +3,14 @@ modifier: JeremyRuston
tags: introduction greetings
type: text/x-tiddlywiki
Welcome to TiddlyWiki5, a reboot of TiddlyWiki, the venerable, reusable non-linear personal web notebook first released in 2004. It is a complete interactive wiki that can run from a single HTML file in the browser or as a powerful [[node.js application|What is node.js?]].
Welcome to TiddlyWiki5, a reboot of TiddlyWiki, the venerable, reusable non-linear personal web notebook first released in 2004. It is a complete interactive wiki that can run from a single HTML file in the browser or as a powerful [[node.js application|node.js]].
TiddlyWiki offers a radically new way of managing your data compared to traditional documents. The fundamental idea is that information is more useful and reusable if we cut up into the [[smallest semantically meaningful chunks|Tiddlers]]. TiddlyWiki aims to provide a fluid interface for working with tiddlers, allowing them to be aggregated and composed into longer narratives.
TiddlyWiki5 is at an incomplete early alpha stage, and is not yet ready for general use. You can:
* Explore its features online at http://alpha.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]]
* Follow [[@TiddlyWiki on Twitter|http://twitter.com/#!/TiddlyWiki]] for the latest news
TiddlyWiki5 is currently at version <<version>> and is under active development, which is to say that it is useful but incomplete. You can try out the online prototype at http://alpha.tiddlywiki.com/, [[try out the command line incarnation|TryingOutTiddlyWiki]], get involved in the [[development on GitHub|https://github.com/Jermolene/TiddlyWiki5]] or join the discussions on [[the TiddlyWikiDev Google Group|http://groups.google.com/group/TiddlyWikiDev]].

10
tw5.com/tiddlers/Improvements.tid
View File

@ -1,12 +1,16 @@
title: Improvements
modifier: JeremyRuston
tags: docs introduction
Some of the features that have been improved in TiddlyWiki5:
TiddlyWiki5 is a complete rewrite of the original TiddlyWiki, incorporating many of the improvements that I've wanted to make over the years. It is now based on an elegant [[microkernel architecture|PluginMechanism]], that allows infinite customisation by replacing and augmenting the core modules.
For end users, the important improvements include:
* TiddlyWiki can now be run under [[node.js|http://nodejs.org]] as well as in the browser
* TiddlyWiki is structured as a 600-line boot kernel, with everything else implemented as plugins
* Improved WikiText, with much better generation of HTML, including proper `<p>` tags
* TiddlyWiki can now be run under [[node.js]] as well as in the browser, allowing it to be used as a personal web server
* Tiddlers containing images are now supported just like WikiText tiddlers, including integrated editing of bitmap and SVG images
* Uses standard Twitter Bootstrap CSS (thus enabling the use of Boostrap themes such as http://bootswatch.com)
* Syntax highlighting for JavaScript and JSON tiddlers
* TiddlyWiki5 can directly build both itself and previous (2.6.x) versions of TiddlyWiki from their constituent separate files, without needing external tools
The internal changes mean that TiddlyWiki5 is not compatible with previous versions, using different plugins, themes and so on. The changes to the WikiText have been carefully developed to try to maximise backwards compatibility but content prepared for previous versions of TiddlyWiki will need massaging to work properly in TiddlyWiki5.

50
tw5.com/tiddlers/Introduction.tid
View File

@ -1,45 +1,13 @@
title: Introduction
tags: introduction
TiddlyWiki5 gains new capabilities through a [[completely rebuilt architecture|TiddlyWikiArchitecture]] using the latest features of HTML5 and node.js. It runs natively under node.js, and can also use its own components to construct a version of itself that works entirely within the browser, just as TiddlyWiki has always done.
Here are a few features of TiddlyWiki that you can explore:
If you're running Google Chrome Canary you can modify this wiki, and then download a copy by clicking this button:
<<download filename:"TiddlyWiki.html" label:"Save Changes">>
You can download a static copy of the tiddlers that are currently displayed in this wiki by clicking this button: <<download title:"$:/core/static.template.html" filename:"Story.html" label:"Static Wiki">>
<div class="alert alert-error">
Try out the prototype touch features:
* The zooming chooser appears by swiping into the left edge of the screen (or hover the mouse over the extreme left edge of the browser window)
* The zooming navigator appears by swiping in from the right edge of the screen (not accessible by mouse)
</div>
Learning more about TiddlyWiki5:
* WaysToUseTiddlyWiki discusses the various configurations in which TiddlyWiki5 can be used
* Some very rough UserInterfaceSketches showing where it is heading
Some useful tiddlers for feature testing:
* HelloThere
* TestingNewWikiText shows off the embryonic new wiki text engine
* SampleJsonTiddler showing how JSON tiddlers are handled
* SampleJavaScriptTiddler and SampleJavaScriptTiddlerWithError showing how JavaScript code is displayed
* VideoTests showing how different online video formats can be embedded
* SliderTests showing how sliders work
* TypedBlockTests showing how embedded typed text blocks work
* ShadowTiddlers, including ViewTemplate, EditTemplate and PageTemplate
Technical documentation includes:
* [[Testing]] regimen
* Details of the CommandLineInterface
* Overview of TiddlyWikiArchitecture
** MacroInternals
* Information about TiddlerFiles and RecipeFiles
* A discussion of potential NewWikiTextFeatures
All tiddlers:
<<list all>>
* Try editting some tiddlers and trying out the new WikiText. Your changes will not be visible to other users
* If you're running [[Google Chrome Canary|https://tools.google.com/dlpage/chromesxs]] you can:
** Modify this wiki, and then download a copy by clicking this button: <<download filename:"TiddlyWiki.html" label:"Save Changes">>
** Download a static copy of the tiddlers that are currently displayed in this wiki by clicking this button: <<download title:"$:/core/static.template.html" filename:"Story.html" label:"Static Wiki">>
* If you're running on a touch browser like Mobile Safari on the iPad or iPhone:
** The zooming chooser appears by swiping into the left edge of the screen. (It's currently broken but you get the idea)
** The zooming navigator appears by swiping in from the right edge of the screen. (It currently only works in the 'Classic' storyview)
* Browse the list of AllTiddlers or the ShadowTiddlers

6
tw5.com/tiddlers/definitions/Quine.tid Normal file
View File

@ -0,0 +1,6 @@
title: Quine
tags: definitions
Wikipedia [[defines a Quine|http://en.wikipedia.org/wiki/Quine_(computing)]] as //a computer program which takes no input and produces a copy of its own source code as its only output//.
TiddlyWiki is an unusual example of a practical quine: it is this ability to produce a copy of its own source code that lies at the heart of TiddlyWiki's ability to independently save changes to itself.

8
tw5.com/tiddlers/definitions/node.js.tid Normal file
View File

@ -0,0 +1,8 @@
title: node.js
tags: definitions
[[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.
For TiddlyWiki, [[node.js]] means that we can have a single code base that can run in the browser or on the server, giving great flexibility in how it is used.
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.