mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-23 10:07:19 +00:00
Code Issues Releases Wiki Activity

Improve plugin readmes

Browse Source 
Now every plugin has a short, introductory readme tiddler that is shown
in the online plugin library.
This commit is contained in:
Jermolene 2015-03-19 10:53:45 +00:00
parent 2f8837a445
commit f2a7f00870
50 changed files with 232 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
editions/highlightdemo/tiddlers/HelloThere.tid
View File

@ -1,19 +1,3 @@
title: HelloThere title: HelloThere
This is a demo of TiddlyWiki5 incorporating a plugin for the [[highlight.js|https://github.com/isagalaev/highlight.js]] syntax highlighting library from Ivan Sagalaev. This is a demo of TiddlyWiki5 incorporating a plugin for the [[highlight.js|https://github.com/isagalaev/highlight.js]] syntax highlighting library from Ivan Sagalaev.
! Usage
The HighlightExample tiddler shows how fenced code blocks can have a language specifier added to trigger highlighting.
! Installation
To add this plugin to your own TiddlyWiki5, just drag this link to the browser window:
[[$:/plugins/tiddlywiki/highlight]]
! Adding Themes
You can add themes from highlight.js by copying the CSS to a new tiddler and tagging it with [[$:/tags/Stylesheet]]. The available themes can be found on GitHub:
https://github.com/isagalaev/highlight.js/tree/master/src/styles

1
editions/prerelease/tiddlers/system/PrereleaseOfficialPluginLibrary.tid
View File

@ -1,6 +1,7 @@
title: $:/config/OfficialPluginLibrary title: $:/config/OfficialPluginLibrary
tags: $:/tags/PluginLibrary tags: $:/tags/PluginLibrary
url: http://tiddlywiki.com/prerelease/library/v5.1.8/index.html url: http://tiddlywiki.com/prerelease/library/v5.1.8/index.html
url: http://127.0.0.1:8080/prerelease/library/v5.1.8/index.html
caption: {{$:/language/OfficialPluginLibrary}} (Prerelease) caption: {{$:/language/OfficialPluginLibrary}} (Prerelease)
The prerelease version of the official ~TiddlyWiki plugin library at tiddlywiki.com. Plugins, themes and language packs are maintained by the core team. The prerelease version of the official ~TiddlyWiki plugin library at tiddlywiki.com. Plugins, themes and language packs are maintained by the core team.

2
plugins/tiddlywiki/browser-sniff/plugin.info
View File

@ -3,5 +3,5 @@
"description": "Browser sniffing", "description": "Browser sniffing",
"author": "JeremyRuston", "author": "JeremyRuston",
"core-version": ">=5.0.0", "core-version": ">=5.0.0",
"list": "readme" "list": "readme usage"
} }

6
plugins/tiddlywiki/browser-sniff/readme.tid → plugins/tiddlywiki/browser-sniff/usage.tid
View File

@ -1,9 +1,9 @@
title: $:/plugins/tiddlywiki/browser-sniff/readme title: $:/plugins/tiddlywiki/browser-sniff/usage
This plugin adds a number of `$:/info/` tiddlers containing information about the current browser.
! Information Tiddlers ! Information Tiddlers
The following informational tiddlers are created at startup:
|!Title |!Description | |!Title |!Description |
|[[$:/info/browser/is/android]] |Running on Android? ("yes" or "no") | |[[$:/info/browser/is/android]] |Running on Android? ("yes" or "no") |
|[[$:/info/browser/is/bada]] |Running on Bada? ("yes" or "no") | |[[$:/info/browser/is/bada]] |Running on Bada? ("yes" or "no") |

4
plugins/tiddlywiki/cecily/readme.tid
View File

@ -1,7 +1,9 @@
title: $:/plugins/tiddlywiki/cecily/readme title: $:/plugins/tiddlywiki/cecily/readme
This plugin provides a new story visualisation that displays individual tiddlers as resizable tiles on an infinite canvas. This experimental plugin provides a new story visualisation that displays individual tiddlers as resizable tiles on an infinite canvas.
Cecily is based on an earlier plugin for TiddlyWiki Classic: http://jermolene.com/cecily Cecily is based on an earlier plugin for TiddlyWiki Classic: http://jermolene.com/cecily
Cecily is currently in the early stages of development with little functionality yet implemented. Cecily is currently in the early stages of development with little functionality yet implemented.
[[Source code|https://github.com/Jermolene/TiddlyWiki5/blob/master/plugins/tiddlywiki/cecily]]

2
plugins/tiddlywiki/cecily/storyview-cecily.tid
View File

@ -1,7 +1,7 @@
title: $:/core/images/storyview-cecily title: $:/core/images/storyview-cecily
tags: $:/tags/Image tags: $:/tags/Image
<svg class="tc-image-storyview-cecily tc-image-button" width="22pt" height="22pt" viewBox="0 0 129 129"> <svg class="tc-image-storyview-cecily tc-image-button" width="22pt" height="22pt" viewBox="0 0 128 128">
<g fill-rule="evenodd"> <g fill-rule="evenodd">
<path d="M8.00697327,0 C3.58484404,0 0,3.59075293 0,8.00697327 L0,119.993027 C0,124.415156 3.59075293,128 8.00697327,128 L119.993027,128 C124.415156,128 128,124.409247 128,119.993027 L128,8.00697327 C128,3.58484404 124.409247,0 119.993027,0 L8.00697327,0 L8.00697327,0 Z M23.9949725,16 C19.5794711,16 16,19.5776607 16,23.9924054 L16,40.0075946 C16,44.4216782 19.5905136,48 23.9949725,48 L71.0050275,48 C75.4205289,48 79,44.4223393 79,40.0075946 L79,23.9924054 C79,19.5783218 75.4094864,16 71.0050275,16 L23.9949725,16 L23.9949725,16 Z M72.0070969,64 C67.5848994,64 64,67.5881712 64,72.0070969 L64,103.992903 C64,108.415101 67.5881712,112 72.0070969,112 L103.992903,112 C108.415101,112 112,108.411829 112,103.992903 L112,72.0070969 C112,67.5848994 108.411829,64 103.992903,64 L72.0070969,64 L72.0070969,64 Z M24.0034204,80 C19.5832534,80 16,83.5776607 16,87.9924054 L16,104.007595 C16,108.421678 19.5863782,112 24.0034204,112 L38.9965796,112 C43.4167466,112 47,108.422339 47,104.007595 L47,87.9924054 C47,83.5783218 43.4136218,80 38.9965796,80 L24.0034204,80 L24.0034204,80 Z M104,16 C99.581722,16 96,19.5776607 96,23.9924054 L96,40.0075946 C96,44.4216782 99.5907123,48 104,48 C108.418278,48 112,44.4223393 112,40.0075946 L112,23.9924054 C112,19.5783218 108.409288,16 104,16 L104,16 Z"></path> <path d="M8.00697327,0 C3.58484404,0 0,3.59075293 0,8.00697327 L0,119.993027 C0,124.415156 3.59075293,128 8.00697327,128 L119.993027,128 C124.415156,128 128,124.409247 128,119.993027 L128,8.00697327 C128,3.58484404 124.409247,0 119.993027,0 L8.00697327,0 L8.00697327,0 Z M23.9949725,16 C19.5794711,16 16,19.5776607 16,23.9924054 L16,40.0075946 C16,44.4216782 19.5905136,48 23.9949725,48 L71.0050275,48 C75.4205289,48 79,44.4223393 79,40.0075946 L79,23.9924054 C79,19.5783218 75.4094864,16 71.0050275,16 L23.9949725,16 L23.9949725,16 Z M72.0070969,64 C67.5848994,64 64,67.5881712 64,72.0070969 L64,103.992903 C64,108.415101 67.5881712,112 72.0070969,112 L103.992903,112 C108.415101,112 112,108.411829 112,103.992903 L112,72.0070969 C112,67.5848994 108.411829,64 103.992903,64 L72.0070969,64 L72.0070969,64 Z M24.0034204,80 C19.5832534,80 16,83.5776607 16,87.9924054 L16,104.007595 C16,108.421678 19.5863782,112 24.0034204,112 L38.9965796,112 C43.4167466,112 47,108.422339 47,104.007595 L47,87.9924054 C47,83.5783218 43.4136218,80 38.9965796,80 L24.0034204,80 L24.0034204,80 Z M104,16 C99.581722,16 96,19.5776607 96,23.9924054 L96,40.0075946 C96,44.4216782 99.5907123,48 104,48 C108.418278,48 112,44.4223393 112,40.0075946 L112,23.9924054 C112,19.5783218 108.409288,16 104,16 L104,16 Z"></path>
</g> </g>

3
plugins/tiddlywiki/classictools/plugin.info
View File

@ -2,5 +2,6 @@
"title": "$:/plugins/tiddlywiki/classictools", "title": "$:/plugins/tiddlywiki/classictools",
"description": "TiddlyWiki Classic manipulation tools", "description": "TiddlyWiki Classic manipulation tools",
"author": "JeremyRuston", "author": "JeremyRuston",
"core-version": ">=5.0.0" "core-version": ">=5.0.0",
"list": "readme"
} }

12
plugins/tiddlywiki/classictools/readme.tid Normal file
View File

@ -0,0 +1,12 @@
title: $:/plugins/tiddlywiki/classictools/readme
This plugin provides facilities for working with TiddlyWiki Classic. It is used in the build process for TiddlyWiki Classic.
The additional features are:
* A ''tiddlerdeserializer'' module for reading TiddlyWiki Classic `.recipe` files
* Templates for building TiddlyWiki Classic.
See https://github.com/TiddlyWiki/tiddlywiki.com for more details.
[[Source code|https://github.com/Jermolene/TiddlyWiki5/blob/master/plugins/tiddlywiki/classictools]]

2
plugins/tiddlywiki/codemirror/plugin.info
View File

@ -2,5 +2,5 @@
"title": "$:/plugins/tiddlywiki/codemirror", "title": "$:/plugins/tiddlywiki/codemirror",
"description": "CodeMirror: text editor", "description": "CodeMirror: text editor",
"author": "JeremyRuston", "author": "JeremyRuston",
"list": "readme" "list": "readme usage"
} }

9
plugins/tiddlywiki/codemirror/readme.tid → plugins/tiddlywiki/codemirror/usage.tid
View File

@ -1,11 +1,4 @@
title: $:/plugins/tiddlywiki/codemirror/readme title: $:/plugins/tiddlywiki/codemirror/usage
The CodeMirror plugin brings many features:
* Code colouring for many languages (see [[the official documentation here|http://codemirror.net/mode/index.html]])
* Auto closing brackets and tags
* Folding brackets, comments, and tags
* Auto-completion
! Setting ~CodeMirror Content Types ! Setting ~CodeMirror Content Types

3
plugins/tiddlywiki/d3/plugin.info
View File

@ -2,5 +2,6 @@
"title": "$:/plugins/tiddlywiki/d3", "title": "$:/plugins/tiddlywiki/d3",
"description": "D3: data visualisation", "description": "D3: data visualisation",
"author": "JeremyRuston", "author": "JeremyRuston",
"core-version": ">=5.0.0" "core-version": ">=5.0.0",
"list": "readme"
} }

7
plugins/tiddlywiki/d3/readme.tid Normal file
View File

@ -0,0 +1,7 @@
title: $:/plugins/tiddlywiki/d3/readme
The D3 plugin is a proof-of-concept demo of integration with the D3.js data visualisation framework (http://d3js.org).
It is not currently in a state where it can be used for anything useful.
[[Source code|https://github.com/Jermolene/TiddlyWiki5/blob/master/plugins/tiddlywiki/d3]]

3
plugins/tiddlywiki/filesystem/plugin.info
View File

@ -2,5 +2,6 @@
"title": "$:/plugins/tiddlywiki/filesystem", "title": "$:/plugins/tiddlywiki/filesystem",
"description": "Local filesystem syncadaptor", "description": "Local filesystem syncadaptor",
"author": "JeremyRuston", "author": "JeremyRuston",
"core-version": ">=5.0.0" "core-version": ">=5.0.0",
"list": "readme"
} }

5
plugins/tiddlywiki/filesystem/readme.tid Normal file
View File

@ -0,0 +1,5 @@
title: $:/plugins/tiddlywiki/filesystem/readme
The filesystem plugin is used under Node.js to synchronise tiddler changes back to the file system. It is inert when used in the browser.
[[Source code|https://github.com/Jermolene/TiddlyWiki5/blob/master/plugins/tiddlywiki/filesystem]]

2
plugins/tiddlywiki/github-fork-ribbon/plugin.info
View File

@ -2,5 +2,5 @@
"title": "$:/plugins/tiddlywiki/github-fork-ribbon", "title": "$:/plugins/tiddlywiki/github-fork-ribbon",
"description": "Corner ribbon", "description": "Corner ribbon",
"author": "Simon Whitaker, adapted for TiddlyWiki by JeremyRuston", "author": "Simon Whitaker, adapted for TiddlyWiki by JeremyRuston",
"list": "readme" "list": "readme usage"
} }

7
plugins/tiddlywiki/github-fork-ribbon/readme.tid → plugins/tiddlywiki/github-fork-ribbon/usage.tid
View File

@ -1,9 +1,4 @@
title: $:/plugins/tiddlywiki/github-fork-ribbon/readme title: $:/plugins/tiddlywiki/github-fork-ribbon/usage
This stylesheet is adapted from work by Simon Whitaker:
https://github.com/simonwhitaker/github-fork-ribbon-css/
``` ```
<!-- TOP RIGHT RIBBON: START COPYING HERE --> <!-- TOP RIGHT RIBBON: START COPYING HERE -->

2
plugins/tiddlywiki/googleanalytics/plugin.info
View File

@ -3,5 +3,5 @@
"description": "Google Analytics: website statistics", "description": "Google Analytics: website statistics",
"author": "JeremyRuston", "author": "JeremyRuston",
"core-version": ">=5.0.0", "core-version": ">=5.0.0",
"list": "readme" "list": "readme usage"
} }

14
plugins/tiddlywiki/googleanalytics/readme.tid
View File

@ -1,15 +1,5 @@
title: $:/plugins/tiddlywiki/googleanalytics/readme title: $:/plugins/tiddlywiki/googleanalytics/readme
This plugin enables you to use Google Analytics to track access to your online TiddlyWiki document. These instructions assume you are using TiddlySpot to publish your wiki. This plugin enables you to use Google Analytics to track access to your online TiddlyWiki document.
# Go to the Google Analytics website: http://www.google.com/analytics/ [[Source code|https://github.com/Jermolene/TiddlyWiki5/blob/master/plugins/tiddlywiki/googleanalytics]]
# Click the ''Access Google Analytics'' button and follow instructions to set up your account
# Enter the name of your TiddlySpot domain, for example "mysite.tiddlyspot.com"
# You will be given your own Tracking ID for this domain
# Go to http://tiddlywiki.com -- open the More/System tab and drag the links to these three tiddlers across to a local copy of your site:
#* [[$:/GoogleAnalyticsDomain]]
#* [[$:/GoogleAnalyticsAccount]]
#* [[$:/plugins/tiddlywiki/googleanalytics]]
# Edit the first two of these tiddlers to reflect your Domain and Tracking ID
# Upload the new version to TiddlySpot or other web host
# Return to your Google Analytics page to check that your site is being tracked

16
plugins/tiddlywiki/googleanalytics/usage.tid Normal file
View File

@ -0,0 +1,16 @@
title: $:/plugins/tiddlywiki/googleanalytics/usage
These instructions assume you are using TiddlySpot to publish your wiki.
# Go to the Google Analytics website: http://www.google.com/analytics/
# Click the ''Access Google Analytics'' button and follow instructions to set up your account
# Enter the name of your TiddlySpot domain, for example "mysite.tiddlyspot.com"
# You will be given your own Tracking ID for this domain
# Go to http://tiddlywiki.com -- open the More/System tab and drag the links to these three tiddlers across to a local copy of your site:
#* [[$:/GoogleAnalyticsDomain]]
#* [[$:/GoogleAnalyticsAccount]]
#* [[$:/plugins/tiddlywiki/googleanalytics]]
# Edit the first two of these tiddlers to reflect your Domain and Tracking ID
# Upload the new version to TiddlySpot or other web host
# Return to your Google Analytics page to check that your site is being tracked

2
plugins/tiddlywiki/help/readme.tid
View File

@ -1,3 +1,5 @@
title: $:/plugins/tiddlywiki/help/readme title: $:/plugins/tiddlywiki/help/readme
This plugin provides an overlay help panel at the bottom right of the window. This plugin provides an overlay help panel at the bottom right of the window.
[[Source code|https://github.com/Jermolene/TiddlyWiki5/blob/master/plugins/tiddlywiki/help]]

3
plugins/tiddlywiki/highlight/plugin.info
View File

@ -2,5 +2,6 @@
"title": "$:/plugins/tiddlywiki/highlight", "title": "$:/plugins/tiddlywiki/highlight",
"description": "Highlight.js: syntax highlighting", "description": "Highlight.js: syntax highlighting",
"author": "JoaoBolila", "author": "JoaoBolila",
"list": "license" "core-version": ">=5.0.0",
"list": "readme usage license"
} }

5
plugins/tiddlywiki/highlight/readme.tid Normal file
View File

@ -0,0 +1,5 @@
title: $:/plugins/tiddlywiki/highlight/readme
This plugin provides syntax highlighting of code blocks using [[highlight.js|https://github.com/isagalaev/highlight.js]] from Ivan Sagalaev.
[[Source code|https://github.com/Jermolene/TiddlyWiki5/blob/master/plugins/tiddlywiki/highlight]]

16
plugins/tiddlywiki/highlight/usage.tid Normal file
View File

@ -0,0 +1,16 @@
title: $:/plugins/tiddlywiki/highlight/usage
! Usage
Fenced code blocks can have a language specifier added to trigger highlighting in a specific language. Otherwise heuristics are used to detect the language.
```
```js
var a = b + c; // Highlighted as JavaScript
```
```
! Adding Themes
You can add themes from highlight.js by copying the CSS to a new tiddler and tagging it with [[$:/tags/Stylesheet]]. The available themes can be found on GitHub:
https://github.com/isagalaev/highlight.js/tree/master/src/styles

3
plugins/tiddlywiki/jasmine/plugin.info
View File

@ -2,5 +2,6 @@
"title": "$:/plugins/tiddlywiki/jasmine", "title": "$:/plugins/tiddlywiki/jasmine",
"description": "Jasmine: testing framework", "description": "Jasmine: testing framework",
"author": "JeremyRuston", "author": "JeremyRuston",
"core-version": ">=5.0.0" "core-version": ">=5.0.0",
"list": "readme"
} }

5
plugins/tiddlywiki/jasmine/readme.tid Normal file
View File

@ -0,0 +1,5 @@
title: $:/plugins/tiddlywiki/jasmine/readme
This plugin provides a framework for running tests in the browser and under Node.js. It is based on [[Jasmine|http://pivotal.github.io/jasmine/]] test framework.
[[Source code|https://github.com/Jermolene/TiddlyWiki5/blob/master/plugins/tiddlywiki/jasmine]]

4
plugins/tiddlywiki/katex/plugin.info
View File

@ -1,5 +1,7 @@
{ {
"title": "$:/plugins/tiddlywiki/katex", "title": "$:/plugins/tiddlywiki/katex",
"description": "KaTeX: mathematical typography", "description": "KaTeX: mathematical typography",
"author": "JeremyRuston" "author": "JeremyRuston",
"core-version": ">=5.0.0",
"list": "readme usage"
} }

7
plugins/tiddlywiki/katex/readme.tid Normal file
View File

@ -0,0 +1,7 @@
title: $:/plugins/tiddlywiki/katex/readme
This is a TiddlyWiki plugin for mathematical typesetting based on [[KaTeX from Khan Academy|http://khan.github.io/KaTeX/]].
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.
[[Source code|https://github.com/Jermolene/TiddlyWiki5/blob/master/plugins/tiddlywiki/katex]]

15
plugins/tiddlywiki/katex/usage.tid Normal file
View File

@ -0,0 +1,15 @@
title: $:/plugins/tiddlywiki/katex/usage
The usual way to include ~LaTeX is to use `$$`. For example:
```
$$\displaystyle f(x) = \int_{-\infty}^\infty\hat f(\xi)\,e^{2 \pi i \xi x}\,d\xi$$
```
The underlying widget can also be used directly, giving more flexibility:
```
<$latex text="\displaystyle f(x) = \int_{-\infty}^\infty\hat f(\xi)\,e^{2 \pi i \xi x}\,d\xi"></$latex>
```
The KaTeX widget is provided under the name `<$latex>` and is also available under the alias `<$katex>`. It's better to use the generic `<$latex>` name unless you are running multiple ~LaTeX plugins and wish to specifically target KaTeX.

4
plugins/tiddlywiki/markdown/plugin.info
View File

@ -1,5 +1,7 @@
{ {
"title": "$:/plugins/tiddlywiki/markdown", "title": "$:/plugins/tiddlywiki/markdown",
"description": "Markdown parser", "description": "Markdown parser",
"author": "JeremyRuston" "author": "JeremyRuston",
"core-version": ">=5.0.0",
"list": "readme usage"
} }

7
plugins/tiddlywiki/markdown/readme.tid Normal file
View File

@ -0,0 +1,7 @@
title: $:/plugins/tiddlywiki/markdown/readme
This is a TiddlyWiki plugin for parsing Markdown text, based on the [[markdown-js|https://github.com/evilstreak/markdown-js]] project from Dominic Baggott.
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.
[[Source code|https://github.com/Jermolene/TiddlyWiki5/blob/master/plugins/tiddlywiki/markdown]]

30
plugins/tiddlywiki/markdown/usage.tid Normal file
View File

@ -0,0 +1,30 @@
title: $:/plugins/tiddlywiki/markdown/usage
! Markdown Dialects
By default the markdown parser recognises the original dialect of Markdown [[as described by John Gruber|http://daringfireball.net/projects/markdown/]]. An extended dialect called "Maruku" is also included that provides table support and other advanced features. The syntax extensions are modelled on those of [[PHP Markdown Extra|https://michelf.ca/projects/php-markdown/extra/]].
The configuration tiddler [[$:/config/markdown/dialect]] determines which dialect is used:
|!Dialect |!Description |
|Gruber |Standard Markdown |
|Maruku |Extended Maruku Markdown |
! Creating ~WikiLinks
Create wiki links with the usual Markdown link syntax targeting `#` and the target tiddler title:
```
[link text](#TiddlerTitle)
```
! Images
Markdown image syntax can be used to reference images by tiddler title or an external URI. For example:
```
![alt text](/path/to/img.jpg "Title")
![alt text](Motovun Jack.jpg "Title")
```

3
plugins/tiddlywiki/nodewebkitsaver/plugin.info
View File

@ -2,5 +2,6 @@
"title": "$:/plugins/tiddlywiki/nodewebkitsaver", "title": "$:/plugins/tiddlywiki/nodewebkitsaver",
"description": "NW.js saver", "description": "NW.js saver",
"author": "JeremyRuston", "author": "JeremyRuston",
"core-version": ">=5.0.0" "core-version": ">=5.0.0",
"list": "readme"
} }

5
plugins/tiddlywiki/nodewebkitsaver/readme.tid Normal file
View File

@ -0,0 +1,5 @@
title: $:/plugins/tiddlywiki/nodewebkitsaver/readme
This plugin provides a ''saver'' module for saving changes when using TiddlyWiki directly under NW.js (previously known as node-webkit).
[[Source code|https://github.com/Jermolene/TiddlyWiki5/blob/master/plugins/tiddlywiki/nodewebkitsaver]]

3
plugins/tiddlywiki/pluginlibrary/plugin.info
View File

@ -2,5 +2,6 @@
"title": "$:/plugins/tiddlywiki/pluginlibrary", "title": "$:/plugins/tiddlywiki/pluginlibrary",
"description": "Plugin library builder", "description": "Plugin library builder",
"author": "JeremyRuston", "author": "JeremyRuston",
"core-version": ">=5.0.0" "core-version": ">=5.0.0",
"list": "readme"
} }

5
plugins/tiddlywiki/pluginlibrary/readme.tid Normal file
View File

@ -0,0 +1,5 @@
title: $:/plugins/tiddlywiki/pluginlibrary/readme
This plugin is used behind the scenes by TiddlyWiki to build the plugin library.
[[Source code|https://github.com/Jermolene/TiddlyWiki5/blob/master/plugins/tiddlywiki/pluginlibrary]]

18
plugins/tiddlywiki/railroad/doc/readme.tid
View File

@ -7,21 +7,3 @@ This plugin provides a `<$railroad>` widget for generating railroad diagrams as
Alternatively, the [[diagram notation|$:/plugins/tiddlywiki/railroad/syntax]] can be stored in a dedicated tiddler with its `type` field set to `text/vnd.tiddlywiki.railroad`, and that tiddler can simply be transcluded to wherever it is needed. Alternatively, the [[diagram notation|$:/plugins/tiddlywiki/railroad/syntax]] can be stored in a dedicated tiddler with its `type` field set to `text/vnd.tiddlywiki.railroad`, and that tiddler can simply be transcluded to wherever it is needed.
The plugin is based on [[a library by Tab Atkins|https://github.com/tabatkins/railroad-diagrams]], and has been extended to make it more flexible, including allowing components of a diagram to function as links or be transcluded from other tiddlers. The plugin is based on [[a library by Tab Atkins|https://github.com/tabatkins/railroad-diagrams]], and has been extended to make it more flexible, including allowing components of a diagram to function as links or be transcluded from other tiddlers.
The content of the `<$railroad>` widget is ignored.
|!Attribute |!Description |!Default |
|text |Text in a special notation that defines the diagram's layout |-- |
|arrow |If set to `no`, repeat paths do not have an arrow on them |`yes` |
|start |Style of the startpoint: `single`, `double`, `none` |`single` |
|end |Style of the endpoint: `single`, `double`, `none` |`single` |
|debug |If set to `yes`, the diagram displays its parse tree |`no` |
These options can also be specified via pragmas in the diagram notation, or globally via a dictionary tiddler called `$:/config/railroad`:
```
arrow: yes
start: single
end: single
debug: no
```

21
plugins/tiddlywiki/railroad/doc/usage.tid Normal file
View File

@ -0,0 +1,21 @@
created: 20150102163222184
modified: 20150119231005000
title: $:/plugins/tiddlywiki/railroad/usage
The content of the `<$railroad>` widget is ignored.
|!Attribute |!Description |!Default |
|text |Text in a special notation that defines the diagram's layout |-- |
|arrow |If set to `no`, repeat paths do not have an arrow on them |`yes` |
|start |Style of the startpoint: `single`, `double`, `none` |`single` |
|end |Style of the endpoint: `single`, `double`, `none` |`single` |
|debug |If set to `yes`, the diagram displays its parse tree |`no` |
These options can also be specified via pragmas in the diagram notation, or globally via a dictionary tiddler called `$:/config/railroad`:
```
arrow: yes
start: single
end: single
debug: no
```

2
plugins/tiddlywiki/railroad/plugin.info
View File

@ -3,5 +3,5 @@
"description": "Railroad diagram generator", "description": "Railroad diagram generator",
"author": "AstridElocson", "author": "AstridElocson",
"plugin-type": "plugin", "plugin-type": "plugin",
"list": "readme syntax example" "list": "readme usage syntax example"
} }

4
plugins/tiddlywiki/stacked-view/readme.tid
View File

@ -1,3 +1,5 @@
title: $:/plugins/tiddlywiki/stacked-view/readme title: $:/plugins/tiddlywiki/stacked-view/readme
This plugin provides a new story visualisation that displays individual tiddlers as a stack of cards. It is currently incomplete. This plugin provides a new story visualisation that displays individual tiddlers as a stack of cards. It is currently experimental and incomplete.
[[Source code|https://github.com/Jermolene/TiddlyWiki5/blob/master/plugins/tiddlywiki/stacked-view]]

2
plugins/tiddlywiki/stacked-view/storyview-stacked.tid
View File

@ -1,7 +1,7 @@
title: $:/core/images/storyview-stacked title: $:/core/images/storyview-stacked
tags: $:/tags/Image tags: $:/tags/Image
<svg class="tc-image-storyview-stack tc-image-button" width="22pt" height="22pt" viewBox="0 0 129 129"> <svg class="tc-image-storyview-stack tc-image-button" width="22pt" height="22pt" viewBox="0 0 128 128">
<g fill-rule="evenodd"> <g fill-rule="evenodd">
<path d="M8.00697327,0 C3.58484404,0 0,3.59075293 0,8.00697327 L0,119.993027 C0,124.415156 3.59075293,128 8.00697327,128 L119.993027,128 C124.415156,128 128,124.409247 128,119.993027 L128,8.00697327 C128,3.58484404 124.409247,0 119.993027,0 L8.00697327,0 L8.00697327,0 Z M32,43 L32,37.3807213 C32,34.4040057 34.3875896,32 37.3328305,32 L45.5,32 L45.5,32 L84,32 L90.6671695,32 C93.6079301,32 96,34.409031 96,37.3807213 L96,43 L32,43 Z M30,48 L23.9992458,48 C19.5813843,48 16,51.578055 16,56.0085154 L16,103.991485 C16,108.414466 19.5881049,112 23.9992458,112 L104.000754,112 C108.418616,112 112,108.421945 112,103.991485 L112,56.0085154 C112,51.5855345 108.411895,48 104.000754,48 L98.5,48 L30,48 Z M80,27 L80,23.7529272 C80,22.2325275 78.803965,21 77.3335847,21 L50.6664153,21 C49.1937948,21 48,22.2299564 48,23.7529272 L48,27 L80,27 Z"></path> <path d="M8.00697327,0 C3.58484404,0 0,3.59075293 0,8.00697327 L0,119.993027 C0,124.415156 3.59075293,128 8.00697327,128 L119.993027,128 C124.415156,128 128,124.409247 128,119.993027 L128,8.00697327 C128,3.58484404 124.409247,0 119.993027,0 L8.00697327,0 L8.00697327,0 Z M32,43 L32,37.3807213 C32,34.4040057 34.3875896,32 37.3328305,32 L45.5,32 L45.5,32 L84,32 L90.6671695,32 C93.6079301,32 96,34.409031 96,37.3807213 L96,43 L32,43 Z M30,48 L23.9992458,48 C19.5813843,48 16,51.578055 16,56.0085154 L16,103.991485 C16,108.414466 19.5881049,112 23.9992458,112 L104.000754,112 C108.418616,112 112,108.421945 112,103.991485 L112,56.0085154 C112,51.5855345 108.411895,48 104.000754,48 L98.5,48 L30,48 Z M80,27 L80,23.7529272 C80,22.2325275 78.803965,21 77.3335847,21 L50.6664153,21 C49.1937948,21 48,22.2299564 48,23.7529272 L48,27 L80,27 Z"></path>
</g> </g>

3
plugins/tiddlywiki/tahoelafs/plugin.info
View File

@ -2,5 +2,6 @@
"title": "$:/plugins/tiddlywiki/tahoelafs", "title": "$:/plugins/tiddlywiki/tahoelafs",
"description": "Tahoe-LAFS saver", "description": "Tahoe-LAFS saver",
"author": "JeremyRuston", "author": "JeremyRuston",
"core-version": ">=5.0.0" "core-version": ">=5.0.0",
"list": "readme"
} }

7
plugins/tiddlywiki/tahoelafs/readme.tid Normal file
View File

@ -0,0 +1,7 @@
title: $:/plugins/tiddlywiki/tahoelafs/readme
This plugin provides a ''saver'' module for saving changes under the [[Tahoe Least Authority File System|https://tahoe-lafs.org/]].
At this point it is largely for experimentation by @zooko.
[[Source code|https://github.com/Jermolene/TiddlyWiki5/blob/master/plugins/tiddlywiki/tahoelafs]]

3
plugins/tiddlywiki/tiddlyweb/plugin.info
View File

@ -2,5 +2,6 @@
"title": "$:/plugins/tiddlywiki/tiddlyweb", "title": "$:/plugins/tiddlywiki/tiddlyweb",
"description": "TiddlyWeb and TiddlySpace components", "description": "TiddlyWeb and TiddlySpace components",
"author": "JeremyRuston", "author": "JeremyRuston",
"core-version": ">=5.0.0" "core-version": ">=5.0.0",
"list": "readme"
} }

5
plugins/tiddlywiki/tiddlyweb/readme.tid Normal file
View File

@ -0,0 +1,5 @@
title: $:/plugins/tiddlywiki/tiddlyweb/readme
This plugin runs in the browser to synchronise tiddler changes to and from a TiddlyWeb-compatible server (including TiddlyWiki 5 itself). It is inert when run under Node.js.
[[Source code|https://github.com/Jermolene/TiddlyWiki5/blob/master/plugins/tiddlywiki/tiddlyweb]]

1
plugins/tiddlywiki/translators/plugin.info
View File

@ -2,5 +2,6 @@
"title": "$:/plugins/tiddlywiki/translators", "title": "$:/plugins/tiddlywiki/translators",
"description": "Translation editing tools", "description": "Translation editing tools",
"author": "JeremyRuston", "author": "JeremyRuston",
"core-version": ">=5.0.0",
"list": "readme" "list": "readme"
} }

4
plugins/tiddlywiki/translators/readme.tid
View File

@ -1,3 +1,5 @@
title: $:/plugins/tiddlywiki/translators/readme title: $:/plugins/tiddlywiki/translators/readme
This plugin exposes a new system tiddler [[$:/Translators]] that presents a user interface for creating and maintaining translations. This plugin exposes a new system tiddler [[$:/Translators]] that presents a user interface for creating and maintaining translations. It is used to build the special [[translators edition|http://tiddlywiki.com/editions/translators]].
[[Source code|https://github.com/Jermolene/TiddlyWiki5/blob/master/plugins/tiddlywiki/translators]]

2
plugins/tiddlywiki/tw2parser/plugin.info
View File

@ -3,5 +3,5 @@
"description": "TiddlyWiki Classic parser", "description": "TiddlyWiki Classic parser",
"authors": "JeremyRuston, JeffreyWilkinson", "authors": "JeremyRuston, JeffreyWilkinson",
"core-version": ">=5.0.15", "core-version": ">=5.0.15",
"plugin-type": "plugin" "list": "readme"
} }

5
plugins/tiddlywiki/tw2parser/readme.tid Normal file
View File

@ -0,0 +1,5 @@
title: $:/plugins/tiddlywiki/tw2parser/readme
This experimental plugin provides support for parsing and rendering tiddlers written in TiddlyWiki Classic format (`text/x-tiddlywiki`).
[[Source code|https://github.com/Jermolene/TiddlyWiki5/blob/master/plugins/tiddlywiki/tw2parser]]

3
plugins/tiddlywiki/upgrade/plugin.info
View File

@ -2,5 +2,6 @@
"title": "$:/plugins/tiddlywiki/upgrade", "title": "$:/plugins/tiddlywiki/upgrade",
"description": "Upgrade system for TiddlyWiki versions", "description": "Upgrade system for TiddlyWiki versions",
"author": "JeremyRuston", "author": "JeremyRuston",
"core-version": ">=5.0.0" "core-version": ">=5.0.0",
"list": "readme"
} }

5
plugins/tiddlywiki/upgrade/readme.tid Normal file
View File

@ -0,0 +1,5 @@
title: $:/plugins/tiddlywiki/upgrade/readme
This plugin contains the user interface components used to build the special [[upgrade edition|http://tiddlywiki.com/upgrade.html]].
[[Source code|https://github.com/Jermolene/TiddlyWiki5/blob/master/plugins/tiddlywiki/upgrade]]