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