aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/contrib
diff options
context:
space:
mode:
authorhttps://www.google.com/accounts/o8/id?id=AItOawlkQOG_UxmAVOjXBQJLpiBmBWXEiTL9PYw <Terry@web>2011-11-05 23:40:02 -0400
committeradmin <admin@branchable.com>2011-11-05 23:40:02 -0400
commit60ea247480e3afd12de42a6ea71454d61a302108 (patch)
tree09751d926a12de573136e149a996d1298b8ec3e1 /doc/plugins/contrib
parentf7d642421144388130ecd4ecd51e892ae8b3e1f6 (diff)
downloadikiwiki-60ea247480e3afd12de42a6ea71454d61a302108.tar
ikiwiki-60ea247480e3afd12de42a6ea71454d61a302108.tar.gz
Added mscgen plugin.
Diffstat (limited to 'doc/plugins/contrib')
-rw-r--r--doc/plugins/contrib/mscgen.mdwn53
1 files changed, 53 insertions, 0 deletions
diff --git a/doc/plugins/contrib/mscgen.mdwn b/doc/plugins/contrib/mscgen.mdwn
new file mode 100644
index 000000000..d7eb23a6d
--- /dev/null
+++ b/doc/plugins/contrib/mscgen.mdwn
@@ -0,0 +1,53 @@
+[[!template id=plugin name=mscgen author="[[TerryGolubiewski]]"]
+[[!tag type/widget]]
+
+This plugin provides the mscgen [[ikiwiki/directive]].
+This directive allows embedding [mscgen](http://www.mcternan.me.uk/mscgen/)
+message sequence chart graphs in a page.
+
+Here's an mscgen source example.
+
+ \[[!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
+
+[[!if test="enabled(mscgen)" then="""
+And here's the resulting graph.
+
+[[!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"];
+ |||;
+"""]]
+
+"""]]
+
+This plugin uses the [[!cpan Digest::SHA]] perl module.
+
+This plugin borrows heavily from the [[graphviz|plugins/graphviz]] plugin written by [[JoshTriplett]].
+
+
+[[!mscgen src=
+mscgen is