Extension:WebSequenceDiagram

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
OOjs UI icon advanced.svg
WebSequenceDiagram
Release status: beta
Implementation Parser extension
Description Render inline sequence diagrams using websequencediagrams.com
Author(s) (avajaditalk)
License GPL
Download gist
style
Translate the WebSequenceDiagram extension if it is available at translatewiki.net
Check usage and version matrix.

What can this extension do?[edit]

Render sequence diagrams in your wiki pages using www.websequencediagrams.com. Include the editable text (source) of the diagram in your page and when the page is saved you'll see rendered PNG sequence diagrams.

This extension uses the embedding for 'HTML and Web Pages' technique described here.

Usage[edit]

<sequencediagram style="modern-blue">
title Authentication Sequence
Alice->Bob: Authentication Request
note right of Bob: Bob thinks about it
Bob->Alice: Authentication Response
</sequencediagram>

The style parameter accepts either default, earth, magazine, modern-blue, mscgen, napkin, omegapple, patent, qsd, rose, roundgreen.

For help on sequence diagram syntax, see the websequencediagrams.com documentation.

Installation[edit]

  1. Download the source code and place it in extensions/WebSequenceDiagram/WebSequenceDiagram.php.
  2. Add the following to LocalSettings.php :
require_once("$IP/extensions/WebSequenceDiagram/WebSequenceDiagram.php");

See also[edit]