TiddlyWiki5

mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-12-29 11:30:28 +00:00

History

Astrid Elocson 0d406966b3 Improve railroad example tiddler		2015-01-20 09:08:29 +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	Support a global railroad config tiddler	2015-01-19 23:11:25 +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

readme.tid

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.

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
```