Changes between Version 24 and Version 25 of CodeExampleMacro
- Timestamp:
- Nov 16, 2015, 12:34:36 PM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
CodeExampleMacro
v24 v25 5 5 == Description 6 6 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.7 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. 8 8 9 9 Key features: … … 16 16 == Bugs/Feature Requests 17 17 18 Existing [report:9?COMPONENT=CodeExampleMacro bugs and feature requests] for !CodeExampleMacro.18 Existing bugs and feature requests for CodeExampleMacro are [report:9?COMPONENT=CodeExampleMacro here]. 19 19 20 20 If you have any issues, create a [/newticket?component=CodeExampleMacro&cc=rjollos new ticket]. … … 24 24 == Download 25 25 26 You can [download:codeexamplemacro download] the zipped source.26 Download the zipped source from [export:codeexamplemacro here]. 27 27 28 28 == Source 29 29 30 You can [http://trac-hacks.org/svn/codeexamplemacro check out] !CodeExampleMacro using Subversion, or [source:codeexamplemacro browse the source] with Trac,30 You can check out CodeExampleMacro from [/svn/codeexamplemacro here] using Subversion, or [source:codeexamplemacro browse the source] with Trac. 31 31 32 32 == Installation 33 33 34 {{{#!comment 35 1. '''Check''' dependencies: 36 i. none required 37 34 {{{#!comment 35 1. '''Check''' dependencies: 36 i. none required 38 37 * `[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] 48 codeexample.code_example_processor.* = enabled 49 }}} 50 {{{#!comment 53 51 1. '''Configure''' this component in its own configuration section, by updating TracIni file as follows: 54 52 i. none required … … 60 58 * example `plantuml_jar = /project-resources/trac/plugins` 61 59 * example `java_bin = java` assumes that the Java binary is on the search path. 62 63 64 65 66 67 68 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. 69 67 70 68 == Usage