1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-12-29 11:30:28 +00:00
TiddlyWiki5/plugins/tiddlywiki/railroad/doc
Jermolene f2a7f00870 Improve plugin readmes
Now every plugin has a short, introductory readme tiddler that is shown
in the online plugin library.
2015-03-19 10:53:45 +00:00
..
example-source.tid Introduce text/vnd.tiddlywiki.railroad 2015-01-19 22:21:22 +00:00
example.tid Improve railroad example tiddler 2015-01-20 09:08:29 +00:00
readme.tid Improve plugin readmes 2015-03-19 10:53:45 +00:00
syntax-string.tid Introduce railroad plugin 2015-01-03 20:02:27 +00:00
syntax.tid Introduce text/vnd.tiddlywiki.railroad 2015-01-19 22:21:22 +00:00
usage.tid Improve plugin readmes 2015-03-19 10:53:45 +00:00

created: 20150102163222184
modified: 20150119231005000
title: $:/plugins/tiddlywiki/railroad/readme

This plugin provides a `<$railroad>` widget for generating railroad diagrams as SVG images.

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.