mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-11-30 21:39:57 +00:00
Merge pull request #1271 from aelocson/patch-1
Fix links to tw.com from tw.com/dev
This commit is contained in:
commit
16ffef01ff
@ -10,5 +10,5 @@ TW has two approaches to save the user data. These approaches depends on way you
|
||||
<pre>testText</pre>
|
||||
</div>
|
||||
```
|
||||
The Div-Area has the same attributes like the standard tillder fields, listed in (\prettyref{list:TiddlerFields}), all attributes which are not in this list are parsed as a custom field. The only required attribute is the name attribute, all other attributes are optional.\\
|
||||
With a activated encryption the data is stored in a special Div-Area called "encryptedStoreArea". TiddlyWiki uses the Standford [[JavaScript Crypto Libary|http://bitwiseshiftleft.github.io/sjcl/]]. The encrypted Tiddlers are saved in a JSON string within this Div-Area.
|
||||
The Div-Area has the same attributes like the standard tillder fields, listed in [[TiddlerFields|http://tiddlywiki.com/#TiddlerFields]], all attributes which are not in this list are parsed as a custom field. The only required attribute is the name attribute, all other attributes are optional.\\
|
||||
With a activated encryption the data is stored in a special Div-Area called "encryptedStoreArea". TiddlyWiki uses the Standford [[JavaScript Crypto Libary|http://bitwiseshiftleft.github.io/sjcl/]]. The encrypted Tiddlers are saved in a JSON string within this Div-Area.
|
||||
|
@ -8,7 +8,7 @@ title: Selective Update
|
||||
With [[Messages]] a widget is able to put some kind of events into the TiddlyWiki application which is one part of the dynamic behaviour of widgets.
|
||||
The other part is selective updating.
|
||||
Widgets are often dependant on tiddler states.
|
||||
The ~ListWidget for example can be configured to list all tiddlers which are tagged with "important".
|
||||
The [[ListWidget|http://tiddlywiki.com/#ListWidget]] for example can be configured to list all tiddlers which are tagged with "important".
|
||||
Now, when such a tiddler is changed and it's "important" tag is removed, this change should reflect in the ~ListWidget.
|
||||
To allow widgets to react on such changes, each widget can provide a function ``refresh(changedTiddlers)``.
|
||||
The [[RootWidget|RootWidget and Rendering Startup]] is registered to the wiki store, using the [[Event Mechanism]]. When an change event occurs it starts to call the refresh function of its children with a list of the changed tiddlers.
|
||||
|
@ -30,13 +30,13 @@ title: Toc
|
||||
*** [[Saver]]
|
||||
*** [[Syncadaptor]]
|
||||
** [[UI and Rendering Pipeline]]
|
||||
*** [[Wikitext]]
|
||||
*** [[WikiText]]
|
||||
*** [[Parser]]
|
||||
*** [[Widgets]]
|
||||
**** [[Messages]]
|
||||
**** [[Selective Update]]
|
||||
*** [[Transclusion and TextReference]]
|
||||
*** [[RooTiddlyWikiidget and Rendering Startup]]
|
||||
*** [[RootWidget and Rendering Startup]]
|
||||
*** [[Navigator Widget]]
|
||||
*** [[Draft Mechanism]]
|
||||
|
||||
|
@ -81,7 +81,7 @@ Create the file plugin.info with content:
|
||||
|
||||
!! 4. Create the files for your plugin
|
||||
|
||||
For example files see the plugins in the ~TiddlyWiki5 repository i.e. those located at plugins/tiddlywiki/. See TiddlerFiles for details of the supported tiddler file formats.
|
||||
For example files see the plugins in the ~TiddlyWiki5 repository i.e. those located at plugins/tiddlywiki/. See [[TiddlerFiles|http://tiddlywiki.com/#TiddlerFiles]] for details of the supported tiddler file formats.
|
||||
|
||||
!!5. Build your files into a ~TiddlyWiki
|
||||
|
||||
|
@ -6,7 +6,7 @@ type: text/vnd.tiddlywiki
|
||||
|
||||
! Prerequisites
|
||||
|
||||
* [[TiddlyWiki on Node.js]]
|
||||
* [[TiddlyWiki on Node.js|http://tiddlywiki.com/#TiddlyWiki%20on%20Node.js]]
|
||||
* A GitHub account to submit the translation to tiddlywiki.com
|
||||
|
||||
! Setting Up
|
||||
@ -39,7 +39,7 @@ Content of `plugin.info` for Joe Bloggs' Welsh translation:
|
||||
}
|
||||
```
|
||||
|
||||
MultiTiddlerFiles make it possible to pack the text of several tiddlers in a single text file, simplifying some editing tasks.
|
||||
[[MultiTiddlerFiles|http://tiddlywiki.com/#MultiTiddlerFiles]] make it possible to pack the text of several tiddlers in a single text file, simplifying some editing tasks.
|
||||
|
||||
! Handling Updates
|
||||
|
||||
|
@ -4,14 +4,14 @@ tags: howto
|
||||
title: How to create plugins in the browser
|
||||
type: text/vnd.tiddlywiki
|
||||
|
||||
The recommended technique for building TiddlyWiki plugins involves running [[TiddlyWiki on Node.js]], but there is now an experimental technique for creating plugins directly in the browser.
|
||||
The recommended technique for building TiddlyWiki plugins involves running [[TiddlyWiki on Node.js|http://tiddlywiki.com/#TiddlyWiki%20on%20Node.js]], but there is now an experimental technique for creating plugins directly in the browser.
|
||||
|
||||
! Overview
|
||||
|
||||
Loading a plugin in the browser has several consequences:
|
||||
|
||||
* The original plugin tiddler itself is unchanged
|
||||
* The payload tiddlers are set up as individual ShadowTiddlers
|
||||
* The payload tiddlers are set up as individual [[ShadowTiddlers|http://tiddlywiki.com/#ShadowTiddlers]]
|
||||
|
||||
To make a modified copy of a plugin, one edits the constituent shadow tiddlers (doing this actually overrides the shadow tiddler with a new non-shadow tiddler containing the modified content). The repacking process retrieves the current value of all the shadow tiddlers included in the plugin, and then bundles the new values back into the original plugin tiddler.
|
||||
|
||||
|
@ -4,7 +4,7 @@ tags: dev
|
||||
title: JavaScript Macros
|
||||
type: text/vnd.tiddlywiki
|
||||
|
||||
Macros can be implemented as JavaScript modules as well as via the [[wikitext syntax|Macros in WikiText]].
|
||||
Macros can be implemented as JavaScript modules as well as via the [[wikitext syntax|http://tiddlywiki.com/#Macros%20in%20WikiText]].
|
||||
|
||||
! Overview
|
||||
|
||||
|
@ -4,7 +4,7 @@ tags: dev
|
||||
title: TiddlyWiki Architecture
|
||||
type: text/vnd.tiddlywiki
|
||||
|
||||
The heart of TiddlyWiki is an extensible representation transformation engine for text and images. Given the text of a tiddler and its associated ContentType, the engine can produce a rendering of the tiddler in a new ContentType. Furthermore, it can efficiently selectively update the rendering to track any changes in the tiddler or its dependents.
|
||||
The heart of TiddlyWiki is an extensible representation transformation engine for text and images. Given the text of a tiddler and its associated [[ContentType|http://tiddlywiki.com/#ContentType]], the engine can produce a rendering of the tiddler in a new [[ContentType|http://tiddlywiki.com/#ContentType]]. Furthermore, it can efficiently selectively update the rendering to track any changes in the tiddler or its dependents.
|
||||
|
||||
! Overview
|
||||
|
||||
@ -40,7 +40,7 @@ $tw.wiki.makeTiddlerIterator($tw.wiki.getTiddlersWithTag('timeline')
|
||||
});
|
||||
```
|
||||
|
||||
Data which should not be visible to end users under normal operation (eg. internal components, plugins, persisted state for GUI widgets) is stored in [[system tiddlers|SystemTiddlers]] organised via a set of [[namespaces|Naming of System Tiddlers]].
|
||||
Data which should not be visible to end users under normal operation (eg. internal components, plugins, persisted state for GUI widgets) is stored in [[system tiddlers|http://tiddlywiki.com/#SystemTiddlers]] organised via a set of [[namespaces|http://tiddlywiki.com/#Naming%20of%20System%20Tiddlers]].
|
||||
|
||||
The similarity between filesystem paths and system tiddler names is intentional and will be used to provide a hierarchical browsing interface in a future TiddlyWiki release.
|
||||
|
||||
@ -51,7 +51,7 @@ TiddlyWiki's view layer has a //lot// in common with desktop widget toolkits and
|
||||
!! Role of the DOM
|
||||
Because TiddlyWiki may re-render content, plugins should treat the DOM as write-only.
|
||||
|
||||
In other words, any state you store in the DOM could vanish at any instant and you need to use TiddlyWiki's internal [[StateMechanism]] instead.
|
||||
In other words, any state you store in the DOM could vanish at any instant and you need to use TiddlyWiki's internal [[StateMechanism|http://tiddlywiki.com/#StateMechanism]] instead.
|
||||
|
||||
In a desktop application, the base widget class defines a method such as `paint(canvas)` which is called in response to `expose` events or "data has changed" messages.
|
||||
|
||||
@ -65,4 +65,4 @@ While TiddlyWiki's extended [[WikiText]] is similar in design to HTML templating
|
||||
|
||||
In this respect, it's closer to a glue language like Qt Quick or Python with Javascript filling the "create new components" role of C/C++ in widget toolkits like Qt and GTK+.
|
||||
|
||||
To familiarise yourself with this, read [[Widgets in WikiText]] and [[Introduction to Filters]]. then examine the internals for a tiddler like [[TaskManagementExample]].
|
||||
To familiarise yourself with this, read [[Widgets in WikiText|http://tiddlywiki.com/#Widgets%20in%20WikiText]] and [[Introduction to Filters|http://tiddlywiki.com/#Introduction%20to%20Filters]]. then examine the internals for a tiddler like [[TaskManagementExample|http://tiddlywiki.com/#TaskManagementExample]].
|
||||
|
@ -3,7 +3,7 @@ modified: 20140101175304016
|
||||
title: TiddlyWiki on node-webkit
|
||||
type: text/vnd.tiddlywiki
|
||||
|
||||
[[node-webkit]] allows TiddlyWiki to be set up as a native application for Windows, Mac OS X or Linux.
|
||||
[[node-webkit|http://tiddlywiki.com/#node-webkit]] allows TiddlyWiki to be set up as a native application for Windows, Mac OS X or Linux.
|
||||
|
||||
! Setting up
|
||||
|
||||
|
@ -7,7 +7,7 @@ title: TiddlyWiki5 Development Environment
|
||||
|
||||
! Setting up npm
|
||||
|
||||
[[Installing TiddlyWiki5]] with NPM downloads a snapshot release of TiddlyWIki5. To use a development copy of the TiddlyWiki5 repository instead of the copy installed by [[NPM]], use this command within the root of the TiddlyWiki5 repo:
|
||||
[[Installing TiddlyWiki5|http://tiddlywiki.com/#Installing%20TiddlyWiki%20on%20Node.js]] with NPM downloads a snapshot release of TiddlyWiki5. To use a development copy of the TiddlyWiki5 repository instead of the copy installed by [[NPM]], use this command within the root of the TiddlyWiki5 repo:
|
||||
|
||||
```bash
|
||||
npm link
|
||||
|
Loading…
Reference in New Issue
Block a user