BeautifierPlugin < TWiki

TWiki Web>BeautifierPlugin (28 Apr 2007, TWikiContributor) (raw view)EditAttach
---+ <nop>%TOPIC%

This plugin allows you to have code fragments automatically formatted and highlighted. It uses the [[http://www.beautifier.org/][Beautifier library]] (included) written by Mike Jewell.


---++ Syntax Rules

   * Insert the code between =%<nop>CODE{"<i>language</i>"}%= and =%ENDCODE%=.  The following table indicates the values used for the different languages:

<blockquote>
| *Language* | *Syntax* |
| bash | =%<nop>CODE{"bash"}%= ... =%ENDCODE%= |
| C++ | =%<nop>CODE{"cpp"}%= ... =%ENDCODE%= |
| C# | =%<nop>CODE{"csharp"}%= ... =%ENDCODE%= |
| Java | =%<nop>CODE{"java"}%= ... =%ENDCODE%= |
| <nop>JavaScript | =%<nop>CODE{"javascript"}%= ... =%ENDCODE%= |
| Lua | =%<nop>CODE{"lua"}%= ... =%ENDCODE%= |
| Makefile | =%<nop>CODE{"makefile"}%= ... =%ENDCODE%= |
| Perl | =%<nop>CODE{"perl"}%= ... =%ENDCODE%= |
| PL/SQL | =%<nop>CODE{"plsql"}%= ... =%ENDCODE%= |
| Python | =%<nop>CODE{"python"}%= ... =%ENDCODE%= |
| PHP3 | =%<nop>CODE{"php3"}%= ... =%ENDCODE%= |
| Scheme | =%<nop>CODE{"scheme"}%= ... =%ENDCODE%= |
| TCL | =%<nop>CODE{"tcl"}%= ... =%ENDCODE%= |
| HTML | =%<nop>CODE{"html"}= ... =%ENDCODE%= |
| XML | =%<nop>CODE{"xml"}%= ... =%ENDCODE%= |
| Verilog | =%<nop>CODE{"verilog"}%= ... =%ENDCODE%= |
| VHDL | =%<nop>CODE{"vhdl"}%= ... =%ENDCODE%= |
</blockquote>

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://www.beautifier.org and converting the relevant language file from PHP to Perl.

---+++ Display Customisation

The code fragments are formaated using CSS. To change the look, upload a new version of [[%PUBURL%/%WEB%/%TOPIC%/style.css][style.css]] to this topic.


---++ Examples

<blockquote>
<pre>
%<nop>CODE{"cpp"}%
   void foo() {
     print("Do stuff.\n");
   }
%ENDCODE%
</pre>
</blockquote> 


---++ <nop>%TOPIC% Global Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>BEAUTIFIERPLUGIN_SHORTDESCRIPTION%==

   * One line description, is shown in the %TWIKIWEB%.TextFormattingRules topic:
      * Set SHORTDESCRIPTION = Highlights and formats code fragments


---++ 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 ==%TOPIC%.zip== in your twiki installation directory, this will also install the Beautifier library by default. Content:
   * (Dakar) Visit =configure= in your TWiki installation, and enable the plugin in the {Plugins} section.
   * To install the Beautifier library, either install it in the Perl library folder or unpack it into the twiki directory.  For the latter, the following files are installed:
     | *File:* | *Description:* |
   | ==data/TWiki/BeautifierPlugin.txt== | NEW |
   | ==data/TWiki/VarCODE.txt== | NEW |
   | ==lib/Beautifier/Context.pm== | NEW |
   | ==lib/Beautifier/Core.pm== | NEW |
   | ==lib/Beautifier/HFile.pm== | NEW |
   | ==lib/Beautifier/Magic.pm== | NEW |
   | ==lib/Beautifier/MagicConfig.pm== | NEW |
   | ==lib/HFile/HFile_bash.pm== | NEW |
   | ==lib/HFile/HFile_cpp.pm== | NEW |
   | ==lib/HFile/HFile_csharp.pm== | NEW |
   | ==lib/HFile/HFile_html.pm== | NEW |
   | ==lib/HFile/HFile_java.pm== | NEW |
   | ==lib/HFile/HFile_javascript.pm== | NEW |
   | ==lib/HFile/HFile_lua.pm== | NEW |
   | ==lib/HFile/HFile_makefile.pm== | NEW |
   | ==lib/HFile/HFile_perl.pm== | NEW |
   | ==lib/HFile/HFile_php3.pm== | NEW |
   | ==lib/HFile/HFile_plsql.pm== | NEW |
   | ==lib/HFile/HFile_python.pm== | NEW |
   | ==lib/HFile/HFile_scheme.pm== | NEW |
   | ==lib/HFile/HFile_tcl.pm== | NEW |
   | ==lib/HFile/HFile_vhdl.pm== | NEW |
   | ==lib/HFile/HFile_xml.pm== | NEW |
   | ==lib/Output/ANSI.pm== | NEW |
   | ==lib/Output/DocBook.pm== | NEW |
   | ==lib/Output/HTML.pm== | NEW |
   | ==lib/TWiki/Plugins/BeautifierPlugin.pm== | NEW |
   | ==pub/TWiki/BeautifierPlugin/style.css== | NEW |


   * 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%


---++ History

| *Date* | *Change* | *Name* |
| 20 May 2007 | added <nop>JavaScript language file, removed legacy CODE_<i>lang</i> construct | TWiki:Main.WillNorris |
| 30 Apr 2007 | warnings cleanup; no functional changes | TWiki:Main.WillNorris |
| 27 Apr 2007 | automatically adds CSS for formatting code fragments | TWiki:Main.WillNorris |
|  1 Jan 2006 | upgraded to TWiki::Func::extractNameValuePair for better parameter parsing, upgraded TWiki:Plugins.BuildContrib support | TWiki:Main.WillNorris |
| 26 Jul 2003 | Syntax fixes from TWiki:Main/WillNorris  | TWiki:Main/LingLo |
| 10 Feb 2003 | Syntax fix from TWiki:Main/JoshMore  | TWiki:Main/LingLo |
| 28 Dec 2002 | Accepts mixed case language names | TWiki:Main/LingLo |
| 20 Dec 2002 | Changed syntax to allow for simpler addition of new languages | TWiki:Main/LingLo |
| 16 Oct 2002 | Added nebula nodes and links to Python scripts, but it doesn't work since the node names are usually in strings | TWiki:Main/LeafGarland |
| 30 Jul 2002 | Added nebula nodes and links to TCL scripts | TWiki:Main/LeafGarland |
| 30 Jul 2002 | Changed Beautifier::Core to use 'linkscripts' | TWiki:Main/LeafGarland |
| 28 Jul 2002 | Created | TWiki:Main/LingLo |


---++ Plugin Info

|  Plugin Author: | TWiki:Main/LingLo |
|  Plugin Version: | 27 Apr 2007 |
|  CPAN Dependencies: | none |
|  Other Dependencies: | [[http://www.beautifier.org][Beautifier]] (supplied) |
|  Perl Version: | 5.005 |
|  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |

__Related Topics:__ %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins

-- TWiki:Main.LingLo - 18 Dec 2002
Attachments
Topic attachments
I	Attachment	Action	Size	Date	Who	Comment
css	style.css	manage	0.2 K	28 Apr 2007 - 23:01	TWikiContributor	CSS to format code fragments
Topic revision: r2 - 28 Apr 2007 - 23:27:25 - TWikiContributor
TWiki
Webs
DnD
Main
Support
TWiki
Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.BeautifierPlugin