TiddlyWiki5/plugins/tiddlywiki/railroad/doc
Mario Pietsch 416a2fae7a
Add syntax docs to railroad plugin (#7334)
2023-03-06 16:12:26 +00:00
..
example-source.tid Introduce text/vnd.tiddlywiki.railroad 2015-01-19 22:21:22 +00:00
example-transclusion.tid Add syntax docs to railroad plugin (#7334) 2023-03-06 16:12:26 +00:00
example.tid Revert "Add text/vnd.tiddlywiki to system tiddlers within plugins that should be wikified (c.f. #2883)" 2017-06-24 17:48:32 +01:00
readme.tid Revert "Add text/vnd.tiddlywiki to system tiddlers within plugins that should be wikified (c.f. #2883)" 2017-06-24 17:48:32 +01:00
syntax-string.tid Introduce railroad plugin 2015-01-03 20:02:27 +00:00
syntax.tid Add syntax docs to railroad plugin (#7334) 2023-03-06 16:12:26 +00:00
usage.tid Revert "Add text/vnd.tiddlywiki to system tiddlers within plugins that should be wikified (c.f. #2883)" 2017-06-24 17:48:32 +01: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.