Extension:PlantUML

What can this extension do?
This extension allows to easily add UML diagrams into Wiki using a simple text description.

The following diagrams are available:


 * sequence diagram,
 * use case diagram,
 * class diagram,
 * activity diagram,
 * component diagram,
 * state diagram

The language is explained in this document: Language Reference Guide.pdf

Usage
Just put a PlantUML model description between the tag.

Attributes

 * redraw
 * force diagram to be redrawn by deleting cached image.

Example1
Alice -> Bob: Authentication Request Bob --> Alice: Authentication Response

Example2
skinparam usecaseBackgroundColor DarkSeaGreen skinparam usecaseArrowColor Olive skinparam actorBorderColor black skinparam usecaseBorderColor DarkSlateGray skinparam usecaseActorFontName Courier

User << Human >>
 * Main Database: as MySql << Application >>

(Start) << One Shot >> (Use the application) as (Use) << Main >>

User -> (Start) User --> (Use) MySql --> (Use)

Example3
package "Classic Collections" #DDDDDD Object <|-- ArrayList

package net.sourceforge.plantuml Object <|-- Demo1 Demo1 *- Demo2

Installation of Classical Version
There is actually two versions of the extension. This describes the installation of the classical version.


 * 1) Install Graphviz.
 * 2) Install PlantUML.
 * 3) Copy & paste the code below in a file called PlantUML.php and place it in your extensions directory of your MediaWiki folder.
 * 4) Change the value of $plantumlJar in PlantUML.php to match your installation path.
 * 5) Put this line near the end of your LocalSettings.php in the MediaWiki root-folder to include the extension:

Installation of Cloud Version
This describes the installation of the Cloud version.

The Cloud Version is easier to install, and only needs an Internet access to generated the diagrams.
 * 1) Copy & paste the code (from Cloud Version) below in a file called PlantUML.php and place it in your extensions directory of your MediaWiki folder.
 * 2) Put this line near the end of your LocalSettings.php in the MediaWiki root-folder to include the extension:

You may have also to enable URL file-access. Create or modify php.ini file with this entry:

And upload it to /username/public_html (where your LocalSettings.php file would be).

Installation issues

 * On Windows, you must set the read & execute permissions on C:\Windows\system32\cmd.exe for the account the PHP web service extension is running under. PHP needs those permissions to "fork" other process.

Code of Cloud Version
This version does not need to have Java, Graphviz or PlantUML installed on the system.

It uses the service provided by PlantUML PHP Client API