wiki:YumlPreprocessorMacro

Version 4 (modified by dthomas, 4 years ago) (diff)

--

yuml.me preprocessor macro

Description

A preprocessor for including UML diagrams using the http://yuml.me service.

Following diagrams are supported:

  • use case diagrams
  • class diagrams
  • activity diagrams

See the yuml.me site for information on the syntax to be used.

So far, only the scruffy diagrams can be rendered - if requested, I'll add the straight diagrams as an option.

Installation

Just drop the file YumlPreprocessor.py in your plugins folder and enable it with the admin plugins interface.

Bugs/Feature Requests

Existing bugs and feature requests for YumlPreprocessorMacro are here.

If you have any issues, create a new ticket.

Download

Download the zipped source from here.

Source

You can check out YumlPreprocessorMacro from here using Subversion, or browse the source with Trac.

Example

Use Case diagrams

{{{
#!YumlUseCase
[User]-(Login)
[User]-(Logout) 
(Login)<(Reminder) 
(Login)>(Captcha)
}}}

The above wiki syntax results in the following image being included:

Class diagrams

{{{
#!YumlClass
[Customer]+1->*[Order]
[Order]++1-items >*[LineItem]
[Order]-0..1>[PaymentMethod]
}}}

The above wiki syntax results in the following image being included:

Activity diagrams

{{{
#!YumlActivity
(start)-><d1>logged in->(Show Dashboard)->|a|->(end)
<d1>not logged in->(Show Login)->|a|
}}}

The above wiki syntax results in the following image being included:

Recent Changes

[11682] by dthomas on 2012-06-22 10:17:45
added my name to the COPYING file. see #9909
[11633] by rjollos on 2012-06-08 08:51:54
Refs #9909: Added BSD 3-Clause license.
[10797] by dthomas on 2011-10-18 09:28:40
added fix for #9272 (commit request: pragma to be able to set dir, scale etc.) as sent by herby@…. Thanks herby!

Author/Contributors

Author: dthomas
Maintainer: dthomas
Contributors:

Attachments (3)

Download all attachments as: .zip