mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-11-27 12:07:19 +00:00
More docs updates
This commit is contained in:
Jeremy Ruston
parent
e22168abcd
commit
bf7b0629a3
@ -1,12 +1,16 @@
|
||||
created: 201308251537
|
||||
creator: JeremyRuston
|
||||
modified: 201308251539
|
||||
modified: 201308252143
|
||||
modifier: JeremyRuston
|
||||
tags: introduction dev
|
||||
title: DeveloperDocs
|
||||
|
||||
This is the developer documentation hub for TiddlyWiki.
|
||||
|
||||
! Overview
|
||||
|
||||
TiddlyWikiArchitecture
|
||||
|
||||
! Developer Cookbooks
|
||||
|
||||
<$list filter="[tag[dev]tag[howto]sort[title]]" type="ul"/>
|
||||
@ -17,8 +21,12 @@ This is the developer documentation hub for TiddlyWiki.
|
||||
|
||||
<$list filter="[tag[mechanism]sort[title]]" type="ul"/>
|
||||
|
||||
! Deserializers
|
||||
! Module types
|
||||
!! SyncAdaptorModules
|
||||
|
||||
See SyncAdaptorModules.
|
||||
|
||||
!! DeserializerModules
|
||||
|
||||
Deserializers are modules that read tiddlers from different text formats:
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
created: 201308221728
|
||||
creator: JeremyRuston
|
||||
modified: 201308231953
|
||||
modified: 201308252125
|
||||
modifier: JeremyRuston
|
||||
tags: introduction
|
||||
title: Features
|
||||
@ -19,5 +19,6 @@ title: Features
|
||||
** 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
|
||||
* Last but not least, TiddlyWiki is a rare example of a practical [[quine|Quine]]
|
||||
|
||||
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.
|
||||
|
||||
@ -1,5 +1,9 @@
|
||||
created: 201308252135
|
||||
creator: JeremyRuston
|
||||
modified: 201308252135
|
||||
modifier: JeremyRuston
|
||||
tags: definitions
|
||||
title: TiddlySpot
|
||||
tags:
|
||||
|
||||
TiddlySpot is a free hosting service for TiddlyWiki documents from Simon and Daniel Baird. It has been in operation almost as long as TiddlyWiki itself.
|
||||
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
created: 201308220806
|
||||
creator: JeremyRuston
|
||||
modified: 201308220812
|
||||
modified: 201308252130
|
||||
modifier: JeremyRuston
|
||||
tags:
|
||||
tags: concepts
|
||||
title: SystemTags
|
||||
|
||||
System tags are used to give special behaviour to tiddlers:
|
||||
|
||||
@ -1,4 +1,8 @@
|
||||
modified: 201308091623
|
||||
created: 201308252133
|
||||
creator: JeremyRuston
|
||||
modified: 201308252133
|
||||
modifier: JeremyRuston
|
||||
tags: concepts
|
||||
title: TiddlerFields
|
||||
|
||||
TiddlerFields are name:value pairs that make up a [[tiddler|Tiddlers]]. The standard fields are:
|
||||
|
||||
@ -1,8 +1,11 @@
|
||||
created: 201308252135
|
||||
creator: JeremyRuston
|
||||
modified: 201308252135
|
||||
modifier: JeremyRuston
|
||||
tags: concepts
|
||||
title: Tiddlers
|
||||
modified: 201306010741
|
||||
|
||||
Tiddlers are the smallest unit of information in TiddlyWiki.
|
||||
Tiddlers are the smallest unit of information in TiddlyWiki. They can be structured with [[links|TiddlerLinks]] and tags.
|
||||
|
||||
Internally, tiddlers are an immutable 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 listed below:
|
||||
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
title: TiddlyWiki5
|
||||
created: 201308252136
|
||||
creator: JeremyRuston
|
||||
modified: 201308252136
|
||||
modifier: JeremyRuston
|
||||
modified: 201302051920
|
||||
tags: concepts
|
||||
title: TiddlyWiki5
|
||||
|
||||
TiddlyWiki5 is a reboot of TiddlyWiki for the next 25 years. It is a complete interactive wiki in JavaScript that can be run in the browser or on the server under [[node.js]].
|
||||
|
||||
@ -1,5 +1,8 @@
|
||||
modified: 201304161845
|
||||
tags:
|
||||
created: 201308252142
|
||||
creator: JeremyRuston
|
||||
modified: 201308252142
|
||||
modifier: JeremyRuston
|
||||
tags: dev
|
||||
title: TiddlyWikiFolders
|
||||
|
||||
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.
|
||||
|
||||
@ -1,7 +1,9 @@
|
||||
modified: 201304291301
|
||||
title: TiddlyWiki5 Node Edition
|
||||
created: 201308252145
|
||||
creator: JeremyRuston
|
||||
modified: 201308252145
|
||||
modifier: JeremyRuston
|
||||
tags: edition
|
||||
title: TiddlyWiki5 Node Edition
|
||||
|
||||
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:
|
||||
|
||||
@ -57,6 +59,12 @@ The files output by `bld.sh` are:
|
||||
|
||||
This batch file starts TiddlyWiki5 running as an HTTP server with the content from the `clientserver` edition. By default, the script serves on port 8080.
|
||||
|
||||
```
|
||||
./server.sh UserName
|
||||
```
|
||||
|
||||
The single parameter to the script is the username to use 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).
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
created: 201308252147
|
||||
creator: JeremyRuston
|
||||
modified: 201308252147
|
||||
modifier: JeremyRuston
|
||||
tags: dev moduletypes
|
||||
title: WikiRuleModules
|
||||
|
||||
WikiRuleModules cover the module types 'wikirunrule', 'wikiblockrule' and `wikipragmarule`. Modules of these types encapsulate the logic of individual parsing rules used by the WikiParser engine. For example, there is a `wikirunrule` module that identifies references to HTML entities by matching the pattern `&<chars>;`.
|
||||
WikiRuleModules cover the module types `wikirunrule`, `wikiblockrule` and `wikipragmarule`. Modules of these types encapsulate the logic of individual parsing rules used by the WikiParser engine. For example, there is a `wikirunrule` module that identifies references to HTML entities by matching the pattern `&<chars>;`.
|
||||
|
||||
Pragma rules are applied at the start of a block of text, and cover definitions and declarations that affect the parsing of the rest of the text. Block rules are only applied at the beginning of a block of wikitext, while run rules can appear anywhere. The only current example of a pragma rule is for macro definitions.
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
created: 201308232038
|
||||
creator: JeremyRuston
|
||||
modified: 201308232040
|
||||
modified: 201308252127
|
||||
modifier: JeremyRuston
|
||||
tags: planning
|
||||
title: RoadMap
|
||||
@ -15,7 +15,7 @@ The one significant piece of work required before TiddlyWiki5 can move out of al
|
||||
|
||||
During the beta TiddlyWiki5 will be practical for cautious everyday use but as we perfect the product there will occasionally be situations where we have to make changes that are not backwards compatible. These occasions will be clearly marked in the release notes.
|
||||
|
||||
The following additional features are under consideration for implementation during the beta:
|
||||
The following additional features are planned or under consideration for implementation during the beta:
|
||||
|
||||
* Warning when attempting to close window without saving
|
||||
* Use browser local storage to preserve changes in case browser crashes before saving/sync
|
||||
|
||||
@ -1,5 +1,11 @@
|
||||
created: 201308252133
|
||||
creator: JeremyRuston
|
||||
modified: 201308252133
|
||||
modifier: JeremyRuston
|
||||
title: TaskManagementExample
|
||||
|
||||
TiddlyWiki5 can be used as a simple task management system without further customisation. The idea is that tasks be tagged `task`, with those that are completed also tagged `done`. In this way it is straightforward to generate task lists.
|
||||
|
||||
! Outstanding tasks
|
||||
|
||||
<$list filter="[!has[draft.of]tag[task]!tag[done]sort[created]]">
|
||||
|
||||
@ -1,4 +1,8 @@
|
||||
color: #8d9ac3
|
||||
modified: 201306131058
|
||||
created: 201308252132
|
||||
creator: JeremyRuston
|
||||
modified: 201308252132
|
||||
modifier: JeremyRuston
|
||||
title: task
|
||||
|
||||
Sample tasks for the TaskManagementExample.
|
||||
@ -1,6 +1,9 @@
|
||||
created: 201308252131
|
||||
creator: JeremyRuston
|
||||
modified: 201308252131
|
||||
modifier: JeremyRuston
|
||||
tags: talkytalky
|
||||
title: TalkyTalky
|
||||
modified: 201305081626
|
||||
|
||||
@@text-align:center;
|
||||
! http://five.tiddlywiki.com/
|
||||
@ -40,7 +43,7 @@ Store your tiddlers in a single HTML file along with the JS
|
||||
# Start adding tasks
|
||||
# Save using TiddlyFox, refresh to show changes
|
||||
# Drag in the task tiddlers
|
||||
# Drag in TaskManagementDemo, show source
|
||||
# Drag in TaskManagementExample, show source
|
||||
|
||||
!!! node.js Edition
|
||||
|
||||
@ -50,18 +53,11 @@ Store your tiddlers in separate files in a chain of linked directories.
|
||||
# Open http://five.tiddlywiki.com/static.html
|
||||
#* Click links to show individual tiddlers
|
||||
# Open http://five.tiddlywiki.com/test.html
|
||||
# Start `./serve.sh`
|
||||
# Start `./serve.sh UserName`
|
||||
# Open http://0.0.0.0:8080/
|
||||
# Open network console
|
||||
# Note same sync code on client and server
|
||||
|
||||
!!! Other Editions
|
||||
|
||||
* Dropbox et al
|
||||
* TiddlySpot
|
||||
* TiddlyWeb
|
||||
* TiddlyEdit for iOS
|
||||
|
||||
!!! Wrap-up
|
||||
|
||||
# This is the start of a 25-year journey to perfect a tool that anyone can user forever
|
||||
|
||||
Loading…
Reference in New Issue
Block a user