16 changes: 8 additions & 8 deletions editions/de-AT/tiddlers/Willkommen.tid
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,22 @@ tags: InhaltsVerzeichnis Intro
title: Willkommen!
type: text/vnd.tiddlywiki

~TiddlyWiki ist eine Web-Applikation, die sie frei herunterladen können. Sie können sie speichern, wo sie wollen:
~TiddlyWiki ist eine Web-Applikation, die Sie frei herunterladen können. Sie können sie speichern, wo Sie wollen:

* Auf ihrem Laufwerk,
* Auf Ihrem Laufwerk,
* USB-Wechselspeicher
* oder ihrem "Cloud Speicher"
* oder Ihrem "Cloud Speicher"

Sie sind der Herr über ihre Daten!
Sie sind der Herr über Ihre Daten!

Sie können ~TiddlyWiki verwenden um Ihre Notizen zu erstellen / organisieren / oder mit Freunden zu teilen, in einer Weise, die kein anderes Textverarbeitungsprogramm vermag. ~TiddlyWiki speichert ihre Texte in einer "nicht-linearen" Form, mit Hilfe von [[Tags]], [[Hyperlinks]] und vielen weiteren Möglichkeiten. So können sie Ihre Notizen strukturieren, in einer
Sie können ~TiddlyWiki verwenden um Ihre Notizen zu erstellen / organisieren / oder mit Freunden zu teilen, in einer Weise, die kein anderes Textverarbeitungsprogramm vermag. ~TiddlyWiki speichert Ihre Texte in einer "nicht-linearen" Form, mit Hilfe von [[Tags]], [[Hyperlinks]] und vielen weiteren Möglichkeiten. So können Sie Ihre Notizen strukturieren, in einer
Weise, die mehr dem entspricht, "wie wir denken", nicht in einem vom Entwickler vorgegebenen starren Korsett.

Sie können TiddlyWiki als eine einzige Datei speichern, die sie mit dem Web-Browser, online oder offline, verwenden können. Für geübte Benutzer kann ~TiddlyWiki als [[Node.js Applikation|Node.js]] verwendet werden, die jeden [[Tiddler]] als einzelne Datei behandelt und dabei als zentrales Archiv fungiert.
Sie können TiddlyWiki als eine einzige Datei speichern, die Sie mit dem Web-Browser, online oder offline, verwenden können. Für geübte Benutzer kann ~TiddlyWiki als [[Node.js Applikation|Node.js]] verwendet werden, die jeden [[Tiddler]] als einzelne Datei behandelt und dabei als zentrales Archiv fungiert.

!!! Wie können sie ~TiddlyWiki nun für sich nutzen?
!!! Wie können Sie ~TiddlyWiki nun für sich nutzen?

* Im Anschluss sind einige Links aufgeführt, mit denen sie starten sollten, oder sie können jederzeit das InhaltsVerzeichnis verwenden.
* Im Anschluss sind einige Links aufgeführt, mit denen Sie starten sollten, oder Sie können jederzeit das InhaltsVerzeichnis verwenden.

* Das ~InhaltsVerzeichnis kann auch über den Reiter "Inhalt" auf der rechten Seite aufgerufen werden.

Expand Down
6 changes: 3 additions & 3 deletions editions/de-AT/tiddlers/howto/Speichern auf TiddlySpot.tid
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ TiddlySpot ist ein freier Hosting Service von Simon und Daniel Baird. Er ist bei
~TiddlyWiki5 wird momentan noch nicht als Standard Wiki angeboten, Sie können aber folgende Schritte verwenden um ~TiddlyWiki auf ~TiddlySpot zu speichern.

# Erstellen Sie ein Wiki auf http://tiddlyspot.com/ und merken Sie sich den Namen und Ihr Passwort!
# Für Österreich: öffnen Sie http://tiddlywiki.com/languages/de-AT/empty.html in ihrem Browser.
# Für Österreich: öffnen Sie http://tiddlywiki.com/languages/de-AT/empty.html in Ihrem Browser.
#* Für Deutschland: http://tiddlywiki.com/languages/de-DE/empty.html
# Wählen Sie im [[Control Panel|$:/ControlPanel]], den "Speichern" Tab und tragen Sie im "~TiddlySpot" Bereich, den Wiki Namen und das Passwort ein.
# Klicken Sie den "Speichern" Button. Nach einiger Zeit, bekommen Sie rechts oben die Mitteilung "Wiki gespeichert". Das Speichern kann je nach Internetverbindung und Wiki Größe einige Sekunden dauern.
#* //Das Erstellen eines neuen Wikis funktioniert nicht mit Firefox, da die Sicherheitseinstellungen diese Vorgehensweise nicht erlauben. Google Chrome kann verwendet werden. Ein späteres Editieren von tiddlyspot.com ist auch mit Firefox möglich!//
# Gehen Sie nun zu ihrem Wiki: ~http://{wikiname}.tiddlyspot.com/
# Gehen Sie nun zu Ihrem Wiki: ~http://{wikiname}.tiddlyspot.com/
# Beim ersten Besuch müssen Sie eventuell den Wiki-Namen und das Passwort neu eingeben.
# Sie sollten jetzt eine Kopie ihres Wikis sehen. Sie können nun Änderungen vornehmen und mit "Speichern" direkt in "die Cloud" speichern.
# Sie sollten jetzt eine Kopie Ihres Wikis sehen. Sie können nun Änderungen vornehmen und mit "Speichern" direkt in "die Cloud" speichern.
# Die ~TiddlySpot Verwaltungs-Seite ist unter: ~http://{wikiname}.tiddlyspot.com/controlpanel zu finden.

14 changes: 10 additions & 4 deletions editions/de-AT/tiddlers/howto/Speichern mit Chrome.tid
Original file line number Diff line number Diff line change
@@ -1,25 +1,31 @@
created: 20131129092604900
creator: pmario
modified: 20140922125135926
modifier: ChrisK
modified: 20141012120259664
modifier: pmario
tags: howto
title: Speichern mit Chrome
type: text/vnd.tiddlywiki

Diese Methode ist etwas umständlich, da man Einstellungen immer wieder manuell vornehmen muss. Der Vorteil ist, dass diese Methode jedoch mit fast allen Desktop- und vielen mobilen Browsern funktioniert.

!! Video

<iframe width="560" height="315" src="http://www.youtube.com/embed/LcoZ7hQCuFI" frameborder="0" allowfullscreen></iframe>

!! Speichern mit Chrome

# Speichern Sie eine leere Datei der deutschen Version.
#> {{$:/editions/de-AT-DE/snippets/download-empty-button}}
#> Wenn der Button nicht funktioniert, dann klicken Sie den Link mit der rechten Maustaste und wählen: "Ziel Speichern unter ..." http://tiddlywiki.com/languages/de-AT/empty.html oder http://tiddlywiki.com/languages/de-DE/empty.html
#> Je nach Browser folgen Sie den Dialogen!
# Suchen Sie die eben geladene Datei im Datei Manager.
#* Geben Sie der Datei einen vernünftigen Namen und stellen Sie sicher, dass die Endung `.html` oder `.htm` ist.
# Öffnen Sie die Datei mit ihrem Browser.
# Öffnen Sie die Datei mit Ihrem Browser.
# Erstellen Sie einen neuen Tiddler mit dem {{$:/core/images/new-button}} ''plus'' im rechten Menü.
# Geben Sie den Text ein und bestätigen die Eingabe mit dem {{$:/core/images/done-button}} ''OK''.
# Speichern Sie die Änderungen mit: {{$:/core/images/save-button}} ''speichern'' im rechten Menü
# Der Browser wird nun eine neue Datei laden, die die Änderungen enthält.
# Suchen Sie die eben geladene Datei im Datei Manager.
# Überprüfen sie, ob die Änderungen richtig gespeichert wurden.

''Tip'': Die meisten Browser haben eine Einstellung, dass der "Datei Speichern" Dialog immer angezeigt wird. Das ermöglicht ihnen, die bestehende Datei auszuwählen und zu überschreiben.
''Tip'': Die meisten Browser haben eine Einstellung, dass der "Datei Speichern" Dialog immer angezeigt wird. Das ermöglicht Ihnen, die bestehende Datei auszuwählen und zu überschreiben.
2 changes: 1 addition & 1 deletion editions/de-AT/tiddlers/howto/Speichern mit Safari.tid
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Diese Methode ist etwas umständlich, da jeder Schritt manuell gemacht werden mu
#> Ihr Browser kann eventuell nachfragen, ob die Datei gespeichert werden soll.
# Suchen Sie die eben geladene Datei im Datei Manager.
#* Geben Sie der Datei einen vernünftigen Namen und stellen Sie sicher, dass die Endung `.html` oder `.htm` ist.
# Öffnen Sie die Datei mit ihrem Browser.
# Öffnen Sie die Datei mit Ihrem Browser.
# Erstellen Sie einen neuen Tiddler mit dem {{$:/core/images/new-button}} ''plus'' im rechten Menü.
# Geben Sie den Text ein und bestätigen die Eingabe mit dem {{$:/core/images/done-button}} ''OK''.
# Speichern Sie die Änderungen mit: {{$:/core/images/save-button}} ''speichern'' im rechten Menü
Expand Down
11 changes: 9 additions & 2 deletions editions/de-AT/tiddlers/howto/Speichern mit TiddlyFox.tid
Original file line number Diff line number Diff line change
@@ -1,13 +1,20 @@
created: 20131221085742684
creator: pmario
modified: 20140922125640163
modifier: ChrisK
modified: 20141012083445443
modifier: pmario
tags: howto TiddlyFox
title: Speichern mit TiddlyFox
type: text/vnd.tiddlywiki

!! Android

Wenn Sie "Firefox for Android" verwenden, dann beachten sie: [[Speichern mit TiddlyFox - Android]].

!! Video (de)

<iframe width="560" height="315" src="http://www.youtube.com/embed/bsWE7jXPbb0" frameborder="0" allowfullscreen></iframe>

!! Speichern mit TiddlyFox
# Stellen Sie sicher, dass Sie die [[aktuelle Version von Firefox|http://getfirefox.com]] verwenden.
# Installieren Sie die aktuelle TiddlyFox Erweiterung von: https://addons.mozilla.org/en-US/firefox/addon/tiddlyfox/
# Firefox neu starten!
Expand Down
10 changes: 8 additions & 2 deletions editions/de-AT/tiddlers/howto/Speichern mit TiddlyIE.tid
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
created: 20131211220000000
creator: pmario
modified: 20140918102257399
modified: 20141012141931383
modifier: pmario
tags: howto
title: Speichern mit TiddlyIE
type: text/vnd.tiddlywiki

!! Video

<iframe width="560" height="315" src="http://www.youtube.com/embed/OrWuvjs3Ly0" frameborder="0" allowfullscreen></iframe>

!! Speichern mit TiddlyIE

# Installieren Sie TiddlyIE AddOn von:
#* https://github.com/davidjade/TiddlyIE/releases
# Starten Sie Internet Explorer neu. IE wird beim Start einen Dialog anzeigen, mit dem Sie das AddOn freischalten können.
Expand All @@ -14,7 +20,7 @@ type: text/vnd.tiddlywiki
#> http://tiddlywiki.com/languages/de-AT/empty.html oder
#> http://tiddlywiki.com/languages/de-DE/empty.html
# Suchen Sie die eben geladene Datei im Datei Manager.
#* Geben Sie der Datei einen vernünftigen Namen und stellen Sie sicher, dass die Endung `.html` oder `.htm` ist.
#* Geben Sie der Datei einen vernünftigen Namen und stellen Sie sicher, dass die Endung `.html` ist.
# Öffnen Sie die Datei mit dem Internet Explorer
# Erstellen Sie einen neuen Tiddler mit dem {{$:/core/images/new-button}} ''plus'' im rechten Menü.
# Geben Sie den Text ein und bestätigen die Eingabe mit dem {{$:/core/images/done-button}} ''OK''.
Expand Down
8 changes: 6 additions & 2 deletions editions/de-AT/tiddlers/howto/Windows HTA Hack.tid
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
created: 20131212223146250
creator: pmario
modified: 20140922132924816
modifier: ChrisK
modified: 20141012142437720
modifier: pmario
tags: howto
title: Windows HTA Hack
type: text/vnd.tiddlywiki
Expand All @@ -12,4 +12,8 @@ Achtung!
Der Nachteil dieser Änderung ist, dass die Datei im UTF-16 format gespeichert wird, was sie ungefähr doppelt so groß macht.
TW wird standardmäßig im UTF-8 Format gespeichert. Wird die Datei wieder mit einer TW spezifischen Methode gespeichert, dann wird sie wieder kleiner.

Hier ist ein Video von Mario Pietsch, dass den Umgang IE, HTA und TiddlyWiki zeigt.

<iframe width="560" height="315" src="http://www.youtube.com/embed/OrWuvjs3Ly0" frameborder="0" allowfullscreen></iframe>

Siehe Wikipedia (englisch): http://en.wikipedia.org/wiki/HTML_Application
2 changes: 1 addition & 1 deletion editions/de-AT/tiddlers/lexikon/Status Tiddler.tid
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Diese Status Tiddler werden meist mit einem System Prefix versehen, damit sie in

Wenn Sie im rechten Menü den Reiter: "Mehr: System" wählen, dann können Sie Status Tiddler mit den Namen: `$:/state/xxxxxx` sehen.

''Wichtig'': `$:/state/*` Tiddler werden nicht gespeichert. Wenn Sie also den Status ihres `<<tabs>>` Makros speichern wollen, dann verwenden Sie einen anderen Namen. zB: `$:/_state/tabx`
''Wichtig'': `$:/state/*` Tiddler werden nicht gespeichert. Wenn Sie also den Status Ihres `<<tabs>>` Makros speichern wollen, dann verwenden Sie einen anderen Namen. zB: `$:/_state/tabx`

Siehe auch:

Expand Down
1 change: 1 addition & 0 deletions editions/de-AT/tiddlers/makros/ListMacro.tid
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Das "list" Makro erstellt Linklisten von Tiddlern.
|1 |filter |Filter Ausdruck | |
|2 |type |"HTML tag", der als Hülle verwendet werden soll. Möglich sind:<br />"ul" .. "unordered list" oder <br />"ol" .. "ordered list" |"ul" |
|3 |subtype |"HTML tag" der als Listen Element verwendet werden soll. |"li" |
|4 |class |Das Listen Element `<ul>` oder `<ol>` bekommt eine CSS Klasse zugewiesen zB: `<ul class="three-columns">` | |

!! Beispiele

Expand Down
2 changes: 1 addition & 1 deletion editions/de-AT/tiddlers/wikitext/Makros in WikiText.tid
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Rodentville,
Ratland.">>
```

Wenn sie 3 doppelte Anführungszeichen verwenden, dann können die Parameter einfache Anführungszeichen enthalten:
Wenn Sie 3 doppelte Anführungszeichen verwenden, dann können die Parameter einfache Anführungszeichen enthalten:

```
<<meinErstesMakro "Mickey Mouse" """Mouse House,
Expand Down
2 changes: 1 addition & 1 deletion editions/de-AT/tiddlers/wikitext/Tabellen in WikiText.tid
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Dargestellt als (der "Rahmen" ist nötig, um die Ausrichtung mit wenig Text sich
| ::<br>:: |,unten links |, unten mitte |, unten rechts| ::<br>:: |
| :: | ::::::::::::::::::::::::::: | ::::::::::::::::::::::::::: | ::::::::::::::::::::::::::: | :: |

Wenn sie die Zeichen `^` und `,` als erste Zeichen benötigen, dann können sie "HTML escaping" verwenden.
Wenn Sie die Zeichen `^` und `,` als erste Zeichen benötigen, dann können Sie "HTML escaping" verwenden.

| `^` | &amp;#94; |
| `,` | &amp;#44; |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tags: WikiText
title: Typisierte Blöcke in WikiText
type: text/vnd.tiddlywiki

WikiText kann Textblöcke direkt darstellen, wenn Ihr Inhalts-Typ ([[MIME-Type]]) bekannt ist:
WikiText kann Textblöcke direkt darstellen, wenn ihr Inhalts-Typ ([[MIME-Type]]) bekannt ist:

```
$$$image/svg+xml
Expand Down
2 changes: 1 addition & 1 deletion editions/de-AT/tiddlers/wikitext/WikiText.tid
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tags: Konzept Referenz InhaltsVerzeichnis
title: WikiText
type: text/vnd.tiddlywiki

~WikiText ist eine Auszeichnungssprache, die es erlaubt, auf einfache Weise Texte und ihre Formatierung in Textform einzugeben. Das erlaubt es ihnen, sich auf das Schreiben zu konzentrieren und nicht auf eine komplexe Oberfläche, die vom Wesentlichen ablenkt. Für Anwender, die bereits MarkDown kennen, sollte es relativ leicht sein, sich in ~WikiText einzuarbeiten. WikiText bietet mehr Möglichkeiten zum Verlinken und zur Erstellung von interaktiven Inhalten.
~WikiText ist eine Auszeichnungssprache, die es erlaubt, auf einfache Weise Texte und ihre Formatierung in Textform einzugeben. Das erlaubt es Ihnen, sich auf das Schreiben zu konzentrieren und nicht auf eine komplexe Oberfläche, die vom Wesentlichen ablenkt. Für Anwender, die bereits MarkDown kennen, sollte es relativ leicht sein, sich in ~WikiText einzuarbeiten. WikiText bietet mehr Möglichkeiten zum Verlinken und zur Erstellung von interaktiven Inhalten.

Die folgenden Elemente sind im TW Kern enthalten:

Expand Down
2 changes: 1 addition & 1 deletion editions/de-AT/tiddlers/wikitext/Zitate in WikiText.tid
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Das Ergebnis wird zusammenhängend dargestellt.

!! Zitat mit Autor

Wenn sie den Autor anführen möchten, dann schreiben sie wie folgt:
Wenn Sie den Autor anführen möchten, dann schreiben Sie wie folgt:

<<wikitext-example src:"<<<
Computers are like a bicycle for our minds
Expand Down
3 changes: 3 additions & 0 deletions editions/dev/tiddlers/HelloThere.tid
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ Welcome to the developer documentation for TiddlyWiki (http://tiddlywiki.com/).
** [[TiddlyWiki on node-webkit]]
** [[package.json for node-webkit]]
** [[How to create plugins in the browser]]
** [[Contributing to the TiddlyWiki Core]]
** [[Contributing to the TiddlyWiki Plugin Library]]
** [[Scripts for building tiddlywiki.com]]
** SyncAdaptorModules
** WidgetModules
** WikiRuleModules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
title: ReadMe for build.jermolene.github.io

{{Scripts for building tiddlywiki.com}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
title: Releasing a new version of TiddlyWiki

# Move the latest release note from the prerelease edition into the tw5.com edition
# Adjust the release date of the latest release tiddler (eg, [[Release 5.1.3]])
# Ensure [[Releases]] has the new version as the default tab
# Adjust the modified time of HelloThere
# Make sure ''Jermolene/TiddlyWiki5'' is fully committed
# Edit `package.json` to the new version number
# Run `../build.jermolene.github.io/readme-bld.sh` to build the readme files
# Commit the new readme files in `TiddlyWiki5`
# Restore `package.json` to the previous version number
# Run `../build.jermolene.github.io/verbump "5.1.3"` (substituting the correct version number) to update the version number, assign it a tag
# Run `../build.jermolene.github.io/npm-publish.sh` to publish the release to npm
# Update the `package.json` for `build.jermolene.github.io` to the new version
# Verify that the new release of TiddlyWiki is available at https://www.npmjs.org/package/tiddlywiki
# Check the version number of TiddlyWiki specified in `build.jermolene.github.io/package.json` is the latest version
# Change current directory to the `build.jermolene.github.io` directory
# Run `npm install` to install the correct version of TiddlyWiki
# Change current directory to the `TiddlyWiki5` directory
# Run `../build.jermolene.github.io/bld.sh` to build the content files
# Verify that the files in the `jermolene.github.io` directory are correct
# Run `../build.jermolene.github.io/github-push.sh` to push the new files to GitHub
# Run `../build.jermolene.github.io/tiddlyspace-upload.sh <username> <password>` to upload the release to TiddlySpace
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
title: Releasing new content for TiddlyWiki

# Change current directory to the `TiddlyWiki5` directory
# Run `../build.jermolene.github.io/bld.sh` to build the content files
# Run `../build.jermolene.github.io/readme-bld.sh` to build the readmes
# Commit the readmes to `TiddlyWiki5` and `build.jermolene.github.io` if necessary
# Verify that the files in the `jermolene.github.io` directory are correct
# Run `../build.jermolene.github.io/github-push.sh` to push the new files to GitHub
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
title: Scripts for building tiddlywiki.com

These scripts are used to build and release the content for tiddlywiki.com. They are not designed for general purpose use -- they resolve problems that are specific to the task of building tiddlywiki.com: pushing to GitHub Pages, handling the prerelease builds and bumping version numbers.

Nonetheless, you may find techniques that are useful for your own scripts.

! Hosting

http://tiddlywiki.com is served by [[GitHub Pages|https://pages.github.com]] from the repository https://github.com/Jermolene/jermolene.github.io

The scripts live in the repository https://github.com/Jermolene/build.jermolene.github.io

! Directory structure

These scripts require the following directories to be siblings:

* `build.jermolene.github.io` - a local copy of https://github.com/Jermolene/build.jermolene.github.io
* `jermolene.github.io` - a local copy of the repo https://github.com/Jermolene/jermolene.github.io
* `TiddlyWiki5` - a local copy of the repo https://github.com/Jermolene/TiddlyWiki5

The scripts are designed to be executed with the current directory being the `TiddlyWiki5` directory.

! Configuration

!! package.json

The `package.json` in the root of the `build.jermolene.github.io` repository contains a dependency declaration that specifies the latest official released version of TiddlyWiki to be used when building the release targets:

```

"dependencies": {
"tiddlywiki": "5.1.2"
}
```

!! Environment variables

Some of the scripts use the following environment variables:

* ''TW5_BUILD_MAIN_EDITION'' - the path to the wiki folder to be used as the main edition, generating `index.html` and `encrypted.html`
* ''TW5_BUILD_OUTPUT'' - the path to the output folder (defaults to `../jermolene.github.io`)
* ''TW5_BUILD_TIDDLYWIKI'' - the pathname of the `tiddlywiki.js` to be used (defaults to `../build.jermolene.github.io/node_modules/tiddlywiki/tiddlywiki.js`)

! Scripts

!! `bld.sh`

Builds the `tiddlywiki.com` target files. By default, it uses the version of tiddlywiki specified in the `package.json` file. This can be overridden with the ''TW5_BUILD_TIDDLYWIKI'' environment variable. The following command would select the latest prerelease version of tiddlywiki from the `TiddlyWiki5` directory:

```
TW5_BUILD_TIDDLYWIKI=./tiddlywiki.js
```

!! `readme-bld.sh`

Builds the readme files for the `TiddlyWiki5` and `build.jermolene.github.io` repos using the released version of TiddlyWiki specified in `package.json`.

!! `prerelease-bld.sh`

Builds the `tiddlywiki.com/prerelease` target files using the latest TiddlyWiki prerelease code and special ''prerelease'' edition for the content.

!! `github-push.sh`

Pushes the latest changes to the `jermolene.github.io` directory to GitHub.

!! `dev-bld.sh`

Builds the ''dev'' prerelease edition.

!! `quick-bld.sh`

Builds the ''prerelease'' prerelease edition.

!! `tiddlyspace-upload.sh`

Builds the ''tw5tiddlyweb'' edition and uploads it to TiddlySpace.

!! `verbump.sh`

Bumps the version number of the `package.json` in the `TiddlyWiki5` repo and applies the correct version tag to the repo.

!! `npm-publish.sh`

Publishes the `TiddlyWiki5` repo to npm.

! Procedures

!! Releasing a new version of TiddlyWiki

{{Releasing a new version of TiddlyWiki}}

!! Releasing new content for TiddlyWiki

{{Releasing new content for TiddlyWiki}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
created: 20141016083308219
modified: 20141016083333808
title: Contributing to the TiddlyWiki Core
type: text/vnd.tiddlywiki

The TiddlyWiki core is the container for all the generic features of TiddlyWiki that are of universal utility. Concretely, it comprises the tiddlers in the `$:/core` plugin.

! Core Contribution Requirements

There are requirements that must be met for any contribution that is to be accepted into the core:

* If appropriate, the new functionality must support both standalone and Node.js configurations. For example, any new widgets must be capable of being rendered on the server
* The contribution must not compromise the backwards compatibility of the existing code
* Code contributions must comply with the [[TiddlyWiki Coding Style Guidelines]]
* Generic components are preferred over point solutions for specific problems (which belong in plugins)

! The Core and Innovation

If you've created something new and innovative, don't try to rush to get it included into the core. Once new stuff is in the core it is subject to the core policies of strict backwards compatibility, making it frozen as far as radical innovation is concerned. It's usually better to release the new thing as a plugin so that it can be shared with the rest of the community for feedback.

The expected model of innovation is that the core development will move relatively slowly as more and more of the initial planned functionality is implemented. Innovation can take place in the much more unconstrained environment of plugins. Over time, as these third party plugins gain popularity and become more polished, some or all of their functionality will be migrated into the core.

Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
created: 20141016083308219
modified: 20141016083333808
title: Contributing to the TiddlyWiki Plugin Library
type: text/vnd.tiddlywiki

The TiddlyWiki Plugin library is the set of plugins, themes and languages that are distributed via http://tiddlywiki.com.

The plugin library is intended to help end users of TiddlyWiki in the following ways:

* By being a reliable, official source of community assets
* Permitting automatic upgrading of plugins during the upgrade process
* Providing a guarantee of backwards compatibility

Plugins in the library need a maintainer who is prepared to make a commitment to keep them tested and fully operational with successive releases of the core code. Many plugins are maintained by the core team.
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ For example files see the plugins in the tiddlywiki5 repository i.e. those locat

Modify editions/tw5.com/tiddlywiki.info to include a reference to your plugin directory, i.e. find `"plugins": [ ` and add `"yourname/pluginname"`.

From the TW5 directory issue command
From the TW5 directory issue the command

```
./bin/qbld.sh
Expand Down
8 changes: 8 additions & 0 deletions editions/dev/tiddlers/from tw5.com/FakeDomMechanism.tid
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
title: FakeDomMechanism
modified: 20141019122342995

The "fake DOM" is a simplified JavaScript implementation of the DOM that can be run on the server. Its use allows modules that need to run under Node.js to generate and manipulate HTML through the DOM API, rather than having to stitch HTML strings together.

The fake DOM only implements a small subset of the full DOM APIs but it is sufficient for the core widgets to be able to be run under Node.js.

Because the fake DOM is faster than the real DOM, it is also used in the browser when interactive rendering to the DOM isn't needed. The best example is stylesheet processing, where WikiText stylesheet content is parsed and rendered, and the plain text extracted from the fake DOM for use as the stylesheet content.
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ type: text/vnd.tiddlywiki
# Copy the contents of `<repo>/core/language/en-GB` into your translation folder
# Create a `plugin.info` file (see below) in your translation folder
# Edit `<repo>/editions/tw5.com/tiddlywiki.info` to add your language to the list
# Run `./bin/qbld.sh` to build TiddlyWiki
# Run `../build.jermolene.github.io/quick-bld.sh` to build TiddlyWiki
# Open the TiddlyWiki file at `/MyTranslation/jermolene.github.com/index.html`
# You should see your translation listed in the control panel, but the text of the translation will still be in British English
# Edit the `.tid` and `.multids` files in your language folder to translate the English text
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
title: How to customise the password prompt
tags: howto
created: 20141006085526118
modified: 20141006085526118

You can customise the text and appearance of the password prompt that is displayed when encrypted TiddlyWiki files are first opened.

To do so, create a tiddler tagged {{$:/core/wiki/rawmarkup|$:/core/ui/TagTemplate}} containing:

# A JavaScript `<script>` tag containing code to override the configuration variable `$tw.boot.encryptionPrompts.decrypt`
# CSS `<style>` definitions targeting the `tc-password-wrapper` class to apply styles to the form

Raw markup tiddlers are spliced into the top of the standalone HTML file, and are executed before the boot prefix and boot kernel.

See $:/PathEncryptionPrompt for an example.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
modified: 20141016083333808
title: TiddlyWiki Coding Style Guidelines
tags: dev

Expand All @@ -7,6 +8,8 @@ TiddlyWiki is a large project with many interested parties. It benefits everyone

! Guidelines

This list of guidelines isn't exhaustive but captures some of the common problems. The ultimate guide is the existing TiddlyWiki code-base. There are still some places where the coding guidelines aren't used consistently within the core; pull requests are welcome to help resolve those issues.

!! Tabs and whitespace

TiddlyWiki uses 4-character tabs for indenting.
Expand Down
33 changes: 33 additions & 0 deletions editions/dev/tiddlers/system/PatchEncryptionPrompt.tid
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
title: $:/PatchEncryptionPrompt
tags: $:/core/wiki/rawmarkup

<script>

window.$tw = window.$tw || Object.create(null);
$tw.boot = $tw.boot || Object.create(null);

$tw.boot.encryptionPrompts = {
decrypt: "Decrypt this TiddlyWiki by entering the password"
};

</script>
<style>

body .tc-password-wrapper {
background-color: rgb(183, 197, 235);
border: 8px solid rgb(152, 164, 197);
}

body .tc-password-wrapper form {
text-align: center;
}

body .tc-password-wrapper h1 {
padding-bottom: 8px;
}

body .tc-password-wrapper input {
width: auto;
}

</style>
2 changes: 2 additions & 0 deletions editions/dev/tiddlywiki.info
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@
"--setfield","[tag[external-image]]","_canonical_uri","$:/core/templates/canonical-uri-external-image","text/plain",
"--setfield","[tag[external-image]]","text","","text/plain",
"--rendertiddler","$:/core/save/all","index.html","text/plain"],
"build-readme": [
"--rendertiddler","ReadMe for build.jermolene.github.io","readme.md","text/html"],
"favicon": [
"--savetiddler","$:/favicon.ico","favicon.ico"],
"static": [
Expand Down
4 changes: 1 addition & 3 deletions editions/katexdemo/tiddlers/HelloThere.tid
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@ title: HelloThere

This is a TiddlyWiki plugin for mathematical typesetting based on KaTeX from Khan Academy.

It is completely self-contained, and doesn't need an Internet connection in order to work.

//This first version of the plugin cannot be used to generate static content under Node.js, but that capability will come in a future update. (Note that you can still use it when running the client-server configuration under Node.js).//
It is completely self-contained, and doesn't need an Internet connection in order to work. It works both in the browser and under Node.js.

! Installation

Expand Down
7 changes: 6 additions & 1 deletion editions/katexdemo/tiddlywiki.info
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@
],
"build": {
"index": [
"--rendertiddler","$:/core/save/all","katexdemo.html","text/plain"]
"--rendertiddler","$:/core/save/all","katexdemo.html","text/plain"],
"static": [
"--rendertiddler","$:/core/templates/static.template.html","static.html","text/plain",
"--rendertiddler","$:/core/templates/alltiddlers.template.html","alltiddlers.html","text/plain",
"--rendertiddlers","[!is[system]]","$:/core/templates/static.tiddler.html","static","text/plain",
"--rendertiddler","$:/core/templates/static.template.css","static/static.css","text/plain"]
}
}
10 changes: 10 additions & 0 deletions editions/prerelease/tiddlers/system/DefaultTiddlers.tid
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
created: 20131127215321439
modified: 20140912135951542
title: $:/DefaultTiddlers
type: text/vnd.tiddlywiki

[[TiddlyWiki Pre-release]]
[tag[ReleaseNotes]!has[released]]
HelloThere
GettingStarted
Community
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
title: $:/GoogleAnalyticsAccount

UA-32839735-1
3 changes: 3 additions & 0 deletions editions/prerelease/tiddlers/system/GoogleAnalyticsDomain.tid
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
title: $:/GoogleAnalyticsDomain

tiddlywiki.com
3 changes: 3 additions & 0 deletions editions/prerelease/tiddlers/system/SiteSubtitle.tid
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
title: $:/SiteSubtitle

<<version>>
6 changes: 6 additions & 0 deletions editions/prerelease/tiddlers/system/SiteTitle.tid
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
created: 20131211131022562
modified: 20131211131023829
title: $:/SiteTitle
type: text/vnd.tiddlywiki

TiddlyWiki Pre-release
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
title: TiddlyWiki Pre-release
modified: 20141013204930183

This is a pre-release build of TiddlyWiki.

It is provided for testing purposes. Please don't try to use it for anything important -- you should use the latest official release from http://tiddlywiki.com.
34 changes: 34 additions & 0 deletions editions/prerelease/tiddlywiki.info
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"plugins": [
"tiddlywiki/cecily",
"tiddlywiki/googleanalytics",
"tiddlywiki/nodewebkitsaver",
"tiddlywiki/github-fork-ribbon",
"tiddlywiki/browser-sniff"
],
"themes": [
"tiddlywiki/vanilla",
"tiddlywiki/snowwhite",
"tiddlywiki/nighttime",
"tiddlywiki/starlight",
"tiddlywiki/seamless",
"tiddlywiki/stickytitles",
"tiddlywiki/centralised",
"tiddlywiki/readonly"
],
"languages": [
"en-US",
"en-GB",
"de-AT",
"de-DE",
"fr-FR",
"zh-Hans",
"zh-Hant",
"it-IT",
"ja-JP",
"ru-RU"
],
"includeWikis": [
"../tw5.com"
]
}
5 changes: 0 additions & 5 deletions editions/tw2/readme.md

This file was deleted.

8 changes: 0 additions & 8 deletions editions/tw5.com/tiddlers/TableOfContentsInProcess

This file was deleted.

5 changes: 4 additions & 1 deletion editions/tw5.com/tiddlers/about/History of TiddlyWiki.tid
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,7 @@ I worked on new release of TiddlyWiki from November 2011. As a programmer, worki

! The Future

Now that TiddlyWiki5 has finally left "beta" status behind, my hope is that it will have a long life. Because it only uses standard features of HTML5 and Node.js, there is no reason why it cannot be fully operational for many years to come. My goal is for it last for at least 25 years.
Now that TiddlyWiki5 has finally left "beta" status behind, my hope is that it will have a long life. Because it only uses standard features of HTML5 and Node.js, there is no reason why it cannot be fully operational for many years to come. My goal is for it to last for at least 25 years.

//Jeremy Ruston, 20th September 2014//

6 changes: 6 additions & 0 deletions editions/tw5.com/tiddlers/community/Contributing.tid
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ Like other OpenSource projects, TiddlyWiki5 needs a signed contributor license a

Create a GitHub pull request to add your name to `cla-individual.md` or `cla-entity.md`, with the date in the format (YYYY/MM/DD).

''step by step''

# click [[licenses/CLA-individual|https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-individual.md]] or [[licenses/CLA-entity|https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-entity.md]]
# in `cla-individual.md` or `cla-entity.md` click icon on the top-right corner (clicking this button will fork the project so you can edit the file)
# add your name at the bottom

eg: `Jeremy Ruston, @Jermolene, 2011/11/22`

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ The TiddlyWiki community holds regular Google Hangouts, usually every Tuesday fr

Past Hangouts are archived in this YouTube playlist:

<iframe width="560" height="315" src="//www.youtube.com/embed/videoseries?list=PLVT_2PPd-1p34gGCQ5qpwC8QdykxVAI3u" frameborder="0" allowfullscreen></iframe>
<iframe width="560" height="315" src="http://www.youtube.com/embed/videoseries?list=PLVT_2PPd-1p34gGCQ5qpwC8QdykxVAI3u" frameborder="0" allowfullscreen></iframe>
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
created: 20141020072708790
modified: 20141020072708790
tags: Resources
title: "TiddlyWiki5 Bourbon" by mkt_memory
type: text/vnd.tiddlywiki
url: http://bacchus.ivory.ne.jp/bourbon/

An extensive collection of tips and resources for users of TiddlyWiki in Japanese.

<<<
TiddlyWikiをHTML5にしたTiddlyWiki5が正式にリリースされました。このTiddlyWiki5の使い方について、自分で試した機能を中心に解説します。

TiddlyWiki5は、非常に多機能なローカルWikiです。このブログに書いてあることは、TiddlyWiki5で出来ることのごく一部です。
<<<

Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
created: 20141009170239174
modified: 20141009170711343
tags: Resources
title: "TiddlyWiki5^2 documenting while learning TiddlyWiki5" by Iannis Zannos
type: text/vnd.tiddlywiki
url: http://larigot.avarts.ionio.gr/users/iani/wikis/tw5square.html

A wealth of hints, tips and notes about using [[TiddlyWiki on Node.js]]:

<<<
TiddlyWiki is different from other wikis because of its principle of dynamically customizeable "storyline" based on tiddlers as basic units of information. That is, the user "composes" their own version of the webpage by clicking on tiddler links, which add tiddlers to the page in order to compose a storyline.

The Node.js implementation in TiddlyWiki5 adds all the advantages of flat-file markup language based type of site. This makes TiddlyWiki an excellent alternative to flat-file based CMS/webpage/blog authoring systems for the web.

Also very cool is the treatment of tags as menus everywhere.
<<<
6 changes: 3 additions & 3 deletions editions/tw5.com/tiddlers/concepts/CurrentTiddler.tid
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
created: 20130825144900000
modified: 20140107114307809
modified: 20141012154500719
tags: Concepts
title: CurrentTiddler
type: text/vnd.tiddlywiki

The CurrentTiddler is the current tiddler during WikiText processing. A context tiddler is set by the TiddlerWidget. It allows you to write references like `<$view field="title" format="link"/>` in TemplateTiddlers without explicitly specifying the tiddler that it applies to.
The CurrentTiddler is the current tiddler during WikiText rendering. It is usually set by the TiddlerWidget. It allows you to write references like `<$view field="title"/>` in TemplateTiddlers without explicitly specifying the tiddler that it applies to.

The title of the current tiddler is contained in the widget variable ''currentTiddler''.
The title of the current tiddler is contained in the [[WidgetVariable: currentTiddler]].
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/concepts/Macros.tid
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Macros are snippets of text that can be inserted with a concise shortcut:
<<myMacro>>
```

You can write your own [[Macros in WikiText]] or for more flexibility you can write [[JavaScript Macros]].
You can write your own [[Macros in WikiText]] or for more flexibility you can write [[JavaScript Macros|http://tiddlywiki.com/dev/index.html#JavaScript%20Macros]].

The following macros are built-in to the TiddlyWiki core:

Expand Down
4 changes: 3 additions & 1 deletion editions/tw5.com/tiddlers/concepts/TiddlyWikiFolders.tid
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
created: 20130825214200000
modified: 20140912141727308
modified: 20141013204930183
tags: [[TiddlyWiki on Node.js]]
title: TiddlyWikiFolders
type: text/vnd.tiddlywiki
Expand Down Expand Up @@ -27,6 +27,8 @@ The `tiddlywiki.info` file in a wiki folder contains a JSON object comprising th
* ''build'' - a hashmap of named build targets, each defined by an array of command tokens (see BuildCommand)
* ''config'' - an optional hashmap of configuration options (see below)

Note that the build targets of included wikis are merged if a target of that name isn't defined in the current `tiddlywiki.info` file.

Configuration options include:

* ''default-tiddler-location'' - a string path to the default location for the filesystem adaptor to save new tiddlers (resolved relative to the wiki folder)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
title: Caruso - Ave Maria
type: audio/mp3
_canonical_uri: https://archive.org/download/Caruso_part1/Caruso-AveMaria.mp3
Binary file not shown.
2 changes: 2 additions & 0 deletions editions/tw5.com/tiddlers/demonstrations/TiddlyWiki.mp3.meta
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
title: TiddlyWiki.mp3
type: audio/mp3
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/features/Searching.tid
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ To the right of the search box, when there are no search results displayed below

* The ''shadows'' tab allows you to limit your search to shadow tiddlers.

* The ''filter'' tab is not a search box, per se, but a way to obtain a list of all tiddlers that meet the specific criteria described by that filter, for example, "All tags except system tags".
* The ''filter'' tab is not a search box, per se, but a way to obtain a list of all tiddlers that meet the specific criteria described by that filter, for example, "All tags except system tags". More information in [[Introduction to Filters]].
14 changes: 14 additions & 0 deletions editions/tw5.com/tiddlers/fileformats/TiddlerFiles.tid
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,17 @@ These files are a straightforward array of hashmaps of name:value fields. Curren
!! TiddlyWiki HTML files

TiddlyWiki HTML files contain a collection of tiddlers encoded in `<DIV>` format.

The minimal requirement for an HTML file to be importable as an unencrypted TW file is that it has a `<div id="storeArea">` immediately preceding the tiddler DIVs, which must be followed by a `</div>`. For example:

```
<div id="storeArea">
<div created="20130302085406905" modified="20130302084548184" tags="Examples" title="A tiddler title">
<pre>HTML encoded text of tiddler
</pre>
</div>
<div created="20140315085406905" modified="20140321084548184" tags="One Two [[Three with Space]]" title="Another title" customfield="field value">
<pre>Text of this tiddler
</pre>
</div>
```
15 changes: 15 additions & 0 deletions editions/tw5.com/tiddlers/filters/FilterOperator addprefix.tid
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
created: 20140410103123179
modified: 20140410103123179
tags: Filters
caption: addprefix
title: FilterOperator: addprefix
type: text/vnd.tiddlywiki

The ''addprefix'' filter operator add a prefix to all titles in the current list.

For example:

|!Filter String |!Description |
|`one two three +[addprefix[tid-]]` |Returns `tid-one`, `tid-two`, `tid-three` |

See also [[FilterOperator: prefix]], [[FilterOperator: suffix]], [[FilterOperator: addsuffix]], [[FilterOperator: removeprefix]] and [[FilterOperator: removesuffix]].
15 changes: 15 additions & 0 deletions editions/tw5.com/tiddlers/filters/FilterOperator addsuffix.tid
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
created: 20140828133830424
modified: 20140902145613329
tags: Filters
caption: addsuffix
title: FilterOperator: addsuffix
type: text/vnd.tiddlywiki

The ''addsuffix'' filter operator adds a suffix to all titles in the current list.

For example:

|!Filter String |!Description |
|`one two three +[addsuffix[-tid]]` |Returns `one-tid`, `two-tid`, `three-tid` |

See also [[FilterOperator: suffix]], [[FilterOperator: prefix]], [[FilterOperator: addprefix]], [[FilterOperator: removesuffix]], and [[FilterOperator: removeprefix]].
3 changes: 2 additions & 1 deletion editions/tw5.com/tiddlers/filters/FilterOperator fields.tid
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
caption: fields
created: 20140924115616653
modified: 20140924115627781
modified: 20141002150019737
tags: Filters
title: FilterOperator: fields
type: text/vnd.tiddlywiki
Expand Down
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/filters/FilterOperator list.tid
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ caption: list
title: FilterOperator: list
type: text/vnd.tiddlywiki

The ''list'' filter operator replaces the current list with the list contained in the [[TextReference|TextReferences]] specified in the operand. The default field for the text reference is `list`.
The ''list'' filter operator replaces the current list with the list contained in the TextReference specified in the operand. The default field for the text reference is `list`.

Preceding the operator name with `!` inverts the logic so that the filter only returns the tiddlers in the current list that are not listed in the specified list.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ For example:
|`[tag[task]!prefix[hidden]]` |Returns tiddlers tagged `task` whose titles do not start with `hidden` |
|`[prefix[$:/]]` |Equivalent to `[is[system]]` |

See also [[FilterOperator: removeprefix]], [[FilterOperator: removesuffix]] and [[FilterOperator: removesuffix]].
See also [[FilterOperator: removeprefix]], [[FilterOperator: removesuffix]], [[FilterOperator: removesuffix]], [[FilterOperator: addprefix]], and [[FilterOperator: addsuffix]].
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ For example:
|!Filter String |!Description |
|`tid-one tid-two three +[removeprefix[tid-]]` |Returns `one`, `two` |

See also [[FilterOperator: prefix]], [[FilterOperator: suffix]] and [[FilterOperator: removesuffix]].
See also [[FilterOperator: prefix]], [[FilterOperator: suffix]], [[FilterOperator: removesuffix]], [[FilterOperator: addprefix]], and [[FilterOperator: addsuffix]].
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ For example:
|!Filter String |!Description |
|`one-tid two-tid three +[removesuffix[-tid]]` |Returns `one`, `two` |

See also [[FilterOperator: suffix]], [[FilterOperator: prefix]] and [[FilterOperator: removeprefix]].
See also [[FilterOperator: suffix]], [[FilterOperator: prefix]], [[FilterOperator: removeprefix]], [[FilterOperator: addprefix]], and [[FilterOperator: addsuffix]].
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ For example:
|`[tag[task]!suffix[hidden]]` |Returns tiddlers tagged `task` whose titles do not end with `hidden` |
|`[suffix[.jpg]]` |Returns tiddlers whose titles end with `.jpg` |

See also [[FilterOperator: removesuffix]], [[FilterOperator: prefix]] and [[FilterOperator: removeprefix]].
See also [[FilterOperator: removesuffix]], [[FilterOperator: prefix]], [[FilterOperator: removeprefix]], [[FilterOperator: addprefix]], and [[FilterOperator: addsuffix]].
7 changes: 2 additions & 5 deletions editions/tw5.com/tiddlers/filters/FilterOperators.tid
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
created: 20140410103123179
modified: 20140410103123179
modified: 20141007213204936
tags: Concepts
title: FilterOperators
type: text/vnd.tiddlywiki

\define bulletList(filter)
<ul><$list filter="$filter$"><li><$link to={{!!title}}><$view field="title"/></$link></li></$list></ul>
\end
Filter operators are the individual elements of [[filters|Filters]]. See [[Introduction to Filters]] for details.

The full list of available filter operators is:

<<bulletList "[tag[Filters]]">>
<<list-links "[tag[Filters]]">>
22 changes: 20 additions & 2 deletions editions/tw5.com/tiddlers/filters/Introduction to Filters.tid
Original file line number Diff line number Diff line change
@@ -1,12 +1,24 @@
created: 20140410101941871
modified: 20140919160749349
modified: 20141009180223576
tags: Learning
title: Introduction to Filters
type: text/vnd.tiddlywiki

A step by step introduction to how [[Filters]] are used.

You can experiment with tiddler filters by typing them into the "Filter" tab of the [[advanced search panel|$:/AdvancedSearch]].
! Using Filters

Filters are a special language within WikiText for expressing lists of tiddlers.

Filters are used in the ListMacro, TabsMacro, ListWidget, CountWidget, and many other areas of TiddlyWiki.

For example, this is how the ListMacro would be used to display the first example below:

```
<<list-links "HelloThere Introduction [[Title with Spaces]]">>
```

The easiest way to experiment with tiddler filters is by typing them into the "Filter" tab of the [[advanced search panel|$:/AdvancedSearch]].

! Simple Filters

Expand Down Expand Up @@ -87,6 +99,12 @@ You can use multiple filter operations at once. This example selects all tiddler

Each separate operator is processed in turn, accumulating the tiddlers that they select.

Here's an example that returns tiddlers tagged ''alpha'' or ''beta'' that are also tagged ''task'' and not tagged ''done'':

```
[tag[alpha]] [tag[beta]] +[tag[task]!tag[done]]
```

! ANDing Multiple Filter Operators

A sequence of operators can be logically ANDed together by bashing them together and merging the outer square brackets. This is called a "run" of operations. For example, here we select tiddlers that are tagged "introduction" and also tagged "demo":
Expand Down
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/hellothere/HelloThere.tid
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
created: 20130822170200000
list: [[Discover TiddlyWiki]] [[Some of the things you can do with TiddlyWiki]] [[Ten reasons to switch to TiddlyWiki]] Examples [[What happened to the original TiddlyWiki?]]
modified: 20140927162659979
modified: 20141020171015200
tags: TableOfContents
title: HelloThere
type: text/vnd.tiddlywiki
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
created: 20130828190200000
modified: 20140912141647843
modified: 20141013085608911
tags: [[TiddlyWiki on Node.js]]
title: Generating Static Sites with TiddlyWiki
type: text/vnd.tiddlywiki
Expand All @@ -12,23 +12,24 @@ There is much flexibility in how the static HTML is generated. The following sce

You can explore a static representation of this TiddlyWiki at <a href="static.html">static.html</a>. That file is a static snapshot of the current DefaultTiddlers. Any tiddlers that it links to are referred to via URLs of the form `/static/HelloThere.html` that point to static snapshots of individual tiddlers. The tiddler HTML files reference a `static.css` stylesheet file.

The included `bin/bld.sh` script includes these commands that are involved in generating the sample static version of the TiddlyWiki5 site:
The following commands are used to generate the sample static version of the TiddlyWiki5 site:

```
--rendertiddler $:/core/templates/static.template.html $TW5_BUILD_OUTPUT/static.html text/plain \
--rendertiddler $:/core/templates/static.template.css $TW5_BUILD_OUTPUT/static/static.css text/plain \
--rendertiddlers [!is[system]] $:/core/templates/static.tiddler.html $TW5_BUILD_OUTPUT/static text/plain \
--rendertiddler $:/core/templates/static.template.html static.html text/plain
--rendertiddler $:/core/templates/static.template.css static/static.css text/plain
--rendertiddlers [!is[system]] $:/core/templates/static.tiddler.html static text/plain
```
The first RenderTiddlerCommand saves the static version of the DefaultTiddlers, the second saves the stylesheet, and the final RenderTiddlersCommand generates the HTML representations of individual tiddlers.

The first RenderTiddlerCommand saves the static version of the DefaultTiddlers, the second saves the stylesheet, and the final RenderTiddlersCommand generates the HTML representations of individual tiddlers. (All the files are placed in the `output` folder of the wiki folder).

! Wiki Snapshot with Internal Links

It is also possible to produce a single HTML file that contains static representations of tiddlers, and uses standard HTML anchor links to jump between them.

For example: <a href="alltiddlers.html">alltiddlers.html</a>

The example is built by the following line in `bin/bld.sh`:
The example is built by the following commands:

```
--rendertiddler $:/core/templates/alltiddlers.template.html $TW5_BUILD_OUTPUT/alltiddlers.html text/plain \
--rendertiddler $:/core/templates/alltiddlers.template.html alltiddlers.html text/plain
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
created: 20141001132300000
modified: 20141001132300000
tags: Learning
title: How to apply custom styles by tag
type: text/vnd.tiddlywiki

You can apply custom styles to tiddlers that have a particular tag by defining a CSS class with the name `tc-tagged-<Tag Name>`.

For example, to make tiddlers tagged "NightReader" appear in a special colour scheme suitable for night-time reading, [[create a stylesheet|Using Stylesheets]] defining the class `tc-tagged-NightReader` like this:

```
.tc-tagged-NightReader {
background-color:black;
color: orange;
padding: 35px 35px;
}

.tc-tagged-NightReader .tc-tiddler-body {
font-size: 1.5em;
}
```

The `tc-tagged-NightReader` class is applied to the entire tiddler and not just the tiddler text. If you want to target a smaller portion of the tiddler you can qualify the CSS selector, as is done here with `.tc-tagged-NightReader .tc-tiddler-body`.

Note that tags containing spaces or non-alphanumeric characters will be converted using URI encoding, making the generated CSS classname hard to predict. For example:

|!Tag |!Generated Class Name |
|`$:/mytag |`tc-tagged-%24%3A%2Fmytag` |
|`one two` |`tc-tagged-one%20two` |
|`£35.23` |`tc-tagged-%C2%A335.23` |
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
title: How to put the last modification date in a banner
created: 20141020111002211
modified: 20141020111002211
tags: Learning
type: text/vnd.tiddlywiki

Here's how to display the last modification date of a wiki in a banner in the corner of the window:

# Copy the plugin $:/plugins/tiddlywiki/github-fork-ribbon (labelled "GitHub-style ribbon in pure CSS") to your TiddlyWiki
# Save and reload your wiki
# Create a new tiddler called [[$:/_MyRibbon]] tagged [[$:/tags/PageControls]] and containing:<div>

```
<div class="github-fork-ribbon-wrapper right">
<div class="github-fork-ribbon" style="background-color:#DF4848;">
<$list filter="[!is[system]!has[draft.of]!sort[modified]limit[1]]">
<$link>
<$view field="modified" format="date" template="DD mmm YYYY at 0hh:0mm"/>
</$link>
</$list>
</div>
</div>
```
</div>
# If required, change the background-color value to your preference
# You can also try changing the positioning class from `right` to `right-bottom`
## To make the banner appear at the top left you'll need to tag the tiddler [[$:/tags/PageTemplate]] instead of [[$:/tags/PageControls]] and then change the position class to `left`
6 changes: 2 additions & 4 deletions editions/tw5.com/tiddlers/howtos/Upgrading.tid
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,16 @@ The process described here is for upgrading standalone TiddlyWiki files. There i
<<<
When upgrading, please remember the [[The First Rule of Using TiddlyWiki]]:

//You are responsible for looking after your own data; take care to make backups, especially when upgrading the ~TiddlyWiki core//
//Backup your data!//
<<<

! Online upgrading

This process will work on most desktop browsers. Note that none of your personal data leaves your browser with this process.

# Locate your TiddlyWiki file in the file system (ie using Windows Explorer, the Finder on Mac OS X, or your file manager on Linux)
# Visit http://tiddlywiki.com/upgrade.html in your browser
# Visit the new version tiddywiki in http://tiddlywiki.com/upgrade.html in your browser
# Drag your old TiddlyWiki HTML file into the browser window
#* If the file is encrypted you will be prompted for the password
# Review the list of tiddlers that will be upgraded
# Click ''Upgrade''
# Save changes to save the new version

Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
created: 20130825150100000
modified: 20140912141559011
tags: [[TiddlyWiki on Node.js]]
title: Using TiddlyWiki for GitHub Pages project documentation
title: Using TiddlyWiki for GitHub project documentation
type: text/vnd.tiddlywiki

TiddlyWiki5 can be used to produce documentation for GitHub projects. It lets you maintain a single set of documentation as a [[TiddlyWikiFolder|TiddlyWikiFolders]] containing separate tiddler files under source code control, and then use it to produce `readme.md` files for inclusion in project folders, or HTML files for storage in [[GitHub Pages|http://pages.github.com/]]. Both features are demonstrated by TiddlyWiki5 itself.
TiddlyWiki5 can be used to produce documentation for GitHub projects. It lets you maintain a single set of documentation as a [[TiddlyWikiFolder|TiddlyWikiFolders]] containing separate tiddler files under source code control, and then use it to produce `readme.md` files for inclusion in project folders, or HTML files for storage in [[GitHub Pages|http://pages.github.com/]]. Both features are demonstrated by TiddlyWiki5 itself.

! Generating `readme.md` files

When displaying the contents of a folder GitHub will look for a `readme.md` file and display it. Note that it will not display full HTML files in this way, just static MarkDown files (this is a security measure). Happily MarkDown permits a safe subset of HTML, and thus to generate a `readme.md` file that is suitable for GitHub it is just necessary for TiddlyWiki5 to generate the content of the `<body>` element of an HTML document, and give it the appropriate filename.

This is done in `bin/bld.sh` by this command:
This is done with this command:

```
--rendertiddler ReadMe ./readme.md text/html
Expand All @@ -27,10 +27,3 @@ By default, tiddler links will be rendered as `<a>` links to a relative URI cons
See the LinkWidget for more details.

In this example, tiddler links are rendered as links to the static rendering of tw5.com.

! Publishing to GitHub Pages

Publishing to GitHub Pages is very straightforward. In the case of TiddlyWiki5, several different build products are published.

The `bld.sh` script deposits the build products directly into the local clone of the repo associated with the GitHub Pages account. There is then a manual step to review changes and push them up to github.com.

1 change: 1 addition & 0 deletions editions/tw5.com/tiddlers/learning/Learning.tid
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ Learn more about using TiddlyWiki:

<<list-links "[tag[Learning]]">>

Also see the complete [[Reference]], including advanced WikiText, macros, widgets, filters etc.
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/macros/ChangeCountMacro.tid
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: ChangeCountMacro
type: text/vnd.tiddlywiki
caption: changecount

The changecount macro returns a counter maintained by the TiddlyWiki core that tracks the number of modifications made to each tiddler. The changecount macro always applies to the tiddler named in the [[currentTiddler|WidgetVariable: currentTiddler]] variable.
The changecount macro returns a counter maintained by the TiddlyWiki core that tracks the number of modifications made to each tiddler. The changecount macro always applies to the tiddler named in the CurrentTiddler variable.

For example:

Expand Down
3 changes: 2 additions & 1 deletion editions/tw5.com/tiddlers/macros/ListMacro.tid
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,15 @@ The list macro is a family of macros that produce a list of tiddlers.

There are several variants of the macro:

* `<<list-links>>` produces a list of links to tiddlers that match a filter expression
* `<<list-links>>` produces a list of links to tiddlers that match a filter expression. If the tiddler has a //caption// field, it is displayed in lieu of the //title// field.

! Parameters

|!Position |!Name |!Description |!Default |
|1st |filter |Filter expression | |
|2nd |type |HTML tag to be used for the list wrapper |"ul" |
|3rd |subtype |HTML tag to be used for list entries |"li" |
|4th |class |An optional CSS class to be applied to the list wrapper element (eg `<ul class="three-columns">`) | |

! Examples

Expand Down
28 changes: 28 additions & 0 deletions editions/tw5.com/tiddlers/macros/NowMacro.tid
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
caption: now
created: 20141008141616791
modified: 20141013180540337
tags: Macros
title: NowMacro
type: text/vnd.tiddlywiki

The 'now' macro returns the current date and time, formatted with an optional format string.

! Parameters

|!Position |!Name |!Description |!Default |
|1st |format |DateFormat string specifying the format for the date/time |`0hh:0mm, DDth MMM YYYY` |

! Examples

For example:

```
* <<now>>
* <<now "DDth MMM YYYY">>
```

Returns:

* <<now>>
* <<now "DDth MMM YYYY">>

4 changes: 2 additions & 2 deletions editions/tw5.com/tiddlers/macros/TabsMacro.tid
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
created: 20131228162203521
modified: 20140702113527667
modified: 20140928113527667
tags: Macros
title: TabsMacro
type: text/vnd.tiddlywiki
Expand All @@ -18,7 +18,7 @@ By default the tab control arranges the tabs horizontally with the content under
|4th |class |Additional CSS classes for the three wrappers DIV of the tab | |
|5th |template |Optional template through which to render the tab content | |

Within the template the title of the current tab is available in the widget variable ''currentTab''.
Within the template the title of the current tab is available in the widget variable ''currentTab''. The ''currentTiddler'' variable is not affected by the tabs macro.

! Examples

Expand Down
6 changes: 4 additions & 2 deletions editions/tw5.com/tiddlers/macros/TimelineMacro.tid
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
title: TimelineMacro
tags: Macros
modified: 20140913100126081
modified: 20141015165343893
caption: timeline

The timeline macro produces a list of tiddlers in reverse chronological order of modification date that is grouped by the date of the day of modification.

! Parameters

|!Position |!Name |!Description |!Default |
|1st |limit |The maximum number of tiddlers to list |100 |
|1st |limit |The maximum number of tiddlers to list (see below) |100 |
|2nd |format |A DateFormat string for formatting the date |DDth MMM YYYY |
|3rd |subfilter |A subfilter to include in the timeline filter (see below) | |

Expand All @@ -24,6 +24,8 @@ To restrict the timeline to a particular tag, the subfilter can be set to someth
<<timeline limit:10 subfilter:"tag[mytag]">>
```

Note that the timeline macro does not truncate the entries for a particular day, instead always displaying all the tiddlers under each displayed day heading. This means that the limit parameter works in an unexpected way because it is possible for more than the specified number of tiddlers to be displayed.

! Examples

<$macrocall $name="wikitext-example-without-html"
Expand Down
6 changes: 3 additions & 3 deletions editions/tw5.com/tiddlers/mechanisms/TestingMechanism.tid
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
modified: 201311222159
modified: 20141013085608911
tags: Mechanisms
title: TestingMechanism

Expand Down Expand Up @@ -28,9 +28,9 @@ To generate a wiki containing the browser tests load up the `test` wiki and save
node ./tiddlywiki.js \
./editions/test \
--verbose \
--rendertiddler $:/core/save/all $TW5_BUILD_OUTPUT/test.html text/plain \
--rendertiddler $:/core/save/all 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:
The `test.html` file will be placed in the `output` folder within the wiki folder. Open it in the browser to see the test results. There is a prebuilt version of `test.html` at:

http://tiddlywiki.com/test.html
Original file line number Diff line number Diff line change
@@ -1,17 +1,23 @@
caption: tm-new-tiddler
created: 20140226194405353
modified: 20140724194729158
modified: 20141008142952355
tags: Messages navigator-message
title: WidgetMessage: tm-new-tiddler
type: text/vnd.tiddlywiki
caption: tm-new-tiddler

The new tiddler message creates a new draft tiddler and adds it to the current story. It requires the following properties on the `event` object:

|!Name |!Description |
|param |Optional title of a tiddler to use as a template for the new tiddler |
|param |Either the title of a tiddler to use as a template for the new tiddler or a hashmap of tiddler fields |
|navigateFromTitle |Title of the tiddler from which the navigation to the new tiddler was initiated |

The new tiddler message is usually generated with the LinkWidget or the ButtonWidget and is handled by the NavigatorWidget.
The title for the draft tiddler is chosen according to these rules:

* If a hashmap was used and a title field was specified, use that title
* If a hashmap was used without a title field, use a default title, if necessary making it unique with a numeric suffix
* If a template tiddler was used, use the title of the template tiddler, if necessary making it unique with a numeric suffix

The new tiddler message is usually generated with the LinkWidget, ButtonWidget or ActionSendMessageWidget and is handled by the NavigatorWidget.

! Example

Expand Down
Original file line number Diff line number Diff line change
@@ -1,33 +1,15 @@
created: 20131219100637788
modified: 20140917190022854
modified: 20141015165343893
tags: [[TiddlyWiki on Node.js]]
title: Scripts for TiddlyWiki on Node.js
type: text/vnd.tiddlywiki

! Script Files

The TiddlyWiki5 repository contains several scripts in the `bin` folder that are used to build and deploy TiddlyWiki (`.sh` for *nix and `.cmd` for Windows). They can serve as a useful starting point for your own scripts.
The TiddlyWiki5 repository contains several scripts in the `bin` folder that you can use to automate common tasks, or as a useful starting point for your own scripts. See [[Scripts for building tiddlywiki.com]] for details of the scripts used to build and release http://tiddlywiki.com/.

All the scripts expect to be run from the root folder of the repository.

!! `fullbld`: builds tw5.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 TiddlyWiki5 repo directory. For example:

```
/TiddlyWork/ - Directory for working with TiddlyWiki5
|
+--+-- /TiddlyWiki5/ - Directory containing the TiddlyWiki5 repo from GitHub
|
+-- /jermolene.github.com/ - Directory for output files
```

You can override the build output directory by defining the environment variable `TW5_BUILD_OUTPUT`. The easiest way to do this is to create a personal batch file to invoke TiddlyWiki5 that first sets the environment variable and then invokes `fullbld`.

`fullbld` also runs the TiddlyWiki5 Node.js-based test suite (see TestingMechanism)

!! `serve`: serves tw5.com

```
Expand Down Expand Up @@ -66,15 +48,7 @@ Or:

This script serves the `tw5.com-server` edition content with LazyLoading applied to images.

!! `wbld`: builds TiddlyWiki for TiddlyWeb

This script builds and deploys the code for [[TiddlyWiki in the Sky for TiddlyWeb]]. If you want to experiment with your own builds of TiddlyWiki5 for TiddlyWeb you could use this batch file as a base.

!! `2bld`: builds TiddlyWiki 2.6.5

This script builds TiddlyWiki 2.6.5 from the original source and then displays the differences between them (`diff` is used for *nix, `fc` for Windows).

!! `deploy` & `verbump`: deploy TiddlyWiki and bump the TiddlyWiki version number

These scripts are concerned with releasing a new version of TiddlyWiki. See [[Releasing a new version of TiddlyWiki5]].

10 changes: 10 additions & 0 deletions editions/tw5.com/tiddlers/plugins/Plugins.tid
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,13 @@ The tiddlers within a plugin appear as ShadowTiddlers.
Plugins can contain JavaScript modules, style sheets, and templates to extend the functionality of TiddlyWiki itself. Plugins can also be used to distribute ordinary text, images or other content. Plugins can be updated from their source as a unit.

See the PluginMechanism discussion for more details about how plugins are implemented internally.

! How to install a plugin

# Create a backup of your current TiddlyWiki HTML file ([[just in case|The First Rule of Using TiddlyWiki]])
# Open your TiddlyWiki in a browser
# In another browser window, find a link to the plugin, e.g. [[$:/plugins/tiddlywiki/example]]. You will typically find links to plugins on the home page of the plugin (for example, http://tiddlywiki.com/plugins/tiddlywiki/katex/)
# Drag the link [[$:/plugins/tiddlywiki/example]] to the browser window containing your TiddlyWiki
# Save your TiddlyWiki
# Refresh the window
# The plugin should now be available for use
6 changes: 5 additions & 1 deletion editions/tw5.com/tiddlers/reference/Reference.tid
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,8 @@ list: Concepts Definitions WikiText Macros Widgets Filters Messages Commands Mec

The following topics provide the canonical reference documentation for TiddlyWiki:

<<list-links "[tag[Reference]]">>
<div class="tc-table-of-contents">

<<toc-selective-expandable 'Reference'>>

</div>
4 changes: 2 additions & 2 deletions editions/tw5.com/tiddlers/releasenotes/BetaReleases.tid
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
created: 20131109105400007
modified: 20140701201607494
modified: 20141010092837891
tags: Releases
title: BetaReleases
type: text/vnd.tiddlywiki

Here are the details of the beta releases of TiddlyWiki5. See [[TiddlyWiki5 Versioning]] for details of how releases are named.

<<tabs "[tag[BetaReleaseNotes]!sort[created]]" "Release 5.0.19-beta" "$:/state/tab2" "tc-vertical" "ReleaseTemplate">>
<<tabs "[tag[BetaReleaseNotes]!sort[created]]" "Release 5.0.18-beta" "$:/state/tab2" "tc-vertical" "ReleaseTemplate">>
68 changes: 68 additions & 0 deletions editions/tw5.com/tiddlers/releasenotes/Release 5.1.3.tid
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
caption: 5.1.3
created: 20141020171015200
modified: 20141020171015200
tags: ReleaseNotes
title: Release 5.1.3
type: text/vnd.tiddlywiki
released: 20141020171015200

//[[See GitHub for detailed change history of this release|https://github.com/Jermolene/TiddlyWiki5/compare/v5.1.2...v5.1.3]]//

!! Usability Improvements

* [[Added|https://github.com/Jermolene/TiddlyWiki5/commit/e872f17842809e33eae177980e9ea0650b6a4c03]] "new journal" button; see [[Creating journal tiddlers]]
* [[Added|https://github.com/Jermolene/TiddlyWiki5/commit/70984aa39f8a4061162d4e404bfd158e515c7e6e]] "new here" button; see [[Creating and editing tiddlers]]
* [[Added|https://github.com/Jermolene/TiddlyWiki5/commit/00cdd04edd49c2bf0e461071c0c7c50f8aab4e42]] "new journal here" button; see [[Creating journal tiddlers]]
* [[Made|https://github.com/Jermolene/TiddlyWiki5/commit/c6951ee912d1f2717a8c208cbb920e54edf9e5d9]] date format strings be translateable
* [[Added|https://github.com/Jermolene/TiddlyWiki5/tree/master/languages/ru-RU]] Russian translation
* [[Added|https://github.com/Jermolene/TiddlyWiki5/commit/ef1d5310918dae088ce9361c1682ce0f99cf568a]] confirmation when clearing password
* [[Added|https://github.com/Jermolene/TiddlyWiki5/commit/b7bbcfa05659808c1e51a4f2f5f1d6afbc2ed3a1]] additional prompt when setting password
* [[Increased|https://github.com/Jermolene/TiddlyWiki5/commit/dc9981322aeb508d5ebac0b691b0d703f8c1995e]] size of the clear search button
* [[Upgraded|https://github.com/Jermolene/TiddlyWiki5/commit/564457de1c991df15263040d2d5526fa8ae879bb]] to [[KaTeX v0.1.1|https://github.com/Khan/KaTeX/releases/tag/v0.1.1]], with support for several additional LaTeX features


!! Hackability Improvements

* [[Added|https://github.com/Jermolene/TiddlyWiki5/commit/2ffe53f1916e4b746cc6d7e74e8f4ac75c72e38a]] audio "parser" for handling [[Audio]] content
* [[Added|https://github.com/Jermolene/TiddlyWiki5/commit/0dcf54c3b59ed04645928f0ec4ced647e5a0da7f]] support for ActionWidgets
* [[Added|https://github.com/Jermolene/TiddlyWiki5/commit/65504d5d41e45326ab1b1b6c0c21eea4c9772797]] new [[FilterOperator: addprefix]] and [[FilterOperator: addsuffix]]
* [[Added|https://github.com/Jermolene/TiddlyWiki5/commit/0c8e5380778303cdd3308bed4a15290214841f8b]] support for custom password prompts
* [[Extended|https://github.com/Jermolene/TiddlyWiki5/commit/c26bd4c5a872f56c47e9f5cfc3fada468c53ddde]] the ListMacro to display ''caption'' field if present
* [[Extended|https://github.com/Jermolene/TiddlyWiki5/commit/12e26009eef5e29140ba1a880ff033428d673630]] ImageWidget to allow percentage width and height to be specified

!! Bug Fixes

* [[Fixed|https://github.com/Jermolene/TiddlyWiki5/commit/cc576b052e2b05fd93fcb4f3eb8d9ee5278abf3e]] [[FilterOperator: each]] to work with missing tiddlers
* [[Fixed|https://github.com/Jermolene/TiddlyWiki5/commit/5dd6ebff05a3380db2901294b2cfc89c1a0e71bf]] problem with tiddler width in zoomin storyview with the sidebar hidden
* [[Fixed|https://github.com/Jermolene/TiddlyWiki5/commit/09b6540998fec6bf1fb14842be8e8c53dbd5c46a]] bug whereby the `tm-home` message wasn't navigating to a tiddler, causing problems in zoomin storyview
* [[Fixed|https://github.com/Jermolene/TiddlyWiki5/commit/3ca8d7b6cca46ffa424bcf9bdc134da464fc84f4]] problem with jumping toolbar icons under Firefox
* [[Fixed|https://github.com/Jermolene/TiddlyWiki5/commit/f85b07e70b71d0622a9459e4b04e2027540abda8]] problem with untagged label being incorrectly coloured
* [[Fixed|https://github.com/Jermolene/TiddlyWiki5/commit/b3dcd7d625ec83701ef3a77f3fb8101af57c154f]] problem with title background colours with the "Sticky Titles" theme
* [[Fixed|https://github.com/Jermolene/TiddlyWiki5/commit/5211f9c40c874a167174e8c0d439db34189d3329]] problem with subfilter parameter of TimelineMacro
* [[Exclude|https://groups.google.com/d/topic/tiddlywiki/YPACpXhH9PY/discussion]] search string tiddler from search results

!! Node.js Changes

//These changes are only relevant to people using TiddlyWiki under Node.js//

* [[Extended|https://github.com/Jermolene/TiddlyWiki5/commit/63c174d7ed56284e80ad6cd6ae966b81f9181cc9]] ~KaTeX plugin to be able to work under Node.js to generate static HTML
* [[Extended|https://github.com/Jermolene/TiddlyWiki5/commit/49dc5694a391a391264a4473e4f4422e2472a3b3]] "includeWikis" to merge build targets
* [[Refactored|https://github.com/Jermolene/TiddlyWiki5/issues/969]] the build scripts for tiddlywiki.com into a separate repository at https://github.com/Jermolene/build.jermolene.github.io
* [[Extended|https://github.com/Jermolene/TiddlyWiki5/commit/744245ea3249446fd15f504190efb1d828935d01]] boot kernel to raise an error if a missing wiki folder is specified on the command line

!! Contributors

[[@Jermolene|https://github.com/Jermolene]] would like to thank the contributors to this release who have generously given their time to help improve TiddlyWiki:

* [[@andrey013|https://github.com/andrey013]]
* [[@BramChen|https://github.com/BramChen]]
* [[@buggyj|https://github.com/buggyj]]
* [[@Eucaly|https://github.com/Eucaly]]
* [[@Evolena|https://github.com/Evolena]]
* [[@fghhfg|https://github.com/fghhfg]]
* [[@Marxsal|https://github.com/Marxsal]]
* [[@pmario|https://github.com/pmario]]
* [[@simonbaird|https://github.com/simonbaird]]
* [[@TheDiveO|https://github.com/TheDiveO]]
* [[@xcazin|https://github.com/xcazin]]

2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/releasenotes/Releases.tid
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Here are the details of recent releases of TiddlyWiki5. See [[TiddlyWiki5 Versio

(BetaReleases and AlphaReleases are listed separately).

<<tabs "[tag[ReleaseNotes]!sort[created]]" "Release 5.1.2" "$:/state/tab2" "tc-vertical" "ReleaseTemplate">>
<<tabs "[tag[ReleaseNotes]!sort[created]]" "Release 5.1.3" "$:/state/tab2" "tc-vertical" "ReleaseTemplate">>
8 changes: 7 additions & 1 deletion editions/tw5.com/tiddlers/system/github-fork-ribbon.tid
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,10 @@ tags: $:/tags/PageControls
caption: ~GitHub ribbon
description: ~GitHub ribbon for tw5.com

<div class="github-fork-ribbon-wrapper right" style><div class="github-fork-ribbon" style="background-color:#DF4848;"><$link to="Releases">Version <<version>></$link></div></div>
<div class="github-fork-ribbon-wrapper right">
<div class="github-fork-ribbon" style="background-color:#DF4848;">
<$link to="Releases">
Version <<version>>
</$link>
</div>
</div>
15 changes: 15 additions & 0 deletions editions/tw5.com/tiddlers/variables/Variables.tid
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
created: 20141002133113496
modified: 20141002230631361
tags: Reference
title: Variables
type: text/vnd.tiddlywiki

Variables together with [[Widgets]] and [[Macros]] are essential for dynamic WikiText.

You can define your own [[Variables in WikiText]] or use built-in variables.

More detailed information of built-in variables could be found in below:

<<list-links "[tag[Variables]]">>

See also DumpVariablesMacro
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
caption: currentTiddler
created: 20141001232824187
modified: 20141002161518301
tags: Variables
title: WidgetVariable: currentTiddler
type: text/vnd.tiddlywiki

! Mechanism

The ''currentTiddler'' variable contains the title of the current tiddler.

The ListWidget assigns the list result to the ''currentTiddler'' variable, unless the `variable` attribute is specified.

A couple of [[Widgets]] and [[Macros]] by default apply to the tiddler according to the ''currentTiddler'' variable.

The TranscludeWidget (or WikiText `{{||TemplateTitle}}`) transcludes a tiddler without changing the ''currentTiddler'' variable.

! Using currentTiddler Variable

These mechanisms together allow you to write references like `<$view field="title" format="link"/>` in TemplateTiddlers or inside the ListWidget hierarchy without explicitly specifying the tiddler that it applies to.

See also [[WidgetVariable: storyTiddler]] and [[WidgetVariable: currentTiddler]]
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
caption: storyTiddler
created: 20141001232753952
modified: 20141002133957245
tags: Variables
title: WidgetVariable: storyTiddler
type: text/vnd.tiddlywiki

The ''storyTiddler'' variable is set by the [[default viewtemplate|$:/core/ui/ViewTemplate]] to the name of the current tiddler within tiddlers in the story river, and is not defined within the sidebar.

See also [[WidgetVariable: currentTiddler]]
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
caption: transclusion
created: 20141002004621385
modified: 20141002162057822
tags: Variables
title: WidgetVariable: transclusion
type: text/vnd.tiddlywiki

! Mechanism
The ''transclusion'' variable is set automatically by the transclude widget to contain a string that identifies the position of the current node within the widget tree. In the sidebar it is set to `{|$:/core/ui/PageTemplate/sidebar|||}` and within the tiddler "HelloThere" in the story river it is set to `{HelloThere|HelloThere|||}`. Each nested level of transclusion appends another curly bracketed list of symbols.

The QualifyMacro uses the ''transclusion'' variable to identify the stack of transcluded tiddlers.

! Example

```
\define mymacro()
Hello from mymacro
<$list filter="[<transclusion>prefix[{|$:/core/ui/PageTemplate/sidebar|||}]]" emptyMessage="in a tiddler">
in the sidebar
</$list>
\end

<<mymacro>>
```

Result in story tiddler

```
Hello from mymacro in a tiddler
```

Result in the sidebar

```
Hello from mymacro in the sidebar
```
File renamed without changes.
38 changes: 38 additions & 0 deletions editions/tw5.com/tiddlers/widgets/ActionNavigateWidget.tid
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
caption: action-navigate
created: 20141008163514491
modified: 20141008164303144
tags: Widgets ActionWidgets
title: ActionNavigateWidget
type: text/vnd.tiddlywiki

! Introduction

The ''action-navigate'' widget is an [[action widget|ActionWidgets]] that sends a [[tm-navigate|WidgetMessage: tm-navigate]] message back up the widget tree. ActionWidgets are used within triggering widgets such as the ButtonWidget.

! Content and Attributes

The ''action-navigate'' widget is invisible. Any content within it is ignored.

|!Attribute |!Description |
|$to |The title of the target tiddler for the navigation (if not provided defaults to the [[WidgetVariable: currentTiddler]] |
|$scroll |Optional parameter determining whether the navigation will also cause a scroll to the target tiddler (see below) |

!! Scroll handling

The optional `$scroll` attribute can be set to "yes" to force scrolling to occur to bring the target tiddler into view. If set to "no" then scrolling does not occur. If the `$scroll` attribute is omitted then scrolling occurs unless either:

* the control key is pressed
* the action was initiated with the middle mouse button (if available)

Note that if navigating to multiple tiddlers at once you should use the same `$scroll` setting for all of them.

! Examples

Here is an example of button that navigates to two different tiddlers at once:

<$macrocall $name='wikitext-example-without-html'
src='<$button>
<$action-navigate $to="ButtonWidget"/>
<$action-navigate $to="ActionWidgets"/>
Click me!
</$button>'/>
31 changes: 31 additions & 0 deletions editions/tw5.com/tiddlers/widgets/ActionSendMessageWidget.tid
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
caption: action-sendmessage
created: 20141008134309742
modified: 20141008162952455
tags: Widgets ActionWidgets
title: ActionSendMessageWidget
type: text/vnd.tiddlywiki

! Introduction

The ''action-sendmessage'' widget is an [[action widget|ActionWidgets]] that sends a [[message|WidgetMessages]] back up the widget tree. ActionWidgets are used within triggering widgets such as the ButtonWidget.

! Content and Attributes

The ''action-sendmessage'' widget is invisible. Any content within it is ignored.

|!Attribute |!Description |
|$message |The message to send (eg, [[WidgetMessage: tm-new-tiddler]]) |
|$param |Optional parameter string whose meaning is dependent on the message being sent |
|//{any attributes not starting with $}// |Multiple parameters that are attached to the message if the `$param$` attribute is not provided |

! Examples

Here is an example of button that displays both a notification and a wizard, and creates a new tiddler with tags and text:

<$macrocall $name='wikitext-example-without-html'
src='<$button>
<$action-sendmessage $message="tm-modal" $param="SampleWizard"/>
<$action-sendmessage $message="tm-notify" $param="SampleNotification"/>
<$action-sendmessage $message="tm-new-tiddler" title="This is newly created tiddler" tags="OneTag [[Another Tag]]" text=<<now "Today is DDth, MMM YYYY">>/>
Click me!
</$button>'/>
23 changes: 23 additions & 0 deletions editions/tw5.com/tiddlers/widgets/ActionWidgets.tid
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
created: 20141008134425548
modified: 20141008144957192
tags: Widgets
title: ActionWidgets
type: text/vnd.tiddlywiki

Action widgets are a special type of widget that perform an action such as sending a message, navigating to a tiddler, or changing the value of a tiddler. They are used in association with other widgets that trigger those actions (for example, the ButtonWidget).

Action widgets are invisible. They must be the immediate children of their parent triggering widget. The actions are performed in sequence. For example, here is a button that triggers two actions of sending different messages:

```
<$button>
<$action-sendmessage $message="tm-home"/>
<$action-sendmessage $message="tm-full-screen"/>
Click me!
</$button>
```

Take care not to accidentally introduce an extra line break after the opening tag of the button widget. Doing so will trigger the WikiText parser to wrap the action widgets in a paragraph element. This means that the action widgets will not be triggered as they are no longer immediate children of the triggering widget.

The following action widgets are provided:

<<list-links "[tag[ActionWidgets]]">>
14 changes: 13 additions & 1 deletion editions/tw5.com/tiddlers/widgets/BrowseWidget.tid
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
title: BrowseWidget
created: 201310241419
modified: 20140910200751303
modified: 20141020155353547
tags: Widgets
caption: browse

Expand All @@ -14,5 +14,17 @@ The content of the `<$browse>` widget is ignored.

|!Attribute |!Description |
|multiple |Set to "multiple" to select multiple file upload |
|message |Optional override of widget message to be generated. The parameter for the message will be the JavaScript object `event.target.files` |

On iPhone/iPad choosing the multiple option will remove the ability to take photographs/videos directly into TiddlyWiki.

''e.g.''

```
<$browse>
```

renders as:

<$browse>

23 changes: 14 additions & 9 deletions editions/tw5.com/tiddlers/widgets/ButtonWidget.tid
Original file line number Diff line number Diff line change
@@ -1,17 +1,22 @@
title: ButtonWidget
created: 201310241419
modified: 201406170837
tags: Widgets
caption: button
created: 20131024141900000
modified: 20141008145311298
tags: Widgets
title: ButtonWidget
type: text/vnd.tiddlywiki

! Introduction

The button widget displays an HTML `<button>` element that can perform a combination of optional actions when clicked:

* Navigate to a specified tiddler
* Dispatch a user defined [[widget message|Messages]]
* Trigger a user defined [[popup|PopupMechanism]]
* Assign new text to a specified tiddler
* Executing any ActionWidgets that are immediate children of the button widget
* Execute any integrated actions:
** Navigate to a specified tiddler
** Dispatch a user defined [[widget message|Messages]]
** Trigger a user defined [[popup|PopupMechanism]]
** Assign new text to a specified tiddler

The integrated actions are provided as a shortcut for invoking common actions. The same functionality is available via ActionWidgets, with the exception of the support for highlighting selected popups.

! Content and Attributes

Expand All @@ -25,7 +30,7 @@ The content of the `<$button>` widget is displayed within the button.
|setTo |The new value to assign to the TextReference identified in the `set` attribute |
|popup |Title of a state tiddler for a popup that is toggled when the button is clicked |
|aria-label |Optional [[Accessibility]] label |
|title |Optional tooltip |
|tooltip |Optional tooltip |
|class |An optional CSS class name to be assigned to the HTML element |
|style |An optional CSS style attribute to be assigned to the HTML element |
|selectedClass |An optional additional CSS class to be assigned if the popup is triggered or the tiddler specified in `set` already has the value specified in `setTo` |
Expand Down
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/widgets/CheckboxWidget.tid
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The checkbox widget displays an HTML `<input type="checkbox">` element that is d
The content of the `<$checkbox>` widget is displayed within an HTML `<label>` element immediately after the checkbox itself. This means that clicking on the content will toggle the checkbox.

|!Attribute |!Description |
|tiddler |Title of the tiddler to manipulate (defaults to the [[WidgetVariable: currentTiddler]]) |
|tiddler |Title of the tiddler to manipulate (defaults to the CurrentTiddler) |
|tag |The name of the tag to which the checkbox should be bound |
|field |The name of the field to which the checkbox should be bound |
|checked |The value of the field corresponding to the checkbox being checked |
Expand Down
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/widgets/EditBitmapWidget.tid
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The edit bitmap widget provides a user interface in the browser for editing bitm
The content of the `<$edit-bitmap>` widget is ignored.

|!Attribute |!Description |
|tiddler |The tiddler to edit (defaults to the [[WidgetVariable: currentTiddler]]) |
|tiddler |The tiddler to edit (defaults to the CurrentTiddler) |

! Configuration

Expand Down
4 changes: 2 additions & 2 deletions editions/tw5.com/tiddlers/widgets/EditTextWidget.tid
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ By default, the edit text widget generates a `<textarea>` as the HTML editing el
The content of the `<$edit-text>` widget is ignored.

|!Attribute |!Description |
|tiddler |The tiddler to edit (defaults to the [[WidgetVariable: currentTiddler]]) |
|tiddler |The tiddler to edit (defaults to the CurrentTiddler) |
|field |The field to edit (defaults to `text`). Takes precedence over the `index` attribute |
|index |The index to edit |
|default |The default text to be provided when the target tiddler doesn't exist |
Expand All @@ -30,7 +30,7 @@ The content of the `<$edit-text>` widget is ignored.

One trap to be aware of is that the edit text widget cannot be used to edit a field of the tiddler that contains it. Each keypress results in the tiddler being re-rendered, which loses the cursor position within the text field.

Instead, place the edit text widget in a [[template|TiddlerTemplates]] that references the tiddler you want to modify.
Instead, place the edit text widget in a [[template|TemplateTiddlers]] that references the tiddler you want to modify.

For example, if you wanted to edit the value of the "myconfig" field of the tiddler "AppSettings", you might do so by creating a separate tiddler "ChangeAppSettings" that contains the following:

Expand Down
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/widgets/EditWidget.tid
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The edit widget provides a general purpose interface for editing a tiddler. It d
The content of the `<$edit>` widget is ignored.

|!Attribute |!Description |
|tiddler |The tiddler to edit (defaults to the [[WidgetVariable: currentTiddler]]) |
|tiddler |The tiddler to edit (defaults to the CurrentTiddler) |
|field |The field to edit (defaults to `text`). Takes precedence over the `index` attribute |
|index |The index to edit |
|class |A CSS class to be added the generated editing widget |
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/widgets/FieldManglerWidget.tid
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ The field mangler widget manipulates the fields and tags of a tiddler. It does s
The field mangler widget displays any contained content, and responds to [[Messages]] dispatched within it.

|!Attribute |!Description |
|tiddler |Title of the tiddler to manipulate (defaults to the [[WidgetVariable: currentTiddler]]) |
|tiddler |Title of the tiddler to manipulate (defaults to the CurrentTiddler) |
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/widgets/FieldsWidget.tid
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The provided template is rendered with the following special substitutions:
The content of the `<$fields>` widget is ignored.

|!Attribute |!Description |
|tiddler |Title of the tiddler from which the fields are to be displayed (defaults to the [[WidgetVariable: currentTiddler]]) |
|tiddler |Title of the tiddler from which the fields are to be displayed (defaults to the CurrentTiddler) |
|template |Text of the template (see above) |
|exclude |Lists of fields to be excluded (defaults to "text") |
|stripTitlePrefix |If set to "yes" then curly bracketed prefixes are removed from titles (for example `{prefix}HelloThere` converts to `HelloThere`) |
Expand Down
4 changes: 3 additions & 1 deletion editions/tw5.com/tiddlers/widgets/ImageWidget.tid
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,14 @@ Any content of the `<$image>` widget is ignored.

|!Attribute |!Description |
|source |The URL of the image, or the title of an image tiddler |
|width |The width of the image as a number |
|width |The width of the image |
|height |The height of the image |
|tooltip |The tooltip to be displayed over the image |
|alt |The alternative text to be associated with the image |
|class |CSS classes to be assigned to the `<img>` element |

The width and the height can be specified as pixel values (eg "23" or "23px") or percentages (eg "23%"). They are both optional; if not provided the browser will use CSS rules to size the image.

! External Images and the ''_canonical_uri'' field

When used to display tiddler-based images, the image widget operates in two distinct modes:
Expand Down
4 changes: 2 additions & 2 deletions editions/tw5.com/tiddlers/widgets/KeyboardWidget.tid
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ The keyboard widget allows [[Messages]] to be generated in response to key press
The content of the `<$keyboard>` widget is rendered normally. The keyboard shortcut only takes effect within the contained content.

|!Attribute |!Description |
|message |The title of the WidgetMessage to generate |
|param |The parameter to be passed with the WidgetMessage |
|message |The title of the [[WidgetMessage|Messages]] to generate |
|param |The parameter to be passed with the [[WidgetMessage|Messages]] |
|key |Key string identifying the key to be trapped (see below) |
|class |A CSS class to be assigned to the generated HTML DIV element |

Expand Down
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/widgets/LinkWidget.tid
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The `link` widget generates links to tiddlers. (Use the HTML `<a>` element to ge
! Content and Attributes

|!Attribute |!Description |
|to |The title of the target tiddler for the link (defaults to the [[WidgetVariable: currentTiddler]]) |
|to |The title of the target tiddler for the link (defaults to the CurrentTiddler) |
|aria-label |Optional [[Accessibility]] label |
|tooltip |Optional tooltip WikiText |

Expand Down
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/widgets/ListWidget.tid
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The tiddlers can either be displayed by transcluding each in turn through an opt
The content of the `<$list>` widget is an optional template to use for rendering each tiddler in the list (alternatively, the template can be specified as a tiddler title in the ``template`` attribute).

|!Attribute |!Description |
|filter |The TiddlerFilter to display |
|filter |The [[tiddler filter|Filters]] to display |
|template |The title of a template tiddler for rendering each tiddler in the list |
|editTemplate |An alternative template to use for DraftTiddlers in edit mode |
|variable |The [[widget variable|WidgetVariables]] name to be assigned the title of each tiddler in the list. Defaults to ''currentTiddler'' |
Expand Down
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/widgets/RadioWidget.tid
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The radio widget displays an HTML `<input type="radio">` that reflects whether
The content of the `<$radio>` widget is displayed within an HTML `<label>` element also containing the radio button. This means that clicking on the content will have the same effect as clicking on the button itself.

|!Attribute |!Description |
|tiddler |Title of the tiddler to manipulate (defaults to the [[WidgetVariable: currentTiddler]]) |
|tiddler |Title of the tiddler to manipulate (defaults to the CurrentTiddler) |
|field |The name of the field to which the radio button will be bound |
|value |The value for the tiddler field |
|class |CSS classes to be assigned to the label around the radio button |
Expand Down
14 changes: 7 additions & 7 deletions editions/tw5.com/tiddlers/widgets/RevealWidget.tid
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@ Retaining the content when hidden can give poor performance since the hidden con

Here's a simple example of showing and hiding content with buttons:

<<wikitext-example-without-html '<$button set="$:/SampleRevealState" setTo="show">Show me</$button>
<$button set="$:/SampleRevealState" setTo="hide">Hide me</$button>
<<wikitext-example-without-html '<$button set="$:/SampleRevealState1" setTo="show">Show me</$button>
<$button set="$:/SampleRevealState1" setTo="hide">Hide me</$button>

<$reveal type="match" state="$:/SampleRevealState" text="show">
<$reveal type="match" state="$:/SampleRevealState1" text="show">

! This is the revealed content
And this is some text
Expand All @@ -48,14 +48,14 @@ And this is some text

A slider appears as a single button that can be used to toggle the display of the contained content.

<<wikitext-example-without-html '<$reveal type="nomatch" state="$:/SampleRevealState" text="show">
<<wikitext-example-without-html '<$reveal type="nomatch" state="$:/SampleRevealState2" text="show">

<$button set="$:/SampleRevealState" setTo="show">Show me</$button>
<$button set="$:/SampleRevealState2" setTo="show">Show me</$button>

</$reveal>
<$reveal type="match" state="$:/SampleRevealState" text="show">
<$reveal type="match" state="$:/SampleRevealState2" text="show">

<$button set="$:/SampleRevealState" setTo="hide">Hide me</$button>
<$button set="$:/SampleRevealState2" setTo="hide">Hide me</$button>

! This is the revealed content
And this is some text
Expand Down
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/widgets/ViewWidget.tid
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The view widget displays the contents of a tiddler field in a specified format.
The content of the `<$view>` widget is displayed if the field or property is missing or empty.

|!Attribute |!Description |
|tiddler |The title of the tiddler (defaults to the [[WidgetVariable: currentTiddler]]) |
|tiddler |The title of the tiddler (defaults to the CurrentTiddler) |
|field |The name of the field to view (defaults to "text") |
|index |The name of the index to view |
|format |The format for displaying the field (see below) |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
caption: Confusion between Transclusion and Substitution
created: 20141018090608643
modified: 20141018181414011
tags: WikiText
type: text/vnd.tiddlywiki

The power of WikiText comes from the ability to use the content of one tiddler inside another one. This ability takes several different forms that can easily be confused.

The main distinction is between a transclusion and a textual substitution:

* A transclusion is replaced dynamically with the value of either:
** a tiddler field
** a variable
* Textual substitutions are performed on the text of macro definitions before they are used

! Tiddler Field Transclusion

[[Transclusion in WikiText]] describes the basics of transclusion. For example:

```
{{MyTiddler}}
```

As described in [[HTML in WikiText]], you can also transclude tiddler field values as attributes of HTML elements and widgets. For example:

```
<$text text={{MyTiddler}}/>
```

As described in [[Introduction to Filters]], you can also transclude tiddler field values as filter operands. For example:

```
{{{ [tag{TiddlerContainingMyTag}] }}}
```

! Variable/Macro Transclusion

Variables that were defined with parameter or variable substitution are referred to as "macros". The value of a variable/macro can be transcluded with the syntax:

```
<<myMacro param:"Value of parameter">>
```

As described in [[HTML in WikiText]], you can also transclude a variable as the value of an attribute of HTML elements and widgets. For example:

```
<$text text=<<myMacro>>/>
```

As described in [[Introduction to Filters]], you can also transclude a variable as the value of a filter operand. For example:

```
{{{ [tag<myMacro>] }}}
```

! Textual Substitution

Textual substitution occurs when the value of a macro/variable is used. It is described in [[Macros in WikiText]].

The key difference between substitution and transclusion is that substitution occurs before WikiText parsing. This means that you can use substitution to build WikiText constructions. Transclusions are processed independently, and cannot be combined with adjacent text to define WikiText constructions.
13 changes: 6 additions & 7 deletions editions/tw5.com/tiddlers/wikitext/HTML in WikiText.tid
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
created: 20131205160816081
modified: 20140619111725471
modified: 20141018181414011
tags: WikiText
title: HTML in WikiText
type: text/vnd.tiddlywiki
Expand All @@ -14,9 +14,13 @@ This is my nice and simple block of text. HelloThere
</article>
```

! Content Parsing

The content of an HTML element will be parsed in inline mode unless the opening tag is followed by two linebreaks, in which case it is parsed in block mode. (Inline mode means that block mode formatting such as tables, lists and headings is not recognised).

! Attributes

Attributes in HTML tags can be specified as a transclusion or a macro invocation. For example, here the value of the `href` attribute will be set to the value of the tiddler MyLinkDestination:
Attributes in HTML tags can be specified as a literal, a transclusion or a macro invocation. For example, here the value of the `href` attribute will be set to the value of the tiddler MyLinkDestination:

```
<a href={{MyLinkDestination}}>link</a>
Expand Down Expand Up @@ -45,8 +49,3 @@ By using triple-double quotes you can specify attribute values that include sing
Rodentville,
Ratland."""/>
```

! Content Parsing

The content of an HTML element will be parsed in inline mode unless the opening tag is followed by two linebreaks. (Inline mode means that block mode formatting such as tables, lists and headings is not recognised).

10 changes: 10 additions & 0 deletions editions/tw5.com/tiddlers/wikitext/Lists in WikiText.tid
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,16 @@ You can also mix ordered and unordered list items:
*## And the other
">>

Here's an example the other way around, with numbers as the first level:

<<wikitext-example src:"# To do today
#* Eat
# To get someone else to do
#* This
#* That
#** And the other
">>

! CSS Classes

You can also assign a CSS class to an individual member of a list with this notation:
Expand Down
56 changes: 51 additions & 5 deletions editions/tw5.com/tiddlers/wikitext/Macros in WikiText.tid
Original file line number Diff line number Diff line change
Expand Up @@ -17,30 +17,56 @@ Hi, I'm $name$ and I live in $address$
\end
```

The first line of the definition specifies the macro name and any parameters. Parameters are named and can optionally have default values that are used if the parameter isn't specified at the time of calling. The body of the macro definition follows, terminated with `\end`. The macro can include parameters using the `$name$` construction.
!! Parameter Substitution

The first line of the definition specifies the macro name and any parameters. Parameters are named and can optionally have default values that are used if the parameter isn't specified at the time of calling. The body of the macro definition follows, terminated with `\end` on a line by itself.

The text of the macro can reference parameters using the `$name$` syntax. The value of the parameter is substituted at the time the macro is invoked.

!! Variable Substitution

The values of named variables can also be substituted into the text of a macro using the syntax `$(variable)$`. For example:

```
\define mysamplemacro2()
Hi, I'm $(name)$ and I live in $(address)$
\end
\define name() Bugs Bunny

<$set name="address" value="Rabbit Hole Hill">
<<mysamplemacro2>>
</$set>
```

The result is: `Hi, I'm Bugs Bunny and I live in Rabbit Hole Hill`.

!! Single Line macros

Single-line macros can omit the `\end` marker like this:

```
\define mysamplemacro(name:"Bugs Bunny") Hi, I'm $name$
\define mysamplemacro3(name:"Bugs Bunny") Hi, I'm $name$
```

!! Macro Scope

Macro definitions must be placed at the top of a tiddler. Macros are available to the tiddler that defines them, plus any tiddlers that it transcludes.

Global macros can be defined in any tiddler with the tag [[$:/tags/Macro]]. They are then available within all tiddlers.

Macros can be imported from other tiddlers with the ImportVariablesWidget.

[[JavaScript Macros]] can also be used for more flexibility.
[[JavaScript Macros|http://tiddlywiki.com/dev/index.html#JavaScript%20Macros]] can also be used for more flexibility.

! Using Macros

Macros are used like this:
In their simplest form, macros are used like this:

```
<<mysamplemacro>>
<<mysamplemacro "Donald Duck">>
<<mysamplemacro "Mickey Mouse" "Mouse House">>
<<mysamplemacro name:"Minnie Mouse" address:"Mouse House">>
```

Resulting in:
Expand All @@ -49,10 +75,13 @@ Resulting in:
Hi I'm Bugs Bunny and I live in Rabbit Hole Hill
Hi I'm Donald Duck and I live in Rabbit Hole Hill
Hi I'm Mickey Mouse and I live in Mouse House
Hi I'm Minnie Mouse and I live in Mouse House

```

! Multiline Parameters
Note that parameter values that do not specify names are mapped in sequence to the parameters defined in the macro.

!! Multiline Parameters

Parameters can include line breaks. For example:

Expand All @@ -71,3 +100,20 @@ By using triple-double quotes you can specify parameter values that include sing
Rodentville,
Ratland.""">>
```

! Using Macros with the MacroCallWidget

Macros can also be invoked with the MacroCallWidget

```
<<italicise "Text to be made into italics">>
<<italicise text:"Text to be made into italics">>
<$macrocall $name="italicise" text="Text to be made into italics"/>
<$macrocall $name="italicise" text={{Title of tiddler containing text to be italicised}}/>
<$macrocall $name="italicise" text=<<textMaker "Another macro to generate the text to be italicised">>/>
```

Also see:

* [[Macros]]
* [[MacroCallWidget]]
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ You can incorporate the content of one tiddler within another using the transclu

* `{{MyTiddler}}` transcludes a single tiddler
* `{{MyTiddler||TemplateTitle}}` displays the tiddler through a specified [[TemplateTiddler|TemplateTiddlers]]
* `{{||TemplateTitle}}` displays the specified template tiddler without altering the [[current tiddler|WidgetVariable: currentTiddler]]
* `{{||TemplateTitle}}` displays the specified template tiddler without altering the CurrentTiddler

You can also use a TextReference instead of a tiddler title:

Expand All @@ -24,3 +24,7 @@ A similar syntax can be used to transclude a list of tiddlers matching a specifi
{{{ [tag[mechanism]] }}}
{{{ [tag[mechanism]] ||TemplateTitle}}}
```

See also:

* [[Confusion between Transclusion and Substitution]]
28 changes: 28 additions & 0 deletions editions/tw5.com/tiddlers/wikitext/Variables in WikiText.tid
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
caption: Variables
created: 20141002141231992
modified: 20141018104313995
tags: WikiText
title: Variables in WikiText
type: text/vnd.tiddlywiki

! Defining Variables
Variables contains values defined by [[Widgets]].
Variables are available within the widget that defines them, and the child widgets in the widget tree.

Variables are defined by:

* TiddlyWiki core and viewtemplate
* SetWidget
* ListWidget
* [[Macro definition|Macros in WikiText]]

! Using Variables

Variables are used in:

* Variable substitution `$(name)$`
* Concise shortcut `<<name>>`
* [[Filter expression|Introduction to Filters]] `[operator<variable-operand>]`
* Some default behaviors of [[Widgets]]

See also [[currentTiddler|WidgetVariable: currentTiddler]] variable, built-in [[variables|Variables]] and [[Confusion between Transclusion and Substitution]].
25 changes: 25 additions & 0 deletions editions/tw5.com/tiddlers/workingwithtw/Audio.tid
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
created: 20141018131647392
modified: 20141019200654436
tags: [[Working with TiddlyWiki]]
title: Audio
type: text/vnd.tiddlywiki

Audio files can be incorporated into TiddlyWiki in a very similar way to [[images|Images]].

! Embedded Audio

Small audio files can be embedded directly within TiddlyWiki. Embedding isn't suitable for large files (over a few hundred kilobytes) because it increases the size of the TiddlyWiki file.

For example, the tiddler [[TiddlyWiki.mp3]] contains an MP3 recording of the word "TiddlyWiki". Viewing the tiddler directly should show an audio player that allows playback.

You can also transclude audio files. For example:

<<wikitext-example-without-html '{{TiddlyWiki.mp3}}'>>

! External Audio

External audio tiddlers use the ''_canonical_uri'' field to point to an external audio file/stream, and have a block ''text'' field. This reduces their size considerably, and still allows for playback.

For example, the tiddler [[Caruso - Ave Maria]] points to an online audio recording hosted on http://archive.org:

<<wikitext-example-without-html '{{Caruso - Ave Maria}}'>>
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
created: 20140904140300000
modified: 20140916130530304
modified: 20141010093319359
tags: [[Working with TiddlyWiki]]
title: Creating and editing tiddlers
type: text/vnd.tiddlywiki
Expand All @@ -8,6 +8,10 @@ type: text/vnd.tiddlywiki

You create a tiddler either by clicking the {{$:/core/images/new-button}} button in the sidebar, or by clicking on a link to a missing tiddler (links to missing tiddlers will appear in [[blue italic text]]).

See also:

* [[Creating journal tiddlers]]

! Editing tiddlers

You can edit an existing tiddler by clicking the {{$:/core/images/edit-button}} button at the top right of the tiddler.
Expand Down
Loading