blob: 792aaa4e3fa20003e3261260fda40189db87c12f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
|
[[!template id=plugin name=mscgen author="[[users/Tjgolubi]]"]]
[[!tag type/widget]]
## NAME
IkiWiki::Plugin::mscgen - embed message sequence chart
## SYNOPSIS
In the ikiwiki setup file, enable this plugin by adding it to the list of active plugins.
add_plugins:
- mscgen
## DESCRIPTION
This plugin provides the msc [[ikiwiki/directive]].
This directive allows embedding [mscgen](http://www.mcternan.me.uk/mscgen/)
message sequence chart graphs in an ikiwiki page.
Here's an example that shows how an mscgen message sequence chart is embedded into an ikiwiki page.
\[[!msc src="""
arcgradient = 8;
a [label="Client"],b [label="Server"];
a=>b [label="data1"];
a-xb [label="data2"];
a=>b [label="data3"];
a<=b [label="ack1, nack2"];
a=>b [label="data2", arcskip="1"];
|||;
a<=b [label="ack3"];
|||;
"""]]
Security implications: to be determined.
This plugin borrows heavily from the [[graphviz|plugins/graphviz]] plugin written by [[JoshTriplett]].
## PREREQUISITES
IkiWiki
mscgen
Digest::SHA
## DOWNLOAD
* browse at GitHub: <http://github.com/tjgolubi/ikiwiki.mscgen>
* repo at git://github.com/tjgolubi/ikiwiki.mscgen.git
|