Tags:
create new tag
, view all tags

SourceHighlightPlugin

Highlight and format code fragments using GNU source-highlight

Introduction

This plugin allows you to have code fragments automatically formatted and highlighted using the GNU source-highlight package.

Syntax Rules

  • Just paste the code between %CODE{"syntax"}% and %ENDCODE%. The following indicates the syntax used for the different languages:

Language Key Syntax
C++ cpp %CODE{"cpp"}% ... %ENDCODE%
C cpp %CODE{"cpp"}% ... %ENDCODE%
Flex flex %CODE{"flex"}% ... %ENDCODE%
Java java %CODE{"java"}% ... %ENDCODE%
Perl perl %CODE{"perl"}% ... %ENDCODE%
PHP3 php3 %CODE{"php3"}% ... %ENDCODE%
Prolog prolog %CODE{"prolog"}% ... %ENDCODE%
Python python %CODE{"python"}% ... %ENDCODE%

You can also define a default language and use the shortcut:

%CODE% ... %ENDCODE%

Example

%CODE{"cpp"}%
   void foo() {
     print("Do stuff.\n");
   }
%ENDCODE%

Renders as

void foo() {
        print("Do stuff.\n");
}

SourceHighlightPlugin Global Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %SOURCEHIGHLIGHTPLUGIN_DEFAULTLANGUAGE%

  • One line description, is shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = Highlight and format code fragments using GNU source-highlight
    • Set DEBUG = 0

  • Full path to GNU source-highlight binary ( REQUIRED) [ Customised for RHUL TWiki, T.Crane, Fri Oct 19 03:31:16 BST 2012]
    • Set BINARY = /usr/bin/source-highlight

  • Language to use when none specified (optional); choose from one of the Key values in the table above
    • Set DEFAULTLANGUAGE = cpp

  • CSS class to use for the div tag surrounding the HTML output; if undefined we use codefragment
    • Set FORMATCLASS =

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

  • Install the GNU source-highlight package and note its location
  • Open /usr/local/shard/source-highlight/html.outlang. Eliminate all <tt> </tt>s. This avoids a blank line at the beginning of the code.
  • Download the ZIP file from the Plugin web (see below)
  • Unzip SourceHighlightPlugin.zip in your twiki installation directory. Content:
File: Description:
data/TWiki/SourceHighlightPlugin.txt Plugin topic
lib/TWiki/Plugins/SourceHighlightPlugin.pm Plugin Perl module
  • Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.
  • To get a smart-looking box around the code fragment, something like the following is needed in the skin's stylesheet. Note that you may need to change the class name if you modify the FORMATCLASS configuration variable above.

.codefragment {
        background : #FFFFCC;
        border : 1px solid #CCCCCC;
        margin-left : 2em;
        margin-right : 2em;
        padding : 4px;
}

  • Test if the installation was successful:
package com.foo.stuff;

import java.util.ArrayList; import java.util.List;

public class Thingy { private List myList;
        
        public Thingy() { myList = new ArrayList(); }
        
        /** * @param count This is the thingy you want. */ public String getThingy( int count ) { return (String)myList.get( count ); } } 

Plugin Info

Plugin Author: TWiki:Main.ChrisWinters
Copyright: 2003 TWiki:Main.ChrisWinters,
2003-2010 TWiki:TWiki.TWikiContributor
License: GPL (GNU General Public License)
Plugin Version: 19332 (2010-08-06)
Change History:
2010-08-06: TWikibug:Item6530 - doc enhancements; changing TWIKIWEB to SYSTEMWEB -- TWiki:Main.PeterThoeny
2009-02-10: Fix for last bracket missing; fixed default language, changing from DEFAULTLANG to DEFAULTLANGUAGE -- TWiki:Main.FengZhaolin
2003-01-23: Adapted from TWiki:Plugins.BeautifierPlugin -- TWiki:Main.ChrisWinters
CPAN Dependencies: none
Other Dependencies: GNU source-highlight
Perl Version: 5.005
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/SourceHighlightPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/SourceHighlightPluginDev

Related Topics: TWikiPreferences, TWikiPlugins

Physics WebpagesRHUL WebpagesCampus Connect • Royal Holloway, University of London, Egham, Surrey TW20 0EX; Tel/Fax +44 (0)1784 434455/437520

Topic revision: r4 - 19 Oct 2012 - TomCraneAdmin

 
This site is powered by the TWiki collaboration platformCopyright © 1999-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding RHUL Physics Department TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.SourceHighlightPlugin.