Beautifier Plugin

Introduction

Syntax

• Syntax: %CODE% … %ENDCODE% or %CODE{…}% … %ENDCODE%
• %CODE% … %ENDCODE% encapsulates a code fragment to be displayed using the default language syntax and CSS styling
• %CODE{…}% … %ENDCODE% encapsulates a code fragment to be displayed allowing the language syntax and CSS styling to be overridden according to any parameters supplied
• Supported parameters:

  Parameter:	Description:	Default
  "language"	The language syntax identifier	"cpp"
  css="URL"	The URL of a CSS stylesheet that extends the plugin's default styling for code fragments

• Supported language syntaxes:

  Language:	Identifier:		Language:	Identifier:		Language:	Identifier:
  bash	"bash"		Lua	"lua"		Scheme	"scheme"
  C++	"cpp"		Makefile	"makefile"		TCL	"tcl"
  C#	"csharp"		Perl	"perl"		Verilog	"verilog"
  HTML	"html"		PHP3	"php3"		VHDL	"vhdl"
  Java	"java"		PL/SQL	"plsql"		XML	"xml"
  JavaScript	"javascript"		Python	"python"

  • The Beautifier package supports many, many more language syntaxes but only the languages above have been ported to Foswiki at this point. If you need support for an additional syntax, please open an Enhancement Request to request the syntax you require.
• DOM Structure: The beautified code fragment is encapsulated within a <pre> element which, in turn, is encapulated within a <div> element which has two CSS class selectors, "fragment" and the language syntax identifier, which is itself encapsulated within a <div> element with the CSS class selector "BeautifierPlugin" as illustrated below.
  • <div class="BeautifierPlugin">
    • <div class=" language fragment">
      • <pre>
        • … beautified code fragment …
      • </pre>
    • </div>
  • </div>
  • Language-specific CSS styling can be applied to the beautified code fragment using CSS selectors of the form div.BeautifierPlugin div.language.fragment
  • Only one extended stylesheet may be supplied for a given topic using either the css="URL" macro parameter or the BEAUTIFIERPLUGIN_CSS preference setting. The final stylesheet specified is the one that will be used. If you wish to specify multiple customizations, combine all the CSS rules into a single stylesheet.

Examples

• BEAUTIFIERPLUGIN_LANGUAGE is: cpp
• BEAUTIFIERPLUGIN_CSS is: /fw/pub/Main/SitePreferences/style_extension_With.css

C++ Syntax

Show exampleHide example

#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);
        }
}

#include <nworld.h>

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

Lua Syntax With Custom CSS Styling

Show exampleHide example

Account = {}
Account.__index = Account

function Account.create(balance)
   local acnt = {}             -- our new object
   setmetatable(acnt,Account)  -- make Account handle lookup
   acnt.balance = balance      -- initialize our object
   return acnt
end

function Account:withdraw(amount)
   self.balance = self.balance - amount
end

-- create and use an Account
acc = Account.create(1000)
acc:withdraw(100)

Account = {}
Account.__index = Account

function Account.create(balance)
   local acnt = {}             -- our new object
   setmetatable(acnt,Account)  -- make Account handle lookup
   acnt.balance = balance      -- initialize our object
   return acnt
end

function Account:withdraw(amount)
   self.balance = self.balance - amount
end

-- create and use an Account
acc = Account.create(1000)
acc:withdraw(100)

Unknown Syntax

Show exampleHide example

For the following code fragment:

%CODE{"klingon"}%
	Heghlu'meH QaQ jajvam
%ENDCODE%
  

You would get (simulated):

Language 'klingon' not supported

	Heghlu'meH QaQ jajvam

You would get (actual):

Language 'klingon' not supported

	Heghlu'meH QaQ jajvam

Preference Settings

Setting Plugin Preferences

   * Set BEAUTIFIERPLUGIN_CSS = %ATTACHURL%/style.css
   * Set BEAUTIFIERPLUGIN_DEBUG = off
   * Set BEAUTIFIERPLUGIN_LANGUAGE = cpp

Installation

Installation instructionsInstallation instructions

Warning! This plugin and the dp.SyntaxHighlighter plugin conflict and are not compatible as they both implement the %CODE% and %ENDCODE% macros.

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.

Manual Installation

This plugin may be installed manually by downloading the distribution package attached to the Foswiki:Extensions.BeautifierPlugin topic.

1. Install/upgrade any packages listed in Dependencies below
2. Download the .zip or .tgz distribution package and place it in the root directory of your Foswiki installation.
3. Unpack the distribution package
4. Using the Foswiki configuration utility, enable the plugin. (If using an accellerator such as mod_perl, it may be necessary to restart your server before your configuration changes will take effect.)
5. Set any default preference values in Site, Web, and User Preference topics as desired.

Installation Test

#include <nworld.h>

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

Manifest

File:	Description:
data/System/BeautifierPlugin.txt	Plugin documentation topic
data/System/VarCODE.txt	Syntax summary for the CODE macro
data/System/VarENDCODE.txt	Syntax summary for the ENDCODE macro
pub/System/BeautifierPlugin/style.css	Code fragment stylesheet
pub/System/BeautifierPlugin/style_extension.css	Code fragment stylesheet extension
lib/Foswiki/Plugins/BeautifierPlugin.pm	Plugin module
lib/Foswiki/Plugins/BeautifierPlugin/LICENSE	GNU GPLv2
lib/Foswiki/Plugins/BeautifierPlugin/ANSI.pm
lib/Foswiki/Plugins/BeautifierPlugin/Context.pm
lib/Foswiki/Plugins/BeautifierPlugin/Core.pm
lib/Foswiki/Plugins/BeautifierPlugin/DocBook.pm
lib/Foswiki/Plugins/BeautifierPlugin/HTML.pm
lib/Foswiki/Plugins/BeautifierPlugin/Magic.pm
lib/Foswiki/Plugins/BeautifierPlugin/MagicConfig.pm
lib/Foswiki/Plugins/BeautifierPlugin/HFile.pm
lib/Foswiki/Plugins/BeautifierPlugin/HFile/HFile_bash.pm
lib/Foswiki/Plugins/BeautifierPlugin/HFile/HFile_cpp.pm
lib/Foswiki/Plugins/BeautifierPlugin/HFile/HFile_csharp.pm
lib/Foswiki/Plugins/BeautifierPlugin/HFile/HFile_html.pm
lib/Foswiki/Plugins/BeautifierPlugin/HFile/HFile_java.pm
lib/Foswiki/Plugins/BeautifierPlugin/HFile/HFile_javascript.pm
lib/Foswiki/Plugins/BeautifierPlugin/HFile/HFile_lua.pm
lib/Foswiki/Plugins/BeautifierPlugin/HFile/HFile_makefile.pm
lib/Foswiki/Plugins/BeautifierPlugin/HFile/HFile_perl.pm
lib/Foswiki/Plugins/BeautifierPlugin/HFile/HFile_php3.pm
lib/Foswiki/Plugins/BeautifierPlugin/HFile/HFile_plsql.pm
lib/Foswiki/Plugins/BeautifierPlugin/HFile/HFile_python.pm
lib/Foswiki/Plugins/BeautifierPlugin/HFile/HFile_scheme.pm
lib/Foswiki/Plugins/BeautifierPlugin/HFile/HFile_tcl.pm
lib/Foswiki/Plugins/BeautifierPlugin/HFile/HFile_verilog.pm
lib/Foswiki/Plugins/BeautifierPlugin/HFile/HFile_vhdl.pm
lib/Foswiki/Plugins/BeautifierPlugin/HFile/HFile_xml.pm

Plugin Info