[[PageOutline(2-5,Contents,pullout)]] = Render UML diagrams on Trac wiki and ticket pages == Description This plugin is a macro that allows you to include a sequence diagram from [http://www.websequencediagrams.com WebsequenceDiagrams]. !WebsequenceDiagrams is a platform for creating online process diagrams that can be embedded within a web page. This among other things allows you to integrate [wikipedia:Sequence_diagram UML sequence diagrams] from Web Sequence Diagrams in Trac wiki pages, which can be found [http://www.websequencediagrams.com/embedding.html here]. An example usage: {{{ {{{ #!SequenceDiagram Alice->Bob: Authentication Request note right of Bob: Bob thinks about it. Bob-->Alice: Authentication Response }}} }}} This will be displayed as follows: [[Image(websequencediagram.png, border=2)]] !WebsequenceDiagrams is free to use, but is proprietary licensed. See also: [[ListTagged(diagram, realm=wiki, exclude=WebSequenceDiagramPlugin)]] == Bugs/Feature Requests Existing bugs and feature requests for WebSequenceDiagramPlugin are [report:9?COMPONENT=WebSequenceDiagramPlugin here]. If you have any issues, create a [/newticket?component=WebSequenceDiagramPlugin new ticket]. [[TicketQuery(component=WebSequenceDiagramPlugin&group=type,format=progress)]] == Download Download the zipped source from [export:websequencediagramplugin here]. == Source You can check out WebSequenceDiagramPlugin from [/svn/websequencediagramplugin here] using Subversion, or [source:websequencediagramplugin browse the source] with Trac. == Installation 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 here]. In addition, the Easy Install package is required to create Python eggs. See [http://peak.telecommunity.com/DevCenter/EasyInstall EasyInstall] for more information on using and installing Easy Install. Change to the download directory and run: {{{#!sh 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. To enable the plugin add the following to your `trac.ini` file: {{{#!ini [components] sequencediagram.* = enabled }}} == Configuration Optionally, you can specify a style for the sequence diagram by adding a sequence diagram section to the `trac.ini` file: {{{#!ini [sequencediagram] style = rose }}} == Recent Changes [[ChangeLog(websequencediagramplugin, 3)]] == Author/Contributors '''Author:''' Carl Gould (Inductive Automation) [[BR]] '''Maintainer:''' [[Maintainer]] [[BR]] '''Contributors:'''