Changes between Version 5 and Version 6 of WebSequenceDiagramPlugin


Ignore:
Timestamp:
Mar 11, 2015, 2:43:44 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes, tagged with license

Legend:

Unmodified
Added
Removed
Modified

  • WebSequenceDiagramPlugin

    v5 v6  
    11[[PageOutline(2-5,Contents,pullout)]]
    2 = Integrate UML diagrams with Trac =
    32
    4 == Description ==
     3= Integrate UML diagrams with Trac
    54
    6 [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].
     5== Description
    76
    8 == Bugs/Feature Requests ==
     7A simple macro to include a sequence diagram from http://www.websequencediagrams.com. [WebSequenceDiagramPlugin WebSequenceDiagram] is a plugin for integrating UML sequence diagrams from Web Sequence Diagrams in Trac wiki pages. It can be found [http://www.websequencediagrams.com/embedding.html here].
     8
     9== Bugs/Feature Requests
    910
    1011Existing bugs and feature requests for WebSequenceDiagramPlugin are
    … …  
    1415[http://trac-hacks.org/newticket?component=WebSequenceDiagramPlugin&owner=rjollos new ticket].
    1516
    16 == Download ==
     17[[TicketQuery(component=WebSequenceDiagramPlugin&group=type,format=progress)]]
     18
     19== Download
    1720
    1821Download the zipped source from [download:websequencediagramplugin here].
    1922
    20 == Source ==
     23== Source
    2124
    2225You can check out WebSequenceDiagramPlugin from [http://trac-hacks.org/svn/websequencediagramplugin here] using Subversion, or [source:websequencediagramplugin browse the source] with Trac.
    2326
    24 == Notes ==
     27== Installation
    2528
    26 A simple macro to include a sequence diagram from http://www.websequencediagrams.com.
    27 
    28 == Installation via Source ==
    29 
    30 The installation of the sequence diagram plugin from source is done by
    31 creating a Python egg distribution file and copying the .egg file to
    32 the Trac plugins directory. Detailed information on Python eggs can be
    33 found at [http://peak.telecommunity.com/DevCenter/PythonEggs here]. In
    34 addition, the Easy Install package is required to create Python
    35 eggs. See [http://peak.telecommunity.com/DevCenter/EasyInstall EasyInstall] for more
    36 information on using and installing Easy Install.
     29The installation of the sequence diagram plugin from source is done by creating a Python egg distribution file and copying the .egg file to
     30the Trac plugins directory. Detailed information on Python eggs can be found at [http://peak.telecommunity.com/DevCenter/PythonEggs here]. In
     31addition, 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.
    3732
    3833Change to the download directory and run:
    39  {{{#!sh
    40     python setup.py bdist_egg
    41 }}}
    42 This will generate a python egg in the dist directory. Copy the egg
    43 file into the trac/plugins directory and follow the Configuration
    44 steps outlined below.
    45 
    46 == Configuration (trac.ini) ==
    47 
    48 
    49 To enable the plugin::
    50 
    51  {{{#!ini
    52   [components]
    53   sequencediagram.* = enabled
    54 }}}
    55  
    56 Optionally you can specify a style for the sequence diagram by adding
    57 a sequence diagram section to the trac.ini file:
    58 
    59  {{{#!ini
    60   [sequencediagram]
    61   style = rose
     34{{{#!sh
     35python setup.py bdist_egg
    6236}}}
    6337
    64 == Example ==
     38This 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.
    6539
    66 An example usage::
     40To enable the plugin add the following to `trac.ini`:
     41{{{#!ini
     42[components]
     43sequencediagram.* = enabled
     44}}}
     45
     46== Configuration
     47
     48Optionally, you can specify a style for the sequence diagram by adding a sequence diagram section to the `trac.ini` file:
     49{{{#!ini
     50[sequencediagram]
     51style = rose
     52}}}
     53
     54== Example
     55
     56An example usage:
    6757
    6858{{{
    … …  
    7565}}}
    7666
    77 == Recent Changes ==
     67== Recent Changes
    7868
    7969[[ChangeLog(websequencediagramplugin, 3)]]
    8070
    81 == Author/Contributors ==
     71== Author/Contributors
    8272
    8373'''Author:''' Carl Gould of Inductive Automation [[BR]]
    84 '''Maintainer:''' [wiki:rjollos] [[BR]]
     74'''Maintainer:''' [[Maintainer]] [[BR]]
    8575'''Contributors:'''