BeautifierPlugin

Introduction

This plugin allows you to have code fragments automatically formatted and highlighted. It uses the Beautifier library (included) written by Mike Jewell.

Syntax Rules

Insert the code between %CODE{"language"}% and %ENDCODE%. The following table indicates the values used for the different languages:

Language	Syntax
bash	%CODE{"bash"}% ... %ENDCODE%
C++	%CODE{"cpp"}% ... %ENDCODE%
C#	%CODE{"csharp"}% ... %ENDCODE%
Corba	%CODE{"corba"}% ... %ENDCODE%
CSS	%CODE{"css"}% ... %ENDCODE%
HTML	%CODE{"html"}% ... %ENDCODE%
IDL	%CODE{"idl"}% ... %ENDCODE%
Java	%CODE{"java"}% ... %ENDCODE%
JavaScript	%CODE{"javascript"}% ... %ENDCODE%
Lua	%CODE{"lua"}% ... %ENDCODE%
Makefile	%CODE{"makefile"}% ... %ENDCODE%
Perl	%CODE{"perl"}% ... %ENDCODE%
PHP3	%CODE{"php3"}% ... %ENDCODE%
PL/SQL	%CODE{"plsql"}% ... %ENDCODE%
Python	%CODE{"python"}% ... %ENDCODE%
Scheme	%CODE{"scheme"}% ... %ENDCODE%
TCL	%CODE{"tcl"}% ... %ENDCODE%
HTML	%CODE{"html"} ... %ENDCODE%
Visual Basic	%CODE{"vb"}% ... %ENDCODE%
Verilog	%CODE{"verilog"}% ... %ENDCODE%
VHDL	%CODE{"vhdl"}% ... %ENDCODE%
XML	%CODE{"xml"}% ... %ENDCODE%

Additional languages can be added since the Beautifier library is flexible and can support a wide range of language families. Other languages can be added with relative ease by downloading the full PHP dist from http://sourceforge.net/projects/beautifier/ and converting the relevant language file from PHP to Perl. Note: The original http://www.beautifier.org/ website is defunct.

Display Customisation

The code fragments are formaated using CSS. To change the look, upload a new version of style.css to this topic.

Examples

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

BeautifierPlugin Global Settings

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

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Highlight and format source code fragments of various languages

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.

• Download the ZIP file from the Plugin web (see below)
• Unzip BeautifierPlugin.zip in your twiki installation directory, this will also install the Beautifier library by default. Content:

  File:	Description:
  data/TWiki/BeautifierPlugin.txt
  data/TWiki/VarCODE.txt
  lib/Beautifier/Context.pm
  lib/Beautifier/Core.pm
  lib/Beautifier/HFile.pm
  lib/Beautifier/Magic.pm
  lib/Beautifier/MagicConfig.pm
  lib/HFile/HFile_bash.pm
  lib/HFile/HFile_corba.pm
  lib/HFile/HFile_cpp.pm
  lib/HFile/HFile_csharp.pm
  lib/HFile/HFile_css.pm
  lib/HFile/HFile_html.pm
  lib/HFile/HFile_idl.pm
  lib/HFile/HFile_java.pm
  lib/HFile/HFile_javascript.pm
  lib/HFile/HFile_lua.pm
  lib/HFile/HFile_makefile.pm
  lib/HFile/HFile_perl.pm
  lib/HFile/HFile_php3.pm
  lib/HFile/HFile_plsql.pm
  lib/HFile/HFile_python.pm
  lib/HFile/HFile_scheme.pm
  lib/HFile/HFile_tcl.pm
  lib/HFile/HFile_verilog.pm
  lib/HFile/HFile_vb.pm
  lib/HFile/HFile_vhdl.pm
  lib/HFile/HFile_xml.pm
  lib/Output/ANSI.pm
  lib/Output/DocBook.pm
  lib/Output/HTML.pm
  lib/TWiki/Plugins/BeautifierPlugin.pm
  pub/TWiki/BeautifierPlugin/style.css

• • Optionally, move the lib/Beautifier, lib/Output and lib/HFile libraries into the Perl library folder.
• Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.
• Test if the installation was successful:

%CODE{"cpp"}% #include <nworld.h>

/** @brief Advance the simulation by one timeslice. */ void nWorld::StepSim() { // Iterate simulation loop for (node = entityList.GetHead(); node = NULL; node = node->GetSucc()) { entity = (nEntity*)node->GetPtr(); entity->Trigger(this, this->stepSize); } } %ENDCODE%

%CODE{"unknown"}% testing an invalid language setting... %ENDCODE%

Plugin Info

Related Topics: TWikiPreferences, TWikiPlugins