ScrewTurn Syntax Highlighter

December 6, 2008 16 Comments »

Overview

This is a lightweight Syntax Highlighter plugin for ScrewTurn Wiki. The plugin uses the Lonwas Highlighter, by Thomas Johansen and Christian Nordbakk, which currently supports 23 languages by default and is extensible through the use of an XML file.

Note: The Syntax Highlighter is only being used as a lightweight highlighter. This means that is does not support of the more advanced features, such as line numbering or keyword hyperlinks.

Usage

To highlight code simply surround the desired code with <code language> and </code>, where “language” denotes the language of the code E.G. C#.

Example:<code c#>public static void TestMethod() { return; }</code>

The <code> tags are parsed during phase1 (prior to the wiki parsing). During this time — apart from the syntax highlighting — the <code> tag is replaced with <pre class=“code language”>, where language denotes the language entered. This allows you to alter the display of the code, both for all code blocks and specific languages, through the use of css.

A few rules are applied to the language name when it is outputted as the class name of the pre tag.

The language name is converted to all lower cases.
White spaces are stripped.
# is converted to “sharp”.
. is converted to “dot”.
+ is converted to “plus”.

For example, this means <code c#> will produce <pre class=“code csharp”>.

Note: <nowiki> tags are placed around the code, so that any wiki syntax in the code will not be parsed by the wiki engine.

Supported languages: ASPX, C, C++, C#, COBOL, Eiffel, Fortran, Haskell, HTML, Java, JavaScript, Mercury, MSIL, Pascal, Perl, PHP, Python, Ruby, SQL, Visual Basic, VBScript, VB.NET, XML.

Installation

Download Syntax Highlighter.
Extract the uploads.zip folder into your root wiki directory.
- Definitions.xml should go in to your root directory.
- Lonwas.Highlight.dll should go in to your bin directory.
Log into your Wiki’s administration panel.
Click on the Providers tab.
Under Add new Providers click on browse and select TimBellette.ScrewTurnSyntaxHighlighter.dll and click upload.
- If your Definitions.xml file is not in the default location, or has been renamed, it will show up as disabled.
  1. Click Syntax Highlighter in your providers list and click Configure.
  2. Enter in the url of the uploaded Definitions.xml file (E.G. http://yoursite.com/wiki/Definitions.xml) and click save.
  3. Click Enable to enable the Syntax Highlighter.
You’re Done.

History

[Version 1.2, released 2007-06-16]
- Added default configuration setting.
[Version 1.1, released 2007-06-16]
- Fixed wiki rendering bug.
- Fixed css class names bug.
[Version 1.0, released 2007-06-15]
- First released.

Licensing

Posted in: Misc

16 Responses to “ScrewTurn Syntax Highlighter”

TimWeb » ScrewTurn Syntax Highlighter Plugin says:

December 6, 2008 at 8:00 am

[…] ScrewTurn Syntax Highlighter […]

Reply
Alex Williamson says:

December 18, 2008 at 8:53 pm

Hello, interesting plugin. I get a 404 when trying to download.

Thanks,
Alex

Reply
Tim Bellette says:

December 18, 2008 at 10:32 pm

Hi Alex, Thanks for letting me know the download was not working. It has been fixed and should work now. Thanks, Tim.

Reply
Brendan Rice says:

January 3, 2009 at 5:46 am

Hi,

Firstly thanks for making this public, I have found it excellent and have been using it to build up a code library.

I have set up a new WIKI and I get the following error when doing step 5.2. Can you help please?

Thanks,

Brendan

http://www.???.com/Admin.aspxSystem thrown System.Net.WebExceptionThe remote server returned an error: (401) Unauthorized. at System.Net.HttpWebRequest.GetResponse() at System.Xml.XmlDownloadManager.GetNonFileStream(Uri uri, ICredentials credentials) at System.Xml.XmlUrlResolver.GetEntity(Uri absoluteUri, String role, Type ofObjectToReturn) at System.Xml.XmlTextReaderImpl.OpenUrlDelegate(Object xmlResolver) at System.Threading.CompressedStack.runTryCode(Object userData) at System.Runtime.CompilerServices.RuntimeHelpers.ExecuteCodeWithGuaranteedCleanup(TryCode code, CleanupCode backoutCode, Object userData) at System.Threading.CompressedStack.Run(CompressedStack compressedStack, ContextCallback callback, Object state) at System.Xml.XmlTextReaderImpl.OpenUrl() at System.Xml.XmlTextReaderImpl.Read() at System.Xml.XmlLoader.Load(XmlDocument doc, XmlReader reader, Boolean preserveWhitespace) at System.Xml.XmlDocument.Load(XmlReader reader) at System.Xml.XmlDocument.Load(String filename) at TimBellette.ScrewTurnSyntaxHighlighter.SyntaxHighlighter.Init(IHost host, String config) at ScrewTurn.Wiki.Admin.btnSaveProviderConfiguration_Click(Object sender, EventArgs e) in c:\Web\Wiki\Admin.aspx.cs:line 2045 at System.Web.UI.WebControls.Button.OnClick(EventArgs e) at System.Web.UI.WebControls.Button.RaisePostBackEvent(String eventArgument) at System.Web.UI.Page.RaisePostBackEvent(IPostBackEventHandler sourceControl, String eventArgument) at System.Web.UI.Page.ProcessRequestMain(Boolean includeStagesBeforeAsyncPoint, Boolean includeStagesAfterAsyncPoint)

Reply
Tim Bellette says:

January 3, 2009 at 5:56 am

Hi Brendan,

Thanks for your comments :)

It looks like there could be a permissions exception occurring when the plugin is trying to read the xml file. Please check security permissions to his file and ensure asp.net has read access.

Cheers,
Tim

Reply
Brendan Rice says:

January 3, 2009 at 6:28 am

Hi Tim,

you are right about the permissions, it is sorted now, may be an idea to include the permissions step in the instructions, it is easily overlooked.

Good job with the plug in.

Thanks again,

Brendan

Reply
James Patterson says:

January 27, 2009 at 8:22 pm

Hi Tim,

Any plans to update the highlighter so that it works with v3?

Reply
Michal says:

February 5, 2009 at 1:01 am

Hello, everytime I have “<script” inside “code aspx” tag I get “Unallowed SCRIPT tag detected in the content”. Any chance your plugin could bypass that?

Reply
Alexander Williamson says:

February 25, 2009 at 2:07 am

Hi Tim,

It works now thanks.

@Michal:
Could you convert your tags to HTML e.g. < to < etc. and then put that in the tags...?

Reply
Chris Herborth says:

April 10, 2009 at 3:55 am

Hi Tim,

Excellent syntax highlighter, we’re using it on our internal R&D wiki. We’ve run it (and Lonwas.Highlight, which seems to have disappeared off the ‘net) through a disassembler so we could update the code for ScrewTurn 3.

Thanks!

Reply
User says:

April 15, 2009 at 5:56 pm

If you copy and paste the parsed code from Firefox work, but you copy and paste from IE some line don’t copy the CR/LF

Reply
Chris Kirby says:

April 30, 2009 at 4:16 am

Hello,

What can i do when one of the xml tags I’m trying to format is string data? is there some way i can escape that so that the will format my xml properly?
Excellent plugin btw!
Thank you, Chris

Reply
Chris Kirby says:

April 30, 2009 at 4:42 am

@Chris Kirby
for some reason the site reformatted my question.. I’ll try escaping:

trying to format: >code$lt;my data$gt/code$lt; using the code XML wrapper.

Reply
Thank you says:

May 14, 2009 at 8:43 pm

Hi Tim,

Thank you. We’re using your *excellent* Syntax Highlighter plugin for over a year now in our code library. Customization through the use of an XML file was a godsend! It made possible to define our own scheme.

Reply
Softlion says:

July 24, 2009 at 10:50 pm

I’ve upgraded the syntax highlighter for ScrewTurn wiki v3 RC1.
Download it from there:

http://www.softlion.com/blogs/post/2009/07/24/Syntax-Highlighter-for-ScrewTurn-wiki-v3.aspx

Reply
Richard says:

January 13, 2010 at 1:56 am

Hi Tim,

I’m having an issue with the following code:

Row Id Name
[EACHROW] [#RowNumber][DepartmentId][Name] [/EACHROW]

It seems the gets collapsed to just

Reply

TimWeb