mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-11-19 16:24:51 +00:00
Merge pull request #226 from asampal/master
Style changes in user visible text node -> Node
This commit is contained in:
commit
a29c0dfce9
@ -9,7 +9,7 @@ TiddlyWiki5 can be used to build older 2.x.x versions of TiddlyWiki from their c
|
|||||||
|
|
||||||
! Usage
|
! Usage
|
||||||
|
|
||||||
TiddlyWikiClassic is built from the command line by running TiddlyWiki5 under node.js. A typical usage would be:
|
TiddlyWikiClassic is built from the command line by running TiddlyWiki5 under Node.js. A typical usage would be:
|
||||||
|
|
||||||
```
|
```
|
||||||
node ../../tiddlywiki.js \
|
node ../../tiddlywiki.js \
|
||||||
|
@ -12,9 +12,9 @@ Right click and download these links to single file editions of TiddlyWiki5:
|
|||||||
* [[empty|http://five.tiddlywiki.com/empty]]
|
* [[empty|http://five.tiddlywiki.com/empty]]
|
||||||
* [[tw5.com|http://five.tiddlywiki.com/]]
|
* [[tw5.com|http://five.tiddlywiki.com/]]
|
||||||
|
|
||||||
! Download node.js Edition
|
! Download Node.js Edition
|
||||||
|
|
||||||
For working on the command line with the node.js edition of TiddlyWiki5, you can install TiddlyWiki via [[npm|http://npmjs.org]]:
|
For working on the command line with the Node.js edition of TiddlyWiki5, you can install TiddlyWiki via [[npm|http://npmjs.org]]:
|
||||||
|
|
||||||
```
|
```
|
||||||
npm -g install tiddlywiki
|
npm -g install tiddlywiki
|
||||||
|
@ -20,7 +20,7 @@ type: text/vnd.tiddlywiki
|
|||||||
* [[CodeMirror support via a plugin|http://five.tiddlywiki.com/codemirrordemo.html]]
|
* [[CodeMirror support via a plugin|http://five.tiddlywiki.com/codemirrordemo.html]]
|
||||||
* [[Markdown support via a plugin|http://five.tiddlywiki.com/markdowndemo.html]]
|
* [[Markdown support via a plugin|http://five.tiddlywiki.com/markdowndemo.html]]
|
||||||
* Many internal improvements:
|
* Many internal improvements:
|
||||||
** TiddlyWiki can now be run under [[node.js]] as well as in the browser, allowing it to be used as a personal web server
|
** TiddlyWiki can now be run under [[Node.js]] as well as in the browser, allowing it to be used as a personal web server
|
||||||
** An elegant [[microkernel architecture|PluginMechanism]], that allows infinite customisation by replacing and augmenting the core modules
|
** 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
|
** 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
|
** Run the TiddlyWiki5 [[test suite|TestingMechanism]] from http://five.tiddlywiki.com/test.html
|
||||||
|
@ -6,7 +6,7 @@ tags: introduction
|
|||||||
title: HelloThere
|
title: HelloThere
|
||||||
type: text/vnd.tiddlywiki
|
type: text/vnd.tiddlywiki
|
||||||
|
|
||||||
Welcome to TiddlyWiki5, a reboot of TiddlyWiki, the non-linear personal web notebook first released in 2004. 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]].
|
Welcome to TiddlyWiki5, a reboot of TiddlyWiki, the non-linear personal web notebook first released in 2004. 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]].
|
||||||
|
|
||||||
This is TiddlyWiki5 version //<<version>>//. It is drawing to the end of the alpha phase, meaning it is almost ready for everyday use. It is a great time to get involved and support its [[future development|RoadMap]]:
|
This is TiddlyWiki5 version //<<version>>//. It is drawing to the end of the alpha phase, meaning it is almost ready for everyday use. It is a great time to get involved and support its [[future development|RoadMap]]:
|
||||||
|
|
||||||
|
@ -5,4 +5,4 @@ modifier: JeremyRuston
|
|||||||
tags: concepts
|
tags: concepts
|
||||||
title: TiddlyWiki5
|
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]].
|
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]].
|
||||||
|
@ -5,7 +5,7 @@ modifier: JeremyRuston
|
|||||||
tags: dev
|
tags: dev
|
||||||
title: TiddlyWikiFolders
|
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.
|
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.
|
||||||
|
|
||||||
! Wiki folder files and folders
|
! Wiki folder files and folders
|
||||||
|
|
||||||
|
@ -1,10 +1,10 @@
|
|||||||
title: node.js
|
title: Node.js
|
||||||
tags: definitions
|
tags: definitions
|
||||||
|
|
||||||
[[node.js]] is a downloadable application for your PC, Mac or Linux computer that lets it run JavaScript applications. Unlike JavaScript applications running in a web browser, [[node.js]] code has full access to the file system and other resources of the computer, enabling it to perform the roles that have traditionally been the preserve of languages like Java, PHP and Python. See http://nodejs.org/ for more details.
|
[[Node.js]] is a downloadable application for your PC, Mac or Linux computer that lets it run JavaScript applications. Unlike JavaScript applications running in a web browser, [[Node.js]] code has full access to the file system and other resources of the computer, enabling it to perform the roles that have traditionally been the preserve of languages like Java, PHP and Python. See http://nodejs.org for more details.
|
||||||
|
|
||||||
For TiddlyWiki, [[node.js]] means that we can have a single code base that can run in the browser or on the server, giving great flexibility in how it is used.
|
For TiddlyWiki, [[Node.js]] means that we can have a single code base that can run in the browser or on the server, giving great flexibility in how it is used.
|
||||||
|
|
||||||
For end users, [[node.js]] is no more complicated to install than a web browser, but unlocks powerful capabilities such as the ability to run TiddlyWiki as a web server that you can connect to from other devices.
|
For end users, [[Node.js]] is no more complicated to install than a web browser, but unlocks powerful capabilities such as the ability to run TiddlyWiki as a web server that you can connect to from other devices.
|
||||||
|
|
||||||
See [[TiddlyWiki5 Node Edition]] for more details.
|
See [[TiddlyWiki5 Node Edition]] for more details.
|
||||||
|
@ -33,7 +33,7 @@ For trying TiddlyWiki5 out under Node.js, several scripts are provided (.sh for
|
|||||||
|
|
||||||
This script builds several variants of TiddlyWiki5 for deployment on tiddlywiki.com.
|
This script builds several variants of TiddlyWiki5 for deployment on tiddlywiki.com.
|
||||||
|
|
||||||
By default, files are output to a folder called `jermolene.github.com`, sibling to the to the TiddlyWiki5 source directory. For example:
|
By default, files are output to a folder called `jermolene.github.com`, sibling to the TiddlyWiki5 source directory. For example:
|
||||||
|
|
||||||
```
|
```
|
||||||
/TiddlyWork/ - Directory for working with TiddlyWiki5
|
/TiddlyWork/ - Directory for working with TiddlyWiki5
|
||||||
|
@ -7,9 +7,9 @@ title: BootMechanism
|
|||||||
|
|
||||||
!Introduction
|
!Introduction
|
||||||
|
|
||||||
At its heart, TiddlyWiki5 is a relatively small boot kernel that runs either under node.js or in the browser with all other functionality added via dynamically loaded [[modules|Modules]].
|
At its heart, TiddlyWiki5 is a relatively small boot kernel that runs either under Node.js or in the browser with all other functionality added via dynamically loaded [[modules|Modules]].
|
||||||
|
|
||||||
The kernel boots just enough of the TiddlyWiki environment to allow it to load and execute module tiddlers. The module system is compatible with CommonJS and [[node.js]].
|
The kernel boots just enough of the TiddlyWiki environment to allow it to load and execute module tiddlers. The module system is compatible with CommonJS and [[Node.js]].
|
||||||
|
|
||||||
There are many [[different types of module|ModuleType]]: parsers, deserializers, widgets etc. It goes much further than you might expect. For example, individual tiddler fields are modules, too: there's a module that knows how to handle the `tags` field, and another that knows how to handle the special behaviour of the `modified` and `created` fields. Some plugin modules have further sub-plugins: the wikitext parser, for instance, accepts parsing rules as individual plugin modules.
|
There are many [[different types of module|ModuleType]]: parsers, deserializers, widgets etc. It goes much further than you might expect. For example, individual tiddler fields are modules, too: there's a module that knows how to handle the `tags` field, and another that knows how to handle the special behaviour of the `modified` and `created` fields. Some plugin modules have further sub-plugins: the wikitext parser, for instance, accepts parsing rules as individual plugin modules.
|
||||||
|
|
||||||
@ -28,7 +28,7 @@ The boot kernel includes:
|
|||||||
* Code for the browser to load tiddlers from the HTML DOM
|
* Code for the browser to load tiddlers from the HTML DOM
|
||||||
* Code for the server to load tiddlers from the file system
|
* Code for the server to load tiddlers from the file system
|
||||||
|
|
||||||
Each module is an ordinary `node.js`-style module, using the `require()` function to access other modules and the `exports` global to return JavaScript values. The boot kernel smooths over the differences between `node.js` and the browser, allowing the same plugin modules to execute in both environments.
|
Each module is an ordinary `Node.js`-style module, using the `require()` function to access other modules and the `exports` global to return JavaScript values. The boot kernel smooths over the differences between `Node.js` and the browser, allowing the same plugin modules to execute in both environments.
|
||||||
|
|
||||||
In the browser, `core/boot.js` is packed into a template HTML file that contains the following elements in order:
|
In the browser, `core/boot.js` is packed into a template HTML file that contains the following elements in order:
|
||||||
|
|
||||||
@ -37,6 +37,6 @@ In the browser, `core/boot.js` is packed into a template HTML file that contains
|
|||||||
* JavaScript modules, packed as HTML `<SCRIPT>` blocks
|
* JavaScript modules, packed as HTML `<SCRIPT>` blocks
|
||||||
* `core/boot.js`, containing the boot kernel
|
* `core/boot.js`, containing the boot kernel
|
||||||
|
|
||||||
On the server, `core/boot.js` is executed directly. It uses the `node.js` local file API to load plugins directly from the file system in the `core/modules` directory. The code loading is performed synchronously for brevity (and because the system is in any case inherently blocked until plugins are loaded).
|
On the server, `core/boot.js` is executed directly. It uses the `Node.js` local file API to load plugins directly from the file system in the `core/modules` directory. The code loading is performed synchronously for brevity (and because the system is in any case inherently blocked until plugins are loaded).
|
||||||
|
|
||||||
The boot kernel sets up the `$tw` global variable that is used to store all the state data of the system.
|
The boot kernel sets up the `$tw` global variable that is used to store all the state data of the system.
|
||||||
|
@ -2,7 +2,7 @@ modified: 201304251659
|
|||||||
tags: dev
|
tags: dev
|
||||||
title: TestingMechanism
|
title: TestingMechanism
|
||||||
|
|
||||||
TiddlyWiki5 incorporates the Jasmine JavaScript testing framework (see http://pivotal.github.io/jasmine/). It allows the same tests to be run both in the browser and under node.js.
|
TiddlyWiki5 incorporates the Jasmine JavaScript testing framework (see http://pivotal.github.io/jasmine/). It allows the same tests to be run both in the browser and under Node.js.
|
||||||
|
|
||||||
! TiddlyWiki5 Testing Components
|
! TiddlyWiki5 Testing Components
|
||||||
|
|
||||||
@ -11,9 +11,9 @@ There are two main elements to the TiddlyWiki5 testing mechanism:
|
|||||||
* The plugin `tiddlywiki/jasmine` that wraps Jasmine up into a plugin along with some glue code
|
* The plugin `tiddlywiki/jasmine` that wraps Jasmine up into a plugin along with some glue code
|
||||||
* The TiddlyWiki5 edition `test` that contains the core test specifications and includes the Jasmine plugin
|
* The TiddlyWiki5 edition `test` that contains the core test specifications and includes the Jasmine plugin
|
||||||
|
|
||||||
! Running the Tests in node.js
|
! Running the Tests in Node.js
|
||||||
|
|
||||||
To run the tests under node.js just load up the `test` wiki:
|
To run the tests under Node.js just load up the `test` wiki:
|
||||||
|
|
||||||
```
|
```
|
||||||
node ./tiddlywiki.js \
|
node ./tiddlywiki.js \
|
||||||
|
@ -11,7 +11,7 @@ SyncAdaptorModules encapsulate storage mechanisms that can be used by the SyncMe
|
|||||||
|
|
||||||
* The TiddlyWebAdaptor interfaces with servers compatible with TiddlyWeb's HTTP API, such as TiddlyWeb itself and TiddlyWiki5's built-in ServerMechanism.
|
* The TiddlyWebAdaptor interfaces with servers compatible with TiddlyWeb's HTTP API, such as TiddlyWeb itself and TiddlyWiki5's built-in ServerMechanism.
|
||||||
|
|
||||||
* The LocalFileAdaptor interfaces with file systems with an API compatible with node.js's `fs` module
|
* The LocalFileAdaptor interfaces with file systems with an API compatible with Node.js's `fs` module
|
||||||
|
|
||||||
SyncAdaptorModules are represented as JavaScript tiddlers with the field `module-type` set to `syncadaptor`.
|
SyncAdaptorModules are represented as JavaScript tiddlers with the field `module-type` set to `syncadaptor`.
|
||||||
|
|
||||||
|
@ -5,4 +5,4 @@ modified: 201308241531
|
|||||||
modifier: JeremyRuston
|
modifier: JeremyRuston
|
||||||
title: command
|
title: command
|
||||||
|
|
||||||
When run under node.js, TiddlyWiki supports a [[command line interface|TiddlyWiki5 Node Edition]] with these built-in commands.
|
When run under Node.js, TiddlyWiki supports a [[command line interface|TiddlyWiki5 Node Edition]] with these built-in commands.
|
@ -13,7 +13,7 @@ title: TalkyTalky
|
|||||||
!! @~TiddlyWiki & @Jermolene
|
!! @~TiddlyWiki & @Jermolene
|
||||||
@@
|
@@
|
||||||
|
|
||||||
TiddlyWiki5 is a JavaScript wiki that can run entirely in the browser, or under ''node.js''. Internally, it is a representation transformation engine. It parses WikiText and renders it as text, or straight to the DOM with selective refresh to reflect subsequent changes. WikiText is used to render the user interface as well as the content of tiddlers. Once you know how to edit a tiddler you know how to customise TiddlyWiki, with no limits - it's only JavaScript.
|
TiddlyWiki5 is a JavaScript wiki that can run entirely in the browser, or under ''Node.js''. Internally, it is a representation transformation engine. It parses WikiText and renders it as text, or straight to the DOM with selective refresh to reflect subsequent changes. WikiText is used to render the user interface as well as the content of tiddlers. Once you know how to edit a tiddler you know how to customise TiddlyWiki, with no limits - it's only JavaScript.
|
||||||
|
|
||||||
Why is TiddlyWiki different? It frees you from the monopoly platforms of the web: store stuff in TW5 and you can pretty much guarantee you'll still have it in 100 years. Freedom, into the far future.
|
Why is TiddlyWiki different? It frees you from the monopoly platforms of the web: store stuff in TW5 and you can pretty much guarantee you'll still have it in 100 years. Freedom, into the far future.
|
||||||
|
|
||||||
@ -45,7 +45,7 @@ Store your tiddlers in a single HTML file along with the JS
|
|||||||
# Drag in the task tiddlers
|
# Drag in the task tiddlers
|
||||||
# Drag in TaskManagementExample, show source
|
# Drag in TaskManagementExample, show source
|
||||||
|
|
||||||
!!! node.js Edition
|
!!! Node.js Edition
|
||||||
|
|
||||||
Store your tiddlers in separate files in a chain of linked directories.
|
Store your tiddlers in separate files in a chain of linked directories.
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user