mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-12-24 00:50:28 +00:00
Docs update
This commit is contained in:
parent
1b2cdf9cd0
commit
5e7be56802
@ -14,8 +14,6 @@ All of these thoughts came together when I saw GMail in April 2004, which used A
|
||||
|
||||
I started experimenting with HTML and JavaScript to explore the idea further. I'd had virtually no experience of either, just having put together some static pages and simple ASP sites in previous lives. Getting my head around these client-side technologies was painful; like everyone else, I was horrified to discover how appalling were the incompatibilities and inconsistencies of web programming.
|
||||
|
||||
Then I could show the idea with a static HTML file. So, I didn't need a serverside to demonstrate how this simple user interface idea worked. Or indeed a proper grown-up server with the ability to run cgi scripts.
|
||||
|
||||
! Launch of TiddlyWiki
|
||||
|
||||
So, in September 2004 I released a primitive [[first version of TiddlyWiki|http://tiddlywiki.com/firstversion.html]]. It was the smallest possible thing that demonstrated the idea that I had: it was a simple, self-contained static 48KB HTML file sitting on a dusty old Sun server in my friend Steph's attic.
|
||||
|
@ -15,7 +15,7 @@ Plugins are stored as tiddlers of type `application/json` with the field `plugin
|
||||
|
||||
The JSON structure for plugin tiddlers is as follows:
|
||||
|
||||
{{{
|
||||
```
|
||||
{
|
||||
"title": "$:/plugins/publisher/name",
|
||||
"description": "An exemplary plugin for demonstration purposes",
|
||||
@ -28,7 +28,7 @@ The JSON structure for plugin tiddlers is as follows:
|
||||
"title2": {"text": "Text"}
|
||||
}
|
||||
}
|
||||
}}}
|
||||
```
|
||||
|
||||
The titles of the individual tiddlers within a plugin are automatically prefixed with the title of the plugin itself and a slash `/`. Thus, in the example above the two tiddlers within the plugin will have the titles `$:/plugins/publisher/name/title1` and `$:/plugins/publisher/name/title2`.
|
||||
|
||||
@ -38,7 +38,7 @@ On the server, plugins can be stored as ordinary JSON tiddlers but it is often m
|
||||
|
||||
The `plugin.bundle` file should contain the following JSON structure:
|
||||
|
||||
{{{
|
||||
```
|
||||
{
|
||||
"metadata": {
|
||||
<as described above>
|
||||
@ -48,7 +48,7 @@ The `plugin.bundle` file should contain the following JSON structure:
|
||||
{"file": "../MyFile.txt", "fields": {"title": "MyTitle2"}}
|
||||
]
|
||||
}
|
||||
}}}
|
||||
```
|
||||
|
||||
The titles of the external tiddlers are again relative to the title of the plugin. Constituent tiddler files must specify the full title of the tiddler, including the name of the plugin.
|
||||
|
||||
@ -62,7 +62,7 @@ To be usable in the browser, plugins just need to be included in the wiki. This
|
||||
|
||||
A folder containing an exploded TiddlyWiki can contain a `wiki.tiddlywiki` file that identifies the plugins to be included in this wiki:
|
||||
|
||||
{{{
|
||||
```
|
||||
{
|
||||
"plugins": [
|
||||
"slider",
|
||||
@ -72,7 +72,7 @@ A folder containing an exploded TiddlyWiki can contain a `wiki.tiddlywiki` file
|
||||
"/mylib/another",
|
||||
]
|
||||
}
|
||||
}}}
|
||||
```
|
||||
|
||||
Plugins can be identified in several ways:
|
||||
|
||||
|
@ -2,7 +2,7 @@ title: TaskManagementExample
|
||||
|
||||
! Outstanding tasks
|
||||
|
||||
<$list filter="[tag[task]!tag[done]sort[created]]">
|
||||
<$list filter="[!has[draft.of]tag[task]!tag[done]sort[created]]">
|
||||
|
||||
<$checkbox tag="done"> <$view field="title" format="link"/></$checkbox>
|
||||
|
||||
@ -10,7 +10,7 @@ title: TaskManagementExample
|
||||
|
||||
! Completed tasks
|
||||
|
||||
<$list filter="[tag[task]tag[done]sort[created]]">
|
||||
<$list filter="[!has[draft.of]tag[task]tag[done]sort[created]]">
|
||||
|
||||
<$checkbox tag="done"> <$view field="title" format="link"/></$checkbox>
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user