YUML Macro

Version 23.1 by Vincent Massol on 2014/09/30 17:05

cogDraw UML diagrams using yUML
TypeXAR
Category
Developed by

Vincent Massol

Rating
0 Votes
LicenseGNU Lesser General Public License 2.1

Installable with the Extension Manager

Description

Usage

{{yuml type="class|activity|usecase" style="nofunky|plain|scruffy" scale="10-1000" dir="RL|LR|TB"}}
content here...
{{/yuml}}

For more detail see the yUML web site.

This extensions requires access to the yUML web site to work.

Parameters definition

NameOptionalAllowed valuesDefault valueDescription
typeyesa string"class"The type of UML diagram to draw. Valid values are "class", "activity" and "usecase".

Examples

Class Diagram

{{yuml}}
[Customer]+1->*[Order]
[Order]++1-items >*[LineItem]
[Order]-0..1>[PaymentMethod]
{{/yuml}}

Generates:

class.png

Activity Diagram

{{yuml type="activity"}}
(start)-><d1>logged in->(Show Dashboard)->|a|->(end)
<d1>not logged in->(Show Login)->|a|
{{/yuml}}

Generates:

activity.png

Use Case Diagram

{{yuml type="usecase"}}
[User]-(Login)
[User]-(Logout)
(Login)<(Reminder)
(Login)>(Captcha)
{{/yuml}}

Generates:

usecase.png

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Once you have imported the XAR go to the Main.yUMLMacro page and you'll find examples of using the macro.

Tags: UML
    

Get Connected