Extension:PlantUML

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual - list
Crystal Clear action run.png

Release status: beta

Description Add UML diagrams in your Wiki
Author(s) Roques A., Kersten Pieter J.
Last version 0.4
License No license specified
Download https://github.com/pjkersten/PlantUML

Check usage (experimental)

Contents

[edit] 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

[edit] Usage

Just put a PlantUML model description between the <uml></uml> tag.

[edit] Attributes

redraw
force diagram to be redrawn by deleting cached image.


[edit] Examples

[edit] Example1

<uml>
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
</uml>

[edit] Example2

<uml>
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)
</uml>

[edit] Example3

<uml>
package "Classic Collections" #DDDDDD
Object <|-- ArrayList

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

[edit] Installation

The code of the extension is available here.

  • 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.

[edit] See also

Extension:UML is doing the same thing with MetaUML.

Personal tools
Namespaces
Variants
Actions
Site
Support
Download
Development
Communication
Print/export
Toolbox