mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-07-07 12:34:22 +00:00
20 lines
926 B
Plaintext
20 lines
926 B
Plaintext
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. |