Changes between Version 23 and Version 24 of CodeExampleMacro


Ignore:
Timestamp:
Aug 13, 2015, 5:05:47 PM (9 years ago)
Author:
figaro
Comment:

Rearranged paragraphs to maintain consistency

Legend:

Unmodified
Added
Removed
Modified

  • CodeExampleMacro

    v23 v24  
    55== Description
    66
    7 The CodeExampleMacro renders a code example box that supports syntax highlighting. It support three types of examples: simple, correct, and incorrect. The examples can be used for code review and functional testing.
     7This macro renders a code example box that supports syntax highlighting. It support three types of examples: simple, correct, and incorrect. The examples can be used for code review and functional testing.
    88
    9 Features:
     9Key features:
    1010 * The '''SELECT ALL''' link highlights all of the code in the box to simplify the copy and paste action.
    1111 * A mouse click on the header (title) will show or hide the code block.
    1212 * Code from the repository can be displayed using TracLinks syntax. The multiple repository configuration (Trac >= 0.12) is supported.
    1313
    14 All rights reserved by [http://codedgers.com Codedgers Inc.]
     14All rights reserved by [http://codedgers.com Codedgers Inc].
     15
     16== Bugs/Feature Requests
     17
     18Existing [report:9?COMPONENT=CodeExampleMacro bugs and feature requests] for !CodeExampleMacro.
     19
     20If you have any issues, create a [/newticket?component=CodeExampleMacro&cc=rjollos new ticket].
     21
     22[[TicketQuery(component=CodeExampleMacro,group=type,format=progress)]]
     23
     24== Download
     25
     26You can [download:codeexamplemacro download] the zipped source.
     27
     28== Source
     29
     30You can [http://trac-hacks.org/svn/codeexamplemacro check out] !CodeExampleMacro using Subversion, or [source:codeexamplemacro browse the source] with Trac,
     31
     32== Installation
     33
     34  {{{#!comment
     35  1. '''Check''' dependencies:
     36     i. none required
     37
     38     * `[sudo]` is optional in case you have authorisation to modify your server.
     39  }}}
     40  1. '''Install''' plugin globally, for example with `easy_install`:
     41       {{{#!sh
     42       [sudo] easy_install https://trac-hacks.org/svn/codeexamplemacro
     43       }}}
     44        * `[sudo]` is optional in case you have authorisation to modify your server.
     45        * You might be required to select a specific `tag`, `branch`. Defaults to select from `trunk`.
     46  1. '''Enable''' this component by updating TracIni file as follows:
     47     {{{#!ini
     48     [components]
     49     codeexample.code_example_processor.* = enabled
     50     }}}
     51  {{{
     52  #!comment
     53  1. '''Configure''' this component in its own configuration section, by updating TracIni file as follows:
     54     i. none required
     55     {{{#!ini
     56     [plantuml]
     57     plantuml_jar = /path/to/plantuml.jar
     58     java_bin = /path/to/java_bin (optional, if Java binary is not on the search path)
     59     }}}
     60     * example `plantuml_jar = /project-resources/trac/plugins`
     61     * example `java_bin = java` assumes that the Java binary is on the search path.
     62  }}}
     63  1. '''Restart''' web server on command line:
     64     {{{#!sh
     65     [sudo] /etc/init.d/apache2 restart
     66     }}}
     67       * `[sudo]` is optional in case you have authorisation to modify your server.
     68  1. '''Test''' if this component is working properly. If the plugin is installed correctly, the example shown in the [#Usage] section on this page should be displayed.
    1569
    1670== Usage
    … …  
    85139       [[Image(example4.png)]]
    86140
    87 == Installation
    88 
    89   {{{
    90   #!comment
    91   1. '''Check''' dependencies:
    92      i. none required
    93 
    94      * `[sudo]` is optional in case you have authorisation to modify your server.
    95   }}}
    96   1. '''Install''' plugin globally, for example with `easy_install`:
    97        {{{
    98        #!sh
    99        [sudo] easy_install https://trac-hacks.org/svn/codeexamplemacro
    100        }}}
    101         * `[sudo]` is optional in case you have authorisation to modify your server.
    102         * You might be required to select a specific `tag`, `branch`. Defaults to select from `trunk`.
    103   1. '''Enable''' this component by updating TracIni file as follows:
    104      {{{
    105      #!ini
    106      [components]
    107      codeexample.code_example_processor.* = enabled
    108      }}}
    109   {{{
    110   #!comment
    111   1. '''Configure''' this component in its own configuration section, by updating TracIni file as follows:
    112      i. none required
    113      {{{
    114      #!ini
    115      [plantuml]
    116      plantuml_jar = /path/to/plantuml.jar
    117      java_bin = /path/to/java_bin (optional, if Java binary is not on the search path)
    118      }}}
    119      * example `plantuml_jar = /project-resources/trac/plugins`
    120      * example `java_bin = java` assumes that the Java binary is on the search path.
    121   }}}
    122   1. '''Restart''' web server on command line:
    123      {{{
    124      #!sh
    125      [sudo] /etc/init.d/apache2 restart
    126      }}}
    127        * `[sudo]` is optional in case you have authorisation to modify your server.
    128   1. '''Test''' if this component is working properly. If the plugin is installed correctly, the example shown in the [#Usage] section on this page should be displayed.
    129 
    130 == Bugs/Feature Requests
    131 
    132 Existing [report:9?COMPONENT=CodeExampleMacro bugs and feature requests] for !CodeExampleMacro.
    133 
    134 If you have any issues, create a [/newticket?component=CodeExampleMacro&cc=rjollos new ticket].
    135 
    136 [[TicketQuery(component=CodeExampleMacro,group=type,format=progress)]]
    137 
    138 == Source & Download
    139 
    140 You can [http://trac-hacks.org/svn/codeexamplemacro check out] !CodeExampleMacro using Subversion, or [source:codeexamplemacro browse the source] with Trac, or [download:codeexamplemacro download] the zipped source.
    141 
    142 === Recent Changes
     141== Recent Changes
    143142
    144143[[ChangeLog(codeexamplemacro, 3)]]