TiddlyWiki5/plugins/tiddlywiki/railroad/doc/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 |
|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.
Introduce railroad plugin 2015-01-03 20:02:27 +00:00			`created: 20150102163222184`
			`modified: 20150102172016663`
			`title: $:/plugins/tiddlywiki/railroad/readme`

Links and transclusions in railroad diagrams 2015-01-06 01:39:24 +00:00			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.
Introduce railroad plugin 2015-01-03 20:02:27 +00:00
			The content of the `<$railroad>` widget is ignored.

			`\|!Attribute \|!Description \|`
			`\|text \|Text in a special syntax that defines the diagram's layout \|`
			\|mode \|If set to `debug`, the diagram will display its internal tree structure. The default mode is `svg` \|

Links and transclusions in railroad diagrams 2015-01-06 01:39:24 +00:00			The entire `text` can be transcluded from another tiddler:
Introduce railroad plugin 2015-01-03 20:02:27 +00:00
			```
			`<$railroad tiddler={{diagram}}>`
Links and transclusions in railroad diagrams 2015-01-06 01:39:24 +00:00			```

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