mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2025-02-24 23:10:02 +00:00
Code Issues Releases Wiki Activity

Docs update

Browse Source
This commit is contained in:
Jeremy Ruston 2013-03-04 14:42:41 +00:00
parent fc79db53ab
commit 5f06d36b86
2 changed files with 103 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
editions/tw5.com/tiddlers/widgets/LinkWidget.tid
View File

@ -1,20 +1,54 @@
title: LinkWidget
tags: docs widget
The `link` widget generates links to tiddlers and external URIs.
The `link` widget generates links to tiddlers and external URIs. Optionally, hovering over a link can trigger the display of another tiddler as a popup.
! Attributes
* ```to``` - link target can be a URL
* ```hover``` - the title of a tiddler to display when hovering over the link
* `to` - link target can be a URL
* `hover` - the title of a tiddler containing the popup state to set when hovering over the link
The `to` attribute is interpreted as an external link if it matches this regular expression:
```
/(?:file|http|https|mailto|ftp|irc|news|data):[^\s'"]+(?:\/|\b)/i
```
! Examples
The `hover` attribute is part of the PopupMechanism.
For example:
```
`$:/MyHover` is {{$:/MyHover}}
<$link to="HelloThere" hover="$:/MyHover">Hover me to see ~HelloThere!</$link>
<$reveal state="$:/MyHover" type="popup">
<div class="tw-drop-down">
{{HelloThere}}
</div>
</$reveal>
```
Renders as:
`$:/MyHover` is {{$:/MyHover}}
<$link to="HelloThere" hover="$:/MyHover">Hover me to see ~HelloThere!</$link>
<$reveal state="$:/MyHover" type="popup">
<div class="tw-drop-down">
{{HelloThere}}
</div>
</$reveal>
! CSS Classes
* ```tw-tiddlylink``` - applied to all links
* ```tw-tiddlylink-external``` - applied to external, non-tiddler links
* ```tw-tiddlylink-internal``` - applied to tiddler links
* ```tw-tiddlylink-missing``` - applied to tiddler links where the target tiddler doesn't exist
* ```tw-tiddlylink-resolves``` - applied to tiddler links when the target tiddler does exist
* `tw-tiddlylink` - applied to all links
* `tw-tiddlylink-external` - applied to external, non-tiddler links
* `tw-tiddlylink-internal` - applied to tiddler links
* `tw-tiddlylink-missing` - applied to tiddler links where the target tiddler doesn't exist
* `tw-tiddlylink-resolves` - applied to tiddler links when the target tiddler does exist
! Configuration macros

122
readme.md
View File

@ -1,67 +1,67 @@
<h1 class=''>
Welcome to <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#TiddlyWiki5'>
TiddlyWiki5</a></h1><div class='tw-transclude'>
Welcome to <span>
TiddlyWiki5</span></h1><div class='tw-transclude'>
<p>
Welcome to <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#TiddlyWiki5'>
TiddlyWiki5</a>, a reboot of <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#TiddlyWiki'>
TiddlyWiki</a>, the reusable non-linear personal web notebook <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#History'>
first released in 2004</a>. It is a complete interactive wiki in <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='http://five.tiddlywiki.com#JavaScript'>
JavaScript</a> that can be run from a single HTML file in the browser or as a powerful <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#node.js'>
node.js application</a>.</p><p>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#TiddlyWiki'>
TiddlyWiki</a> is designed to fit around your brain, giving you a better way of managing information than traditional documents and emails. The fundamental idea is that information is more useful and reusable if we cut it up into the smallest semantically meaningful chunks &ndash; <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#Tiddlers'>
tiddlers</a> &ndash; and give them titles so that they can be structured with links, tags and macros. <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#TiddlyWiki'>
TiddlyWiki</a> aims to provide a fluid interface for working with tiddlers, allowing them to be aggregated and composed into longer narratives.</p><p>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#TiddlyWiki5'>
TiddlyWiki5</a> has many <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#Improvements'>
improvements</a> over the original. It is currently labelled alpha, meaning it is working but incomplete. It is a great time to get involved and support its <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#RoadMap'>
future development</a>. You can:</p><ul>
Welcome to <span>
TiddlyWiki5</span>, a reboot of <span>
TiddlyWiki</span>, the reusable non-linear personal web notebook <span>
first released in 2004</span>. It is a complete interactive wiki in <span>
JavaScript</span> that can be run from a single HTML file in the browser or as a powerful <span>
node.js application</span>.</p><p>
<span>
TiddlyWiki</span> is designed to fit around your brain, giving you a better way of managing information than traditional documents and emails. The fundamental idea is that information is more useful and reusable if we cut it up into the smallest semantically meaningful chunks &ndash; <span>
tiddlers</span> &ndash; and give them titles so that they can be structured with links, tags and macros. <span>
TiddlyWiki</span> aims to provide a fluid interface for working with tiddlers, allowing them to be aggregated and composed into longer narratives.</p><p>
<span>
TiddlyWiki5</span> has many <span>
improvements</span> over the original. It is currently labelled alpha, meaning it is working but incomplete. It is a great time to get involved and support its <span>
future development</span>. You can:</p><ul>
<li>
Explore its features online at <a class='tw-tiddlylink tw-tiddlylink-external' href='http://five.tiddlywiki.com/'>
http://five.tiddlywiki.com/</a></li><li>
Get involved in the <a class='tw-tiddlylink tw-tiddlylink-external' href='https://github.com/Jermolene/TiddlyWiki5'>
development on GitHub</a></li><li>
Join the discussions on <a class='tw-tiddlylink tw-tiddlylink-external' href='http://groups.google.com/group/TiddlyWikiDev'>
the TiddlyWikiDev Google Group</a></li><li>
Follow <a class='tw-tiddlylink tw-tiddlylink-external' href='http://twitter.com/#!/TiddlyWiki'>
@TiddlyWiki on Twitter</a> for the latest news</li><li>
Learn how to <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#HelpingTiddlyWiki'>
help the TiddlyWiki project and community</a></li></ul></div><h1 class=''>
Getting started with <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#TiddlyWiki'>
TiddlyWiki</a> under node.js</h1><div class='tw-transclude'>
Explore its features online at <span>
http://five.tiddlywiki.com/</span></li><li>
Get involved in the <span>
development on GitHub</span></li><li>
Join the discussions on <span>
the TiddlyWikiDev Google Group</span></li><li>
Follow <span>
@TiddlyWiki on Twitter</span> for the latest news</li><li>
Learn how to <span>
help the TiddlyWiki project and community</span></li></ul></div><h1 class=''>
Getting started with <span>
TiddlyWiki</span> under node.js</h1><div class='tw-transclude'>
<p>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#TiddlyWiki5'>
TiddlyWiki5</a> can be used on the command line to perform an extensive set of operations based on tiddlers, <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#TiddlerFiles'>
TiddlerFiles</a> and <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='http://five.tiddlywiki.com#TiddlyWikiFiles'>
TiddlyWikiFiles</a>. For example, this loads the tiddlers from a <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#TiddlyWiki'>
TiddlyWiki</a> HTML file and then saves one of them in HTML:</p><pre>
<span>
TiddlyWiki5</span> can be used on the command line to perform an extensive set of operations based on tiddlers, <span>
TiddlerFiles</span> and <span>
TiddlyWikiFiles</span>. For example, this loads the tiddlers from a <span>
TiddlyWiki</span> HTML file and then saves one of them in HTML:</p><pre>
node tiddlywiki.js --verbose --load mywiki.html --savetiddler ReadMe ./readme.html</pre><h2 class=''>
Usage</h2><p>
Running <code>
tiddlywiki.js</code> from the command line boots the <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#TiddlyWiki'>
TiddlyWiki</a> kernel, loads the core plugins and establishes an empty wiki store. It then sequentially processes the command line arguments from left to right. The arguments are separated with spaces.</p><p>
tiddlywiki.js</code> from the command line boots the <span>
TiddlyWiki</span> kernel, loads the core plugins and establishes an empty wiki store. It then sequentially processes the command line arguments from left to right. The arguments are separated with spaces.</p><p>
The first argument is the optional path to the wiki directory to be loaded. If not present, then the current directory is used.</p><p>
The commands and their individual arguments follow, each command being identified by the prefix <code>
--</code>.</p><pre>
node tiddlywiki.js [&lt;wikipath&gt;] [--&lt;command&gt; [&lt;arg&gt;[,&lt;arg&gt;]]]</pre><h2 class=''>
Batch Files</h2><p>
For trying <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#TiddlyWiki5'>
TiddlyWiki5</a> out under node.js, several batch files are provided:</p><ul>
For trying <span>
TiddlyWiki5</span> out under node.js, several batch files are provided:</p><ul>
<li>
<code>
bld.sh</code> builds the new <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#TiddlyWiki'>
TiddlyWiki</a> 5 HTML file</li><li>
bld.sh</code> builds the new <span>
TiddlyWiki</span> 5 HTML file</li><li>
<code>
2bld.sh</code> builds <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#TiddlyWiki'>
TiddlyWiki</a> 2.6.5 from its original source</li></ul><h2 class=''>
2bld.sh</code> builds <span>
TiddlyWiki</span> 2.6.5 from its original source</li></ul><h2 class=''>
Commands</h2><p>
The following commands are available:</p><div class='tw-list-frame'>
<div class='tw-list-element'>
<span class='tw-transclude'>
<h3 class=''>
<span class='tw-view-link'>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#DumpCommand'>
DumpCommand</a></span></h3><div>
<span>
DumpCommand</span></span></h3><div>
<div class='tw-transclude'>
<h3 class=''>
dump tiddlers</h3><p>
@ -79,12 +79,12 @@ Dump the current core configuration </p><pre>
<span class='tw-transclude'>
<h3 class=''>
<span class='tw-view-link'>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#LoadCommand'>
LoadCommand</a></span></h3><div>
<span>
LoadCommand</span></span></h3><div>
<div class='tw-transclude'>
<p>
Load tiddlers from 2.x.x <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#TiddlyWiki'>
TiddlyWiki</a> files (<code>
Load tiddlers from 2.x.x <span>
TiddlyWiki</span> files (<code>
.html</code>), <code>
.tiddler</code>, <code>
.tid</code>, <code>
@ -93,19 +93,19 @@ TiddlyWiki</a> files (<code>
<span class='tw-transclude'>
<h3 class=''>
<span class='tw-view-link'>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#SaveTiddlerCommand'>
SaveTiddlerCommand</a></span></h3><div>
<span>
SaveTiddlerCommand</span></span></h3><div>
<div class='tw-transclude'>
<p>
Save an individual tiddler as a specified <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='http://five.tiddlywiki.com#ContentType'>
ContentType</a>, defaults to <code>
Save an individual tiddler as a specified <span>
ContentType</span>, defaults to <code>
text/html</code> </p><pre>
--savetiddler &lt;title&gt; &lt;filename&gt; [&lt;type&gt;]</pre></div></div></span></div><div class='tw-list-element'>
<span class='tw-transclude'>
<h3 class=''>
<span class='tw-view-link'>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#ServerCommand'>
ServerCommand</a></span></h3><div>
<span>
ServerCommand</span></span></h3><div>
<div class='tw-transclude'>
<p>
The server is very simple. At the root, it serves a rendering of a specified tiddler. Away from the root, it serves individual tiddlers encoded in JSON, and supports the basic HTTP operations for <code>
@ -129,8 +129,8 @@ servetype</strong> - the content type with which the root tiddler should be serv
<span class='tw-transclude'>
<h3 class=''>
<span class='tw-view-link'>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#VerboseCommand'>
VerboseCommand</a></span></h3><div>
<span>
VerboseCommand</span></span></h3><div>
<div class='tw-transclude'>
<p>
Triggers verbose output, useful for debugging </p><pre>
@ -138,14 +138,14 @@ Triggers verbose output, useful for debugging </p><pre>
<span class='tw-transclude'>
<h3 class=''>
<span class='tw-view-link'>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#VersionCommand'>
VersionCommand</a></span></h3><div>
<span>
VersionCommand</span></span></h3><div>
<div class='tw-transclude'>
<p>
Displays the version number of <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#TiddlyWiki'>
TiddlyWiki</a>.</p><pre>
Displays the version number of <span>
TiddlyWiki</span>.</p><pre>
--version</pre></div></div></span></div></div></div><p>
<em>
This readme file was automatically generated by <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com#TiddlyWiki5'>
TiddlyWiki5</a></em>
This readme file was automatically generated by <span>
TiddlyWiki5</span></em>
</p>