YUML Macro
 | Draw UML diagrams using yUML |
| Type | XAR |
| Category | |
| Developed by | |
| Active Installs | 17 |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
Table of contents
Description
Usage
content here...
{{/yuml}}
For more detail see the yUML web site.
This extensions requires access to the yUML web site to work (There's a paying option to get a private yUML server).
Parameters definition
| Name | Optional | Allowed values | Default value | Description |
|---|---|---|---|---|
| type | yes | a string | "class" | The type of UML diagram to draw. Valid values are "class", "activity" and "usecase". |
Examples
Class Diagram
[Customer]+1->*[Order]
[Order]++1-items >*[LineItem]
[Order]-0..1>[PaymentMethod]
{{/yuml}}
Generates:
Activity Diagram
(start)-><d1>logged in->(Show Dashboard)->|a|->(end)
<d1>not logged in->(Show Login)->|a|
{{/yuml}}
Generates:
Use Case Diagram
[User]-(Login)
[User]-(Logout)
(Login)<(Reminder)
(Login)>(Captcha)
{{/yuml}}
Generates:
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:
- Log in the wiki with a user having Administration rights
- Go to the Administration page and select the Import category
- Follow the on-screen instructions to upload the downloaded XAR
- Click on the uploaded XAR and follow the instructions
- 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.
