Changes between Initial Version and Version 1 of WebSequenceDiagramPlugin

Timestamp:

Jul 9, 2009, 10:43:08 PM (15 years ago)

Author:

Ryan J Ollos

Comment:

New hack WebSequenceDiagramPlugin, created by rjollos

WebSequenceDiagramPlugin

@@ +1 @@
+= Integrate UML diagrams with Trac =
+
+== Description ==
+
+[WebSequenceDiagramPlugin WebSequenceDiagram] is a plug-in for integrating UML sequence diagrams from [http://www.websequencediagrams.com/ Web Sequence Diagrams] in Trac wiki pages.  It can be found [http://www.websequencediagrams.com/embedding.html 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 
+[report:9?COMPONENT=WebSequenceDiagramPlugin here].
+
+If you have any issues, create a 
+[http://trac-hacks.org/newticket?component=WebSequenceDiagramPlugin&owner=rjollos new ticket].
+
+== Download ==
+
+Download the zipped source from [download:websequencediagramplugin here].
+
+== Source ==
+
+You can check out WebSequenceDiagramPlugin from [http://trac-hacks.org/svn/websequencediagramplugin here] using Subversion, or [source:websequencediagramplugin 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 ==
+
+[[ChangeLog(websequencediagramplugin, 3)]]
+
+== Author/Contributors ==
+
+'''Author:''' [wiki:rjollos] [[BR]]
+'''Contributors:'''