Changes between Version 20 and Version 21 of CodeExampleMacro
- Timestamp:
- Mar 5, 2015, 12:49:43 PM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
CodeExampleMacro
v20 v21 1 1 [[PageOutline(2-5,Contents,pullout)]] 2 = Code example box with syntax highlighting =3 2 4 = = Description ==3 = Code example box with syntax highlighting 5 4 6 The CodeExampleMacro renders a code example box that supports syntax highlighting. It support three types of examples: simple, correct, and incorrect. 5 == Description 6 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. 7 8 8 9 Features: … … 13 14 All rights reserved by [http://codedgers.com Codedgers Inc.] 14 15 15 == Usage ==16 == Usage 16 17 17 18 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: … … 82 83 }}} 83 84 * will be rendered as:[[BR]] 84 [[Image(example4.png)]] [[BR]][[BR]]85 [[Image(example4.png)]] 85 86 86 == Installation ==87 == Installation 87 88 88 89 {{{ … … 91 92 i. none required 92 93 93 * ,,`[sudo]` is optional case you already have enough authority to modify your server.,,[[BR]][[BR]]94 * `[sudo]` is optional in case you have authorisation to modify your server. 94 95 }}} 95 1. '''Install''' plugin globally: 96 * with easy_install: 96 1. '''Install''' plugin globally, for example with `easy_install`: 97 97 {{{ 98 98 #!sh 99 $[sudo] easy_install https://trac-hacks.org/svn/codeexamplemacro99 [sudo] easy_install https://trac-hacks.org/svn/codeexamplemacro 100 100 }}} 101 * ,,`[sudo]` is optional case you already have enough authority to modify your server.,,102 * ,,You might be required to select a specific `tag`, `branch`. Defaults to select from `trunk`,,[[BR]][[BR]]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 103 1. '''Enable''' this component by updating TracIni file as follows: 104 104 {{{ … … 118 118 }}} 119 119 * example `plantuml_jar = /project-resources/trac/plugins` 120 * example `java_bin = java` assumes that the Java binary is on the search path. [[BR]][[BR]]120 * example `java_bin = java` assumes that the Java binary is on the search path. 121 121 }}} 122 122 1. '''Restart''' web server on command line: 123 123 {{{ 124 124 #!sh 125 $[sudo] /etc/init.d/apache2 restart125 [sudo] /etc/init.d/apache2 restart 126 126 }}} 127 * ,,`[sudo]` is optional case you already have enough authority to modify your server.,,[[BR]][[BR]] 128 1. '''Test''' if this component is working properly. 129 1. If the plugin is installed correct, the example shown in the [#Usage] section on this page should be displayed.[[BR]][[BR]] 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. 130 129 131 == Bugs/Feature Requests ==130 == Bugs/Feature Requests 132 131 133 Existing '''[report:9?COMPONENT=CodeExampleMacro bugs and feature requests]'''for !CodeExampleMacro.132 Existing [report:9?COMPONENT=CodeExampleMacro bugs and feature requests] for !CodeExampleMacro. 134 133 135 If you have any issues, create a '''[/newticket?component=CodeExampleMacro&cc=rjollos&owner=nuald new ticket]'''.134 If you have any issues, create a [/newticket?component=CodeExampleMacro&cc=rjollos&owner=nuald new ticket]. 136 135 137 == Source & Download == 136 [[TicketQuery(component=CodeExampleMacro,group=type,format=progress)]] 138 137 139 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. 138 == Source & Download 140 139 141 === Recent Changes === 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 142 143 143 144 [[ChangeLog(codeexamplemacro, 3)]] 144 145 145 == Author/Contributors ==146 == Author/Contributors 146 147 147 148 '''Author:''' [wiki:nuald] [[BR]]