doc/plugins/contrib/mscgen.mdwn

   1 [[!tag type/widget]]
   2
   3 This plugin provides the mscgen [[ikiwiki/directive]].
   4 This directive allows embedding [mscgen](http://www.mcternan.me.uk/mscgen/)
   5 message sequence chart graphs in a page.
   6
   7 Here's an mscgen source example.
   8
   9     \[[!msc src="""
  10       arcgradient = 8;
  11
  12       a [label="Client"],b [label="Server"];
  13
  14       a=>b [label="data1"];
  15       a-xb [label="data2"];
  16       a=>b [label="data3"];
  17       a<=b [label="ack1, nack2"];
  18       a=>b [label="data2", arcskip="1"];
  19       |||;
  20       a<=b [label="ack3"];
  21       |||;
  22     """]]
  23
  24 And here's the resulting graph.
  25
  26 [[!msc src=<<"""
  27   arcgradient = 8;
  28
  29   a [label="Client"],b [label="Server"];
  30
  31   a=>b [label="data1"];
  32   a-xb [label="data2"];
  33   a=>b [label="data3"];
  34   a<=b [label="ack1, nack2"];
  35   a=>b [label="data2", arcskip="1"];
  36   |||;
  37   a<=b [label="ack3"];
  38   |||;
  39 """]]
  40
  41 Security implications: to be determined.
  42
  43 This plugin uses the [[!cpan Digest::SHA]] perl module.
  44
  45 This plugin borrows heavily from the [[graphviz|plugins/graphviz]] plugin written by [[JoshTriplett]].