1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-27 12:07:19 +00:00

Docs update

This commit is contained in:
Jeremy Ruston 2013-02-05 22:11:36 +00:00
parent 5c51626809
commit 35f0a16c4f
4 changed files with 19 additions and 11 deletions

View File

@ -14,10 +14,10 @@ You can explore this mechanism by opening the JavaScript console in your browser
$tw.wiki.addTiddler({title: "HelloThere", text: "This is some new content"}); $tw.wiki.addTiddler({title: "HelloThere", text: "This is some new content"});
``` ```
If the tiddler `HelloThere` is visible then you'll see it instantly change to reflect the new content. If you create a tiddler that doesn't currently exist then you'll see any displayed links to it instantly change from italicised to normal: If the tiddler `HelloThere` is visible then you'll see it instantly change to reflect the new content. If you create a tiddler that doesn't currently exist (like IntentionallyMissingTiddler) then you'll see any displayed links to it instantly change from italicised to normal:
``` ```
$tw.wiki.addTiddler({title: "TiddlyWiki5", text: "This tiddler now exists"}); $tw.wiki.addTiddler({title: "IntentionallyMissingTiddler", text: "This tiddler now exists"});
``` ```
If you're interested in understanding more about the internal operation of TiddlyWiki, it is recommended that you review the [[Docs]] and read the code -- start with the boot kernel [[$:/core/boot.js]]. If you're interested in understanding more about the internal operation of TiddlyWiki, it is recommended that you review the [[Docs]] and read the code -- start with the boot kernel [[$:/core/boot.js]].

View File

@ -0,0 +1,6 @@
title: TiddlyWiki5
modifier: JeremyRuston
modified: 201302051920
tags: docs concepts
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]].

View File

@ -1,4 +1,4 @@
title: SiteTitle title: SiteTitle
modifier: JeremyRuston modifier: JeremyRuston
[[TiddlyWiki5|HelloThere]] TiddlyWiki5

View File

@ -1,10 +1,10 @@
<h1 class=''> <h1 class=''>
Welcome to <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='TiddlyWiki5'> Welcome to <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki5'>
TiddlyWiki5</a> TiddlyWiki5</a>
</h1> </h1>
<div class='tw-transclude'> <div class='tw-transclude'>
<p> <p>
Welcome to <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='TiddlyWiki5'> Welcome to <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki5'>
TiddlyWiki5</a> TiddlyWiki5</a>
, a reboot of <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki'> , a reboot of <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki'>
TiddlyWiki</a> TiddlyWiki</a>
@ -24,7 +24,7 @@ tiddlers</a>
TiddlyWiki</a> TiddlyWiki</a>
aims to provide a fluid interface for working with tiddlers, allowing them to be aggregated and composed into longer narratives.</p> aims to provide a fluid interface for working with tiddlers, allowing them to be aggregated and composed into longer narratives.</p>
<p> <p>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='TiddlyWiki5'> <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki5'>
TiddlyWiki5</a> TiddlyWiki5</a>
has many <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='Improvements'> has many <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='Improvements'>
improvements</a> improvements</a>
@ -90,9 +90,11 @@ $tw.wiki.addTiddler({title: &quot;HelloThere&quot;, text: &quot;This is some new
<p> <p>
If the tiddler <code> If the tiddler <code>
HelloThere</code> HelloThere</code>
is visible then you'll see it instantly change to reflect the new content. If you create a tiddler that doesn't currently exist then you'll see any displayed links to it instantly change from italicised to normal:</p> is visible then you'll see it instantly change to reflect the new content. If you create a tiddler that doesn't currently exist (like <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='IntentionallyMissingTiddler'>
IntentionallyMissingTiddler</a>
) then you'll see any displayed links to it instantly change from italicised to normal:</p>
<pre> <pre>
$tw.wiki.addTiddler({title: &quot;TiddlyWiki5&quot;, text: &quot;This tiddler now exists&quot;});</pre> $tw.wiki.addTiddler({title: &quot;IntentionallyMissingTiddler&quot;, text: &quot;This tiddler now exists&quot;});</pre>
<p> <p>
If you're interested in understanding more about the internal operation of <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki'> If you're interested in understanding more about the internal operation of <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki'>
TiddlyWiki</a> TiddlyWiki</a>
@ -109,7 +111,7 @@ Boot Mechanism</h1>
<h1 class=''> <h1 class=''>
Introduction</h1> Introduction</h1>
<p> <p>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='TiddlyWiki5'> <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki5'>
TiddlyWiki5</a> TiddlyWiki5</a>
is based on a 1,000 line boot kernel that runs on node.js or in the browser, with all other functionality added via dynamically loaded modules.</p> is based on a 1,000 line boot kernel that runs on node.js or in the browser, with all other functionality added via dynamically loaded modules.</p>
<p> <p>
@ -135,7 +137,7 @@ Some plugin modules have further sub-plugins: the wikitext parser, for instance,
<h1 class=''> <h1 class=''>
Plugins and Modules</h1> Plugins and Modules</h1>
<p> <p>
In <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='TiddlyWiki5'> In <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki5'>
TiddlyWiki5</a> TiddlyWiki5</a>
, <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='Plugins'> , <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='Plugins'>
Plugins</a> Plugins</a>
@ -224,7 +226,7 @@ $tw</code>
<em> <em>
This <code> This <code>
readme</code> readme</code>
file was automatically generated by <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='TiddlyWiki5'> file was automatically generated by <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki5'>
TiddlyWiki5</a> TiddlyWiki5</a>
</em> </em>