1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-12-24 00:50:28 +00:00

Docs updates

This commit is contained in:
Jeremy Ruston 2013-01-16 13:44:09 +00:00
parent 84b633acd3
commit 83b99bc917
13 changed files with 30 additions and 54 deletions

View File

@ -27,6 +27,7 @@ The machinery tying those concepts together includes:
* TiddlerFilters
* TiddlerFields
* TiddlerTemplates
* DataTiddlers
* ContentType
* ShadowTiddlers
* [[Plugins]]
@ -88,7 +89,6 @@ When run under node.js, TiddlyWiki supports a [[command line interface|Getting s
* ServerCommand
* VerboseCommand
* VersionCommand
* WikiTestCommand
! Miscellaneous

View File

@ -3,5 +3,4 @@ tags: docs scenarios dev
TiddlyWiki can be embedded into a desktop or mobile application to enable it to perform operations that are not possible from a conventional browser.
For example, Mobile Safari on iOS runs TiddlyWiki well but doesn't provide wholly practical means to persistently save changes on the device. A wrapper application can embed TiddlyWiki using the ~UIWebView control
For example, Mobile Safari on iOS runs TiddlyWiki well but doesn't provide any practical means to persistently save changes on the device. A wrapper application can embed TiddlyWiki using the ~UIWebView control.

View File

@ -4,10 +4,6 @@ tags: introduction greetings
type: text/vnd.tiddlywiki
modified: 201208121934
@@.alert.alert-block
''6th January 2013'' -- the TiddlyWiki5 core code is emerging from some major refactoring upheavals, and there may still be regressions that will be fixed over the next few days, along with bringing the documentation back up to date
@@
Welcome to TiddlyWiki5, a reboot of TiddlyWiki, the reusable 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, giving you a better way of managing information 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.

View File

@ -11,7 +11,6 @@ For end users, the important improvements include:
* 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.

View File

@ -54,26 +54,14 @@ TiddlyWiki is built on a [[tiny microkernel|BootMechanism]] with all functionali
* WikiMethodModules
* WikiTextRuleModules
! Tree Nodes
! Parsers
The ParsingMechanism and the RenderingMechanism use a simple tree structure to represent both parsed WikiText and the HTML DOM structure of rendered content.
TiddlyWiki processes [[ContentTypes|ContentType]] such as WikiText using these parsers:
* TreeNode
* ElementNode
* EntityNode
* MacroNode
* RawNode
* TextNode
! Other Parsers
TiddlyWiki processes other [[ContentTypes|ContentType]] than WikiText using these parsers:
* OldWikiTextParser
* WikiTextParser
* JsonParser
* ImageParser
* PlainTextParser
* TiddlyTextParser
* JavaScriptParser
! Deserializers
@ -83,7 +71,3 @@ Deserializers are modules that read tiddlers from different text formats:
* RecipeFiles
* TiddlerFiles
* TiddlyWikiFiles
! Serializers
Serializers are modules that convert tiddlers to different text formats:

View File

@ -8,3 +8,4 @@ TextReferences are made up of several parts, most of which can be optional:
* `<tiddler title>` - the text field of the specified tiddler
* `<tiddler title>!!<metadata field>` - a tiddler metadata field (eg, `modified`, `modifier`, `type` etc)
* `!!<metadata field>` - a metadata field of the current tiddler
* `<tiddler title>##<property index>` - extracts a named property from DataTiddlers

View File

@ -5,30 +5,30 @@ tags: docs command
Dump the titles of the tiddlers in the wiki store
{{{
```
--dump tiddlers
}}}
```
!!! dump tiddler
Dump the fields of an individual tiddler
{{{
```
--dump tiddler <title>
}}}
```
!!! dump shadows
Dump the titles of the shadow tiddlers in the wiki store
{{{
```
--dump shadows
}}}
```
!!! dump config
Dump the current core configuration
{{{
```
--dump config
}}}
```

View File

@ -3,6 +3,6 @@ tags: docs command
Load tiddlers from 2.x.x TiddlyWiki files (`.html`), `.tiddler`, `.tid`, `.json` or other files
{{{
```
--load <filepath>
}}}
```

View File

@ -3,8 +3,6 @@ tags: docs command
Save an individual tiddler as a specified ContentType, defaults to `text/html`
{{{
--savetiddler <title> <filename> [<type>] [<withparam> <withparam>...]
}}}
The optional `<withparams>` are substituted for `$1`, `$2` etc before parsing.
```
--savetiddler <title> <filename> [<type>]
```

View File

@ -3,21 +3,21 @@ tags: docs command
The server is very simple. At the root, it serves a rendering of a specified tiddler. Away from the root, it serves individual tiddlers encoded in JSON, and supports the basic HTTP operations for `GET`, `PUT` and `DELETE`.
{{{
```
--server <port> <roottiddler> <rendertype> <servetype>
}}}
```
For example:
{{{
```
--server 8080 $:/core/tiddlywiki5.template.html text/plain text/html
}}}
```
The parameters are:
{{{
```
--server <port> <roottiddler> <rendertype> <servetype>
}}}
```
* ''port'' - port number to serve from (defaults to "8080")
* ''roottiddler'' - the tiddler to serve at the root (defaults to "$:/core/tiddlywiki5.template.html")

View File

@ -3,6 +3,6 @@ tags: docs command
Triggers verbose output, useful for debugging
{{{
```
--verbose
}}}
```

View File

@ -3,6 +3,6 @@ tags: docs command
Displays the version number of TiddlyWiki.
{{{
```
--version
}}}
```

File diff suppressed because one or more lines are too long