====== Sequencediagram Plugin ======

---- plugin ----
description: Generate sequence-diagrams
author     : K.-M. Hansche
email      : 
type       : syntax
lastupdate : 2019-08-03
compatible : 2018 Greebo
depends    : 
conflicts  : 
similar    : plantuml
tags       : sequence, diagram, syntax

downloadurl: https://github.com/vonloxley/dokuwiki-sequencediagram/archive/refs/tags/V2.0.2.zip
bugtracker : https://github.com/vonloxley/dokuwiki-sequencediagram/issues
sourcerepo : https://github.com/vonloxley/dokuwiki-sequencediagram/
donationurl: 

screenshot_img : https://trello.com/1/cards/644d139b8c173a1ac51b49b5/attachments/644d13d274d452d39d1a295c/download/dokuwiki-plugin-sequencediagram_screenshot.png
----

===== Description =====

Generates sequence diagrams on the fly. Powered by Andrew Brampton’s [[https://github.com/bramp/js-sequence-diagrams|js-sequence-diagrams]].

===== Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

===== Examples/Usage =====

<code>
<sequencediagram>
    Cook->Stove: Switch on
    Cook->Stove: Switch off
    Stove->Cook: Burn
    Note left of Cook: Aua!
</sequencediagram>
</code>

{{https://trello.com/1/cards/644d139b8c173a1ac51b49b5/attachments/644d13d274d452d39d1a295c/download/dokuwiki-plugin-sequencediagram_screenshot.png?recache|Screenshot of the Sequencediagram Plugin}}

===== Syntax =====

Full syntax:
<code>
<sequencediagram>
document  ::= statement*

statement ::=
    ( 'title' ':' message
    | 'participant' actor
    | 'note' ('left of' | 'right of' | 'over') actor ':' message
    | actor ( '-' | '--' ) ( '>' | '>>' )? actor ':' message
    )

message   ::= [^\n]+
actor     ::= [^\->:\n,]+
</sequencediagram>
</code>

===== Configuration and Settings =====

You can switch to a hand-written style using the plugins settings.

===== Development =====


=== Change Log ===

{{rss>https://github.com/vonloxley/dokuwiki-sequencediagram/commits/master.atom date}}

=== Known Bugs and Issues ===

> Hi, it seems that JAVASCRIPT compression from dokuwiki is breaking your JS code.
>> I de-minified the javascript, this should fix your problem.

=== ToDo/Wish List ===

> What a great plugin - thanks! A request: Would it be possible to have dokuwiki style links in the messages? e.g. <nowiki>Me->You: [[wiki:page:link|Message is a Link]]</nowiki>. Thanks! Jon B

===== FAQ =====


===== Discussion =====

Is there a way to get this to work with [[dw2pdf]]?
> The plugin uses javascript to generate the image on the client-side and I dont’t think dw2pdf can handle that.
> But you can use [[plantuml]] instead.

Might it work taking a look at/or integrating a tool like Mscgen (http://www.mcternan.me.uk/mscgen/)?