mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-12-24 00:50:28 +00:00
Docs updates
This commit is contained in:
parent
5f25bcb846
commit
77556828a7
@ -1,9 +1,11 @@
|
||||
title: Acknowledgements
|
||||
modifier: JeremyRuston
|
||||
tags: introduction
|
||||
modifier: JeremyRuston
|
||||
title: Acknowledgements
|
||||
modified: 201304251645
|
||||
|
||||
TiddlyWiki5 wouldn't be possible without the ongoing support of the TiddlyWiki user and developer community. Their attention and feedback has made it possible to gain an understanding of what is wanted from the product, and their passion for it has taught me that it is worth the investment that I am making.
|
||||
|
||||
TiddlyWiki5 stands on the shoulders of giants, by reusing these projects:
|
||||
|
||||
* [[The Stanford Javascript Crypto Library|http://crypto.stanford.edu/sjcl/]]
|
||||
* [[The Jasmine JavaScript Test Framework|http://pivotal.github.io/jasmine/]]
|
||||
|
@ -1,5 +1,6 @@
|
||||
title: Demos
|
||||
tags: introduction
|
||||
title: Demos
|
||||
modified: 201304251654
|
||||
|
||||
Here are a few features of TiddlyWiki that you can explore:
|
||||
|
||||
@ -8,6 +9,7 @@ Here are a few features of TiddlyWiki that you can explore:
|
||||
* Browse the list of AllTiddlers or the SystemTiddlers
|
||||
* Examine the example [[bitmap images|Motovun Jack.jpg]] and [[SVG images|Motovun Jack.svg]]
|
||||
* Check out the TaskManagementExample
|
||||
* Run the TiddlyWiki5 [[test suite|TestingMechanism]] from http://five.tiddlywiki.com/test.html
|
||||
|
||||
Learn more about using TiddlyWiki5:
|
||||
|
||||
|
@ -1,5 +1,6 @@
|
||||
title: DeveloperDocs
|
||||
tags: docs introduction dev
|
||||
title: DeveloperDocs
|
||||
modified: 201304251644
|
||||
|
||||
This is the developer documentation hub for TiddlyWiki.
|
||||
|
||||
@ -29,6 +30,7 @@ Internally, TiddlyWiki is built on a number of key objects and mechanisms:
|
||||
* CommandMechanism
|
||||
* ConfigMechanism
|
||||
* EncryptionMechanism
|
||||
* TestingMechanism
|
||||
|
||||
! Plugin Module Types
|
||||
|
||||
|
@ -1,8 +1,8 @@
|
||||
title: HelloThere
|
||||
modifier: JeremyRuston
|
||||
tags: introduction greetings
|
||||
modified: 201304251653
|
||||
type: text/vnd.tiddlywiki
|
||||
modified: 201208121934
|
||||
tags: introduction greetings
|
||||
modifier: JeremyRuston
|
||||
title: HelloThere
|
||||
|
||||
Welcome to TiddlyWiki5, a reboot of TiddlyWiki, the 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]].
|
||||
|
||||
|
35
editions/tw5.com/tiddlers/mechanisms/TestingMechanism.tid
Normal file
35
editions/tw5.com/tiddlers/mechanisms/TestingMechanism.tid
Normal file
@ -0,0 +1,35 @@
|
||||
title: TestingMechanism
|
||||
tags: docs dev
|
||||
modified: 201304251652
|
||||
|
||||
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
|
||||
|
||||
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 TiddlyWiki5 edition `test` that contains the core test specifications and includes the Jasmine plugin
|
||||
|
||||
! Running the Tests in node.js
|
||||
|
||||
To run the tests under node.js just load up the `test` wiki:
|
||||
|
||||
```
|
||||
node ./tiddlywiki.js \
|
||||
./editions/test \
|
||||
```
|
||||
|
||||
! Running the Tests in the Browser
|
||||
|
||||
To generate a wiki containing the browser tests load up the `test` wiki and save it as an HTML file:
|
||||
|
||||
```
|
||||
node ./tiddlywiki.js \
|
||||
./editions/test \
|
||||
--verbose \
|
||||
--savetiddler $:/core/templates/tiddlywiki5.template.html $TW5_BUILD_OUTPUT/test.html text/plain \
|
||||
```
|
||||
|
||||
Then, open the `test.html` file in the browser to see the test results. There is a prebuilt version of `test.html` at:
|
||||
|
||||
http://five.tiddlywiki.com/test.html
|
Loading…
Reference in New Issue
Block a user