mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-11-23 18:17:20 +00:00
Docs update
This commit is contained in:
parent
e579630249
commit
094323c7a7
@ -1,9 +1,10 @@
|
|||||||
title: HelloThere
|
title: HelloThere
|
||||||
modifier: JeremyRuston
|
modifier: JeremyRuston
|
||||||
|
|
||||||
Welcome to TiddlyWiki5, an interactive wiki written in JavaScript to run in the browser or under node.js. It is a reboot of TiddlyWiki (http://www.tiddlywiki.com/), the now venerable, reusable non-linear personal web notebook first released in 2004.
|
<<view title link>>
|
||||||
|
|
||||||
|
Welcome to TiddlyWiki5, a reboot of 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 or as a powerful `node.js` application.
|
||||||
|
|
||||||
<<slider name "Motovun Jack.jpg" "TiddlyWiki Kitten" "See the kitten">>
|
|
||||||
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 stories (sequences of tiddlers). Tiddlers use a wikitext notation that concisely represents a wide range of text formatting and hypertext features.
|
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 stories (sequences of tiddlers). Tiddlers use a wikitext notation that concisely represents a wide range of text formatting and hypertext features.
|
||||||
|
|
||||||
TiddlyWiki has earned an enduring place as a tool that people [[love using|Raves]] for its rich, interactive interface to [[manipulate complex data|TiddlyWikiConcepts]] with structure that doesn't easily fit into conventional tools like spreadsheets or wordprocessors. Because people can use it without needing any complicated server infrastructure, and because it is [[open source|OpenSourceLicense]], 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|OpenSourceLicense]] project with a busy [[Community]] of independent developers.
|
TiddlyWiki has earned an enduring place as a tool that people [[love using|Raves]] for its rich, interactive interface to [[manipulate complex data|TiddlyWikiConcepts]] with structure that doesn't easily fit into conventional tools like spreadsheets or wordprocessors. Because people can use it without needing any complicated server infrastructure, and because it is [[open source|OpenSourceLicense]], 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|OpenSourceLicense]] project with a busy [[Community]] of independent developers.
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
title: Introduction
|
title: Introduction
|
||||||
|
|
||||||
<<tiddler [[Motovun Jack.jpg]]>>
|
<<slider name "Motovun Jack.jpg" "TiddlyWiki Kitten" "See the kitten">>
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
|
@ -6,6 +6,8 @@ title: ReadMe
|
|||||||
<<tiddler CommandLineInterface>>
|
<<tiddler CommandLineInterface>>
|
||||||
!Testing
|
!Testing
|
||||||
<<tiddler Testing>>
|
<<tiddler Testing>>
|
||||||
|
!Architecture
|
||||||
|
<<tiddler TiddlyWikiArchitecture>>
|
||||||
!Planned WikiText Features
|
!Planned WikiText Features
|
||||||
<<tiddler NewWikiTextFeatures>>
|
<<tiddler NewWikiTextFeatures>>
|
||||||
|
|
||||||
|
@ -13,7 +13,7 @@ Tiddlers are a dictionary of name:value pairs called fields.
|
|||||||
|
|
||||||
The only field that is required is the {{{title}}} field, but useful tiddlers also have a {{{text}}} field, and some or all of the standard fields {{{modified}}}, {{{modifier}}}, {{{created}}}, {{{creator}}}, {{{tags}}} and {{{type}}}.
|
The only field that is required is the {{{title}}} field, but useful tiddlers also have a {{{text}}} field, and some or all of the standard fields {{{modified}}}, {{{modifier}}}, {{{created}}}, {{{creator}}}, {{{tags}}} and {{{type}}}.
|
||||||
|
|
||||||
Values can be a string, an array of strings, or a JavaScript {{{Date}}} object. Hardcoded in the system is the knowledge that the `tags` field is a string array, and that the `modified` and `created` fields are dates. All other fields are strings.
|
Hardcoded in the system is the knowledge that the `tags` field is a string array, and that the `modified` and `created` fields are JavaScript `Date` objects. All other fields are strings.
|
||||||
|
|
||||||
The {{{type}}} field identifies the representation of the tiddler text with a MIME type.
|
The {{{type}}} field identifies the representation of the tiddler text with a MIME type.
|
||||||
|
|
||||||
@ -29,7 +29,7 @@ Each WikiStore is connected to another shadow store that is used to provide defa
|
|||||||
|
|
||||||
Clients can register event handlers with the WikiStore object. Event handlers can be registered to be triggered for modifications to any tiddler in the store, or with a filter to only be invoked when a particular tiddler or set of tiddlers changes.
|
Clients can register event handlers with the WikiStore object. Event handlers can be registered to be triggered for modifications to any tiddler in the store, or with a filter to only be invoked when a particular tiddler or set of tiddlers changes.
|
||||||
|
|
||||||
Whenever a change is made to a tiddler, the wikistore registers a `nexttick` handler (if it hasn't already done so). The `nexttick handler` looks back at all the tiddler changes, and dispatches matching event handlers.
|
Whenever a change is made to a tiddler, the wikistore registers a `nexttick` handler (if it hasn't already done so). The `nexttick` handler looks back at all the tiddler changes, and dispatches any matching event handlers.
|
||||||
|
|
||||||
!! Parsing
|
!! Parsing
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user