wiki:WebSequenceDiagramPlugin

Version 1 (modified by rjollos, 5 years ago) (diff)

New hack WebSequenceDiagramPlugin, created by rjollos

Integrate UML diagrams with Trac

Description

WebSequenceDiagram is a plug-in for integrating UML sequence diagrams from Web Sequence Diagrams in Trac wiki pages. It can be found here.

This is not my own hack! I was looking for a UML sequence diagramming tool that integrates with Trac and finally stumbled upon this one months after I started looking. There was not a Trac Hacks page, so I thought it would be worthwhile to add one.

The author is Carl Gould of Inductive Automation.

Bugs/Feature Requests

Existing bugs and feature requests for WebSequenceDiagramPlugin are here.

If you have any issues, create a new ticket.

Download

Download the zipped source from here.

Source

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

Example

Notes

A simple macro to include a sequence diagram from www.websequencediagrams.com.

Installation via Source

The installation of the sequence diagram plugin from source is done by creating a Python egg distribution file and copying the .egg file to the Trac plugins directory. Detailed information on Python eggs can be found at: http://peak.telecommunity.com/DevCenter/PythonEggs. In addition, the Easy Install package is required to create Python eggs. See http://peak.telecommunity.com/DevCenter/EasyInstall for more information on using and installing Easy Install.

Change to the download directory and run:

python setup.py bdist_egg

This will generate a python egg in the dist directory. Copy the egg file into the trac/plugins directory and follow the Configuration steps outlined below.

Configuration (trac.ini)

To enable the plugin::

[components] sequencediagram.* = enabled

Optionally you can specify a style for the sequence diagram by adding a sequence diagram section to the trac.ini file:

[sequencediagram] style = rose

Example

An example usage::

{{{
#!SequenceDiagram
Alice->Bob: Authentication Request
note right of Bob: Bob thinks about it.
Bob-->Alice: Authentication Response
}}}

Recent Changes

[6391] by rjollos on 2009-08-18 09:11:49
Adding WebSequenceDiagram code from http://www.websequencediagrams.com/embedding.html
[6390] by rjollos on 2009-08-18 09:10:40
Adding directory for 0.11
[6169] by rjollos on 2009-07-10 00:43:06
New hack WebSequenceDiagramPlugin, created by rjollos

Author/Contributors

Author: rjollos
Contributors: