Changes between Version 26 and Version 27 of PlantUmlMacro


Ignore:
Timestamp:
Nov 20, 2015, 1:37:53 PM (8 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • PlantUmlMacro

    v26 v27  
    1111== Description
    1212
    13 [http://plantuml.sourceforge.net/ PlantUML] is a java utility that allows generation of different types of UML diagrams (sequence, activity, state, use cases, objects, ...) from a simple text description file.
     13[http://plantuml.sourceforge.net/ PlantUML] is a Java utility that allows generation of different types of UML diagrams (sequence, activity, state, use cases, objects, ...) from a simple text description file.
    1414
    1515This plugin allows the integration of PlantUML on Trac Wiki pages, dynamically generating and embedding the diagrams.
     
    1717== Bugs/Feature Requests
    1818
    19 Existing '''[report:9?COMPONENT=PlantUmlMacro bugs and feature requests]''' for !PlantUmlMacro.
     19Existing [report:9?COMPONENT=PlantUmlMacro bugs and feature requests] for !PlantUmlMacro.
    2020
    21 If you have any issues, create a '''[/newticket?component=PlantUmlMacro&cc=airadier new ticket]'''.
     21If you have any issues, create a [/newticket?component=PlantUmlMacro&cc=airadier new ticket].
    2222
    2323[[TicketQuery(component=PlantUmlMacro&group=type,format=progress)]]
     
    2525== Download
    2626
    27 Download the zipped source from [download:plantumlmacro here].
     27Download the zipped source from [export:plantumlmacro here].
    2828
    2929== Source
    3030
    31 You can check out PlantUmlMacro from [http://trac-hacks.org/svn/plantumlmacro here] using Subversion, or [source:plantumlmacro browse the source] with Trac.
     31You can check out PlantUmlMacro from [/svn/plantumlmacro here] using Subversion, or [source:plantumlmacro browse the source] with Trac.
    3232
    3333== Installation
    3434
    35   1. '''Note''':
     35General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.
     36
     37'''Notes''':
    3638     1. Below instructions should be specific to some operating systems. Please help expanding these instructions.
    37      1. Broader installation guidelines are made available at TracPlugins.
    3839     1. `[sudo]` is optional in case you already have enough authorisation to modify your server.
    39      [[BR]]
    40   2. '''Check''' dependencies:
     40
     41'''Installation steps:'''
     42  1. '''Check''' dependencies:
    4143     1. A valid Java runtime environment.
    4244     1. [http://plantuml.sourceforge.net/download.html plantuml.jar]: save it to the location that you'll specify in the configuration section `/path/to/plantuml.jar`.
    43         *
    44           {{{
    45           #!sh
     45        * {{{#!sh
    4646          [sudo] wget http://sourceforge.net/projects/plantuml/files/plantuml.jar/download
    4747          }}}
    4848        * Check version of PlantUML jar:
    49           {{{
    50           #!sh
     49          {{{#!sh
    5150          cd /path/to/plantuml.jar
    5251          [sudo] java -jar plantuml.jar -version
    5352          }}}
    5453     1. [http://www.graphviz.org/ Graphviz]: check if installed and working as required in [http://plantuml.sourceforge.net/graphvizdot.html graphvizdot].
    55         {{{
    56         #!sh
     54        {{{#!sh
    5755        [sudo] java -jar plantuml.jar -testdot
    5856        }}}
     
    6058  1. '''Install''' component:
    6159     * with easy_install, globally:
    62        {{{
    63        #!sh
     60       {{{#!sh
    6461       [sudo] easy_install https://trac-hacks.org/svn/plantumlmacro/trunk
    6562       }}}
     
    6764  1. '''Enable''' this component as follows:
    6865     * by updating [wiki:TracIni trac.ini] file under appropriate configuration section;
    69        {{{
    70        #!ini
     66       {{{#!ini
    7167       [components]
    7268       plantuml.* = enabled
    7369       }}}
    7470     * or accessing your Admin panel (under selected Trac environment {{{ ..admin/general/plugins }}}).
    75      [[BR]]
    7671  1. '''Configure''' the Trac environment as follows:
    7772     * by updating [wiki:TracIni trac.ini] file under appropriate configuration section;
    78        {{{
    79        #!ini
     73       {{{#!ini
    8074       [plantuml]
    8175       plantuml_jar = /path/to/plantuml.jar
    8276       java_bin = /path/to/java_bin (optional, if Java binary is not on the search path)
    8377       }}}
    84        * example `plantuml_jar = /project-resources/trac/plugins`
    85        * example `java_bin = java` assumes that the Java binary is on the search path.[[BR]][[BR]]
    86      * or accessing your Admin panel (under selected Trac environment {{{ ..admin/general/plugins }}}).
    87      [[BR]]
     78       * example: `plantuml_jar = /project-resources/trac/plugins`.
     79       * example: `java_bin = java`, assumes that the Java binary is on the search path.
     80     * or accessing your Admin panel (under selected Trac environment {{{..admin/general/plugins}}}).
    8881  1. '''Restart''' web server:
    8982     * Apache on Ubuntu, example command line:
    90        {{{
    91        #!sh
     83       {{{#!sh
    9284       [sudo] /etc/init.d/apache2 restart
    9385       }}}