Changes between Version 24 and Version 25 of CodeExampleMacro


Ignore:
Timestamp:
Nov 16, 2015, 12:34:36 PM (8 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • CodeExampleMacro

    v24 v25  
    55== Description
    66
    7 This 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.
     7This macro renders a code example box that supports syntax highlighting. It comes in the following forms: simple, correct, and incorrect. The examples can be used for code review and functional testing, see below for examples.
    88
    99Key features:
     
    1616== Bugs/Feature Requests
    1717
    18 Existing [report:9?COMPONENT=CodeExampleMacro bugs and feature requests] for !CodeExampleMacro.
     18Existing bugs and feature requests for CodeExampleMacro are [report:9?COMPONENT=CodeExampleMacro here].
    1919
    2020If you have any issues, create a [/newticket?component=CodeExampleMacro&cc=rjollos new ticket].
     
    2424== Download
    2525
    26 You can [download:codeexamplemacro download] the zipped source.
     26Download the zipped source from [export:codeexamplemacro here].
    2727
    2828== Source
    2929
    30 You can [http://trac-hacks.org/svn/codeexamplemacro check out] !CodeExampleMacro using Subversion, or [source:codeexamplemacro browse the source] with Trac,
     30You can check out CodeExampleMacro from [/svn/codeexamplemacro here] using Subversion, or [source:codeexamplemacro browse the source] with Trac.
    3131
    3232== Installation
    3333
    34   {{{#!comment
    35   1. '''Check''' dependencies:
    36      i. none required
    37 
     34 {{{#!comment
     35 1. '''Check''' dependencies:
     36    i. none required
    3837     * `[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
     38}}}
     39 1. '''Install''' plugin globally, for example with `easy_install`:
     40 {{{#!sh
     41[sudo] easy_install https://trac-hacks.org/svn/codeexamplemacro
     42}}}
     43  * `[sudo]` is optional in case you have authorisation to modify your server.
     44  * You might be required to select a specific `tag`, `branch`. Defaults to select from `trunk`.
     45 1. '''Enable''' this component by updating TracIni file as follows:
     46 {{{#!ini
     47[components]
     48codeexample.code_example_processor.* = enabled
     49}}}
     50 {{{#!comment
    5351  1. '''Configure''' this component in its own configuration section, by updating TracIni file as follows:
    5452     i. none required
     
    6058     * example `plantuml_jar = /project-resources/trac/plugins`
    6159     * 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.
     60}}}
     61 1. '''Restart''' web server on command line:
     62 {{{#!sh
     63[sudo] /etc/init.d/apache2 restart
     64}}}
     65   * `[sudo]` is optional in case you have authorisation to modify your server.
     66 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.
    6967
    7068== Usage