1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-06-13 17:16:48 +00:00

Docs updates

This commit is contained in:
Jeremy Ruston 2013-08-09 16:51:49 +01:00
parent 064a3ffb20
commit a571356f59
8 changed files with 42 additions and 24 deletions

View File

@ -0,0 +1,9 @@
title: PasswordCommand
tags: docs command
Set a password for subsequent crypto operations
```
--password <password>
```

View File

@ -1,6 +1,6 @@
title: LazyLoading
modified: 201308051412
TiddlyWiki5 currently only implements lazy loading when its running in the browser talking to a TiddlyWeb-compatible server. When it syncs, it first requests a "skinny" version of each tiddler (consisting of all the fields apart from the text field). An attempt to read those skinny tiddlers with `wiki.getTiddler()` returns just the skinny fields, but an attempt to read one using `wiki.getTiddlerText()` will trigger an asynchronous load of the full tiddler text, which in turn triggers a refresh cycle, updating the display to reflect the newly loaded tiddler. Widgets that loop through all tiddlers are fine; it's only if they trigger `wiki.getTiddlerText()` for a tiddler that it will get loaded.
TiddlyWiki5 currently only implements lazy loading when its running in the browser talking to a TiddlyWeb-compatible server. When it syncs, it first requests a "skinny" version of each tiddler (consisting of all the fields apart from the text field). Subsequently, an attempt to read those skinny tiddlers with `wiki.getTiddler()` returns just the skinny fields, but an attempt to read one using `wiki.getTiddlerText()` will trigger an asynchronous load of the full tiddler text, which in turn triggers a refresh cycle, updating the display to reflect the newly loaded tiddler. Widgets that loop through all tiddlers are fine; it's only if they trigger `wiki.getTiddlerText()` for a tiddler that it will get loaded.
So, the browser-based search built into TiddlyWiki5 will only search the text of tiddlers that have been fully loaded. The expectation is that when lazy loading is used in a client-server configuration, then it's the server that really needs to handle search operations, because it's only the server that can "see" the text of all tiddlers. So, the plan is to integrate TW's built in search with TiddlyWeb's search API. The simplest approach is that any local search triggers an asynchronous server side search. The results of the search would be asynchronously loaded such that they would dynamically appear in the local search results.

View File

@ -1,25 +1,7 @@
title: ModuleType
tags: docs concepts
modified: 201308091623
The `module-type` field of a [[JavaScript module|Modules]] is a string that identifies the type of the module. TiddlyWiki5 uses the following types:
The `module-type` field of a [[JavaScript module|Modules]] is a string that identifies the type of the module.
* `command` - individual commands for the `$tw.Commander` class
* `config` - values to be merged over the `$tw.config` global
* `editor` - interactive editors for different types of content
* `global` - members of the `$tw` global
* `library` - external global JavaScript library, such as Esprima or jQuery
* `macro` - macro definitions
* `module` - generic type for modules `require`d by other modules
* `parser` - parsers for different types of content
* `saver` - functions for saving TiddlyWiki content on different platforms
* `startup` - functions to be called by the kernel after booting
* `storyview` - visualisations for the `story` macro
* `tiddlerdeserializer` - methods to extract tiddlers from text representations or the DOM
* `tiddlerfield` - defines the characteristics of tiddler fields of a particular name
* `tiddlermethod` - additional methods for the `$tw.Tiddler` class
* `tiddlerserializer` - methods to serialise tiddlers to text representations
* `treenode` - classes of parser tree nodes
* `treeutils` - static utility methods for parser tree nodes
* `utils` - general purpose utility functions residing in `$tw.utils`
* `wikimethod` - additional methods for the `$tw.Wiki` class
* `wikitextrule` - individual rules for the wikitext parser
See [[$:/ConfigInfo]] for a list of the module types used in this wiki.

View File

@ -1,4 +1,7 @@
title: Modules
tags: docs concepts
modified: 201308091623
A //module// in TiddlyWiki5 is a tiddler containing executable JavaScript, of the type `application/javascript` and with the field `module-type` set to the ModuleType of the module.
See [[$:/ConfigInfo]] for details of the currently loaded modules.

View File

@ -1,6 +1,11 @@
title: Plugins
tags: docs concepts
modified: 201308091623
A plugin in TiddlyWiki5 is a bundle of tiddlers packaged together as a single tiddler. Plugins are used to distribute optional, custom components for TiddlyWiki. Plugins can contain JavaScript modules, style sheets, and templates to extend the functionality of TiddlyWiki itself. Plugins can also be used to distribute ordinary text, images or other content. Plugins can be updated from their source as a unit.
A plugin in TiddlyWiki5 is a bundle of tiddlers packaged together as a single tiddler. Plugins are used to distribute optional, custom components for TiddlyWiki.
The tiddlers within a plugin appear as ShadowTiddlers.
Plugins can contain JavaScript modules, style sheets, and templates to extend the functionality of TiddlyWiki itself. Plugins can also be used to distribute ordinary text, images or other content. Plugins can be updated from their source as a unit.
See the PluginMechanism discussion for more details about how plugins are implemented internally.

View File

@ -0,0 +1,7 @@
title: ShadowTiddlers
tags: docs concepts
modified: 201308091623
ShadowTiddlers are tiddlers that are loaded from within [[Plugins]]. Unlike ordinary tiddlers, they don't appear in most lists.
ShadowTiddlers can be overridden with an ordinary tiddler of the same name. If that tiddler is subsequently deleted then the original shadow tiddler is automatically restored.

View File

@ -1,4 +1,4 @@
modified: 201306011656
modified: 201308091623
title: TiddlerFields
TiddlerFields are name:value pairs that make up a [[tiddler|Tiddlers]]. The standard fields are:
@ -10,6 +10,7 @@ TiddlerFields are name:value pairs that make up a [[tiddler|Tiddlers]]. The stan
* `creator` - The name of the person who created the tiddler
* `tags` - A list of tags applied to the tiddler
* `type` - The ContentType that should used to interpret the content of the tiddler
* `list` - A list of tiddler titles
Other fields used by the core are:
@ -30,3 +31,5 @@ The TiddlyWebAdaptor uses a few more fields:
* `bag` - The name of the bag from which a tiddler came
* `revision` - The revision of the tiddler held at the server
See [[$:/ConfigInfo]] for details of the fields used in this wiki.

View File

@ -140,6 +140,15 @@ TiddlyWiki</a> files (<code>
<div class='tw-transclude'>
<h3 class=''>
<span class='tw-view-link'>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/PasswordCommand.html'>
PasswordCommand</a></span></h3><div>
<div class='tw-transclude'>
<p>
Set a password for subsequent crypto operations</p><pre>
--password &lt;password&gt;</pre></div></div></div></div><div class='tw-list-element'>
<div class='tw-transclude'>
<h3 class=''>
<span class='tw-view-link'>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/PrintCommand.html'>
PrintCommand</a></span></h3><div>
<div class='tw-transclude'>