Changes between Version 25 and Version 26 of CodeExampleMacro

Timestamp:

Sep 6, 2017, 9:01:11 AM (7 years ago)

Author:

figaro

Comment:

Moved example to description

CodeExampleMacro

@@ -5 +5 @@
 == Description
 
-This 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.
+This 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.
 
 Key features:
@@ -12 +12 @@
  * Code from the repository can be displayed using TracLinks syntax. The multiple repository configuration (Trac >= 0.12) is supported.
 
-All rights reserved by [http://codedgers.com Codedgers Inc].
-
-== Bugs/Feature Requests
-
-Existing bugs and feature requests for CodeExampleMacro are [report:9?COMPONENT=CodeExampleMacro here].
-
-If you have any issues, create a [/newticket?component=CodeExampleMacro&cc=rjollos new ticket].
-
-[[TicketQuery(component=CodeExampleMacro,group=type,format=progress)]]
-
-== Download
-
-Download the zipped source from [export:codeexamplemacro here].
-
-== Source 
-
-You can check out CodeExampleMacro from [/svn/codeexamplemacro here] using Subversion, or [source:codeexamplemacro browse the source] with Trac.
-
-== Installation
-
- {{{#!comment
- 1. '''Check''' dependencies:
-    i. none required
-     * `[sudo]` is optional in case you have authorisation to modify your server.
-}}}
- 1. '''Install''' plugin globally, for example with `easy_install`:
- {{{#!sh
-[sudo] easy_install https://trac-hacks.org/svn/codeexamplemacro
-}}}
-  * `[sudo]` is optional in case you have authorisation to modify your server.
-  * You might be required to select a specific `tag`, `branch`. Defaults to select from `trunk`.
- 1. '''Enable''' this component by updating TracIni file as follows:
- {{{#!ini
-[components]
-codeexample.code_example_processor.* = enabled
-}}}
- {{{#!comment
-  1. '''Configure''' this component in its own configuration section, by updating TracIni file as follows:
-     i. none required
-     {{{#!ini
-     [plantuml]
-     plantuml_jar = /path/to/plantuml.jar
-     java_bin = /path/to/java_bin (optional, if Java binary is not on the search path)
-     }}}
-     * example `plantuml_jar = /project-resources/trac/plugins`
-     * example `java_bin = java` assumes that the Java binary is on the search path.
-}}}
- 1. '''Restart''' web server on command line:
- {{{#!sh
-[sudo] /etc/init.d/apache2 restart
-}}}
-   * `[sudo]` is optional in case you have authorisation to modify your server.
- 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.
-
-== Usage
+This plugin is to be used as follows:
 
   1. Inside a wiki area you can invoke the `#!CodeExample` wiki processor to render a special formatted box containing specified source code, as shown and exemplified down:
@@ -137 +83 @@
        [[Image(example4.png)]]
 
+All rights reserved by [http://codedgers.com Codedgers Inc].
+
+== Bugs/Feature Requests
+
+Existing bugs and feature requests for CodeExampleMacro are [report:9?COMPONENT=CodeExampleMacro here].
+
+If you have any issues, create a [/newticket?component=CodeExampleMacro&cc=rjollos new ticket].
+
+[[TicketQuery(component=CodeExampleMacro,group=type,format=progress)]]
+
+== Download
+
+Download the zipped source from [export:codeexamplemacro here].
+
+== Source 
+
+You can check out CodeExampleMacro from [/svn/codeexamplemacro here] using Subversion, or [source:codeexamplemacro browse the source] with Trac.
+
+== Installation
+
+ {{{#!comment
+ 1. '''Check''' dependencies:
+    i. none required
+     * `[sudo]` is optional in case you have authorisation to modify your server.
+}}}
+ 1. '''Install''' plugin globally, for example with `easy_install`:
+ {{{#!sh
+[sudo] easy_install https://trac-hacks.org/svn/codeexamplemacro
+}}}
+  * `[sudo]` is optional in case you have authorisation to modify your server.
+  * You might be required to select a specific `tag`, `branch`. Defaults to select from `trunk`.
+ 1. '''Enable''' this component by updating TracIni file as follows:
+ {{{#!ini
+[components]
+codeexample.code_example_processor.* = enabled
+}}}
+ {{{#!comment
+  1. '''Configure''' this component in its own configuration section, by updating TracIni file as follows:
+     i. none required
+     {{{#!ini
+     [plantuml]
+     plantuml_jar = /path/to/plantuml.jar
+     java_bin = /path/to/java_bin (optional, if Java binary is not on the search path)
+     }}}
+     * example `plantuml_jar = /project-resources/trac/plugins`
+     * example `java_bin = java` assumes that the Java binary is on the search path.
+}}}
+ 1. '''Restart''' web server on command line:
+ {{{#!sh
+[sudo] /etc/init.d/apache2 restart
+}}}
+   * `[sudo]` is optional in case you have authorisation to modify your server.
+ 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.
+
 == Recent Changes