Added a comment

[git.ikiwiki.info.git] / doc / plugins / contrib / mscgen.mdwn

diff --git a/doc/plugins/contrib/mscgen.mdwn b/doc/plugins/contrib/mscgen.mdwn
index 9ae3901f7132377f66d5b24d630bb8386d90de4c..792aaa4e3fa20003e3261260fda40189db87c12f 100644 (file)
--- a/doc/plugins/contrib/mscgen.mdwn
+++ b/doc/plugins/contrib/mscgen.mdwn
@@ -1,10 +1,24 @@
+[[!template id=plugin name=mscgen author="[[users/Tjgolubi]]"]]

 [[!tag type/widget]]
 
 [[!tag type/widget]]
 

-This plugin provides the mscgen [[ikiwiki/directive]].
+## 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/)
 This directive allows embedding [mscgen](http://www.mcternan.me.uk/mscgen/)

-message sequence chart graphs in a page.
+message sequence chart graphs in an ikiwiki page.

 
 

-Here's an mscgen source example.
+Here's an example that shows how an mscgen message sequence chart is embedded into an ikiwiki page.

 
     \[[!msc src="""
       arcgradient = 8;
 
     \[[!msc src="""
       arcgradient = 8;


@@ -21,25 +35,18 @@ Here's an mscgen source example.
       |||;
     """]]
 
       |||;
     """]]
 

-And here's the resulting graph.
+Security implications: to be determined.

 
 

-[[!msc src=<<"""
-  arcgradient = 8;
+This plugin borrows heavily from the [[graphviz|plugins/graphviz]] plugin written by [[JoshTriplett]].

 
 

-  a [label="Client"],b [label="Server"];
+## PREREQUISITES
+    IkiWiki
+    mscgen
+    Digest::SHA

 
 

-  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"];
-  |||;
-"""]]
+## DOWNLOAD

 
 

-Security implications: to be determined.
+* browse at GitHub: <http://github.com/tjgolubi/ikiwiki.mscgen>
+* repo at git://github.com/tjgolubi/ikiwiki.mscgen.git

 
 

-This plugin uses the [[!cpan Digest::SHA]] perl module.

 
 

-This plugin borrows heavily from the [[graphviz|plugins/graphviz]] plugin written by [[JoshTriplett]].