TiddlyWiki5

mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-27 03:57:21 +00:00

History

Astrid Elocson 2d86d8e47d Introduce arrow option on railroad widget		2015-01-12 20:03:37 +00:00
..
example-source.tid	Links and transclusions in railroad diagrams	2015-01-06 01:39:24 +00:00
example.tid	Links and transclusions in railroad diagrams	2015-01-06 01:39:24 +00:00
readme.tid	Introduce arrow option on railroad widget	2015-01-12 20:03:37 +00:00
syntax-string.tid	Introduce railroad plugin	2015-01-03 20:02:27 +00:00
syntax.tid	Links and transclusions in railroad diagrams	2015-01-06 01:39:24 +00:00

readme.tid

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

This plugin provides a `<$railroad>` widget for generating railroad syntax diagrams as SVG images. It is based on [[a library by Tab Atkins|https://github.com/tabatkins/railroad-diagrams]], and has been extended to allow components of a diagram to function as links.

The content of the `<$railroad>` widget is ignored.

|!Attribute |!Description |
|text |Text in a special syntax that defines the diagram's layout |
|arrow |If set to `no`, repeat paths do not have an arrow on them. The default is `yes` |
|mode |If set to `debug`, the diagram will display its internal tree structure. The default mode is `svg` |

The entire `text` can be transcluded from another tiddler:

```
<$railroad tiddler={{diagram}}>
```

Alternatively, the diagram syntax allows specific parts of the `text` to be transcluded from other tiddlers.