Syntaxhighlighter with activeCollab documentation

I posted some documentation for a free aC module today: Syntaxhighlighter with AC.

I pulled it together from the forum posts.
Here’s the content of the file:
================================================================================
=                     About this module                =
================================================================================
Name:
Syntaxhighlight

Version:
1.5 Beta

Description:
This module utilizes SyntaxHighlighter v.2.1.364 to highlight code snippets. It is 100% Java Script based. The script is triggered when it encounters code a [syh:lang] tag. e.g. [syh:php]<?php … ?>[/syh].

Links:
Module page: http://www.activecollab.com/downloads/category/4/package/44
Forum: http://www.activecollab.com/forums/topic/5230/1/
SyntaxHighlighter: http://alexgorbatchev.com/SyntaxHighlighter/manual/brushes/

Author:
MarkA – http://www.activecollab.com/user/24292/profile/

Co-author / Maintainer:
Panagiotis K. – http://www.activecollab.com/user/23915/profile/

Contributors:
mvas – http://www.activecollab.com/user/41744/profile/
Leon P. – http://www.activecollab.com/user/2010/profile/

Cost:
Module will remain free for everyone and at least not by me, there isn’t any plan at all to make it commercial!
SyntaxHighlighter is donationware. If you are using it, please donate: http://alexgorbatchev.com/SyntaxHighlighter/donate.html

Credits:
First thanks goes to MarkA who gave the birth
Second thanks go to mvas who packed it to a module
Then a raise it a little bit…
Forth thanks goes to Leon who provided very nice icons!!!
And of course a thanks for the people who had issues with that module and made us debug it to finally make it work well!!!
SyntaxHighlighter js author: Alex Gorbatchev

================================================================================
=                     Installation                =
================================================================================

Installation instructions:

In order to install the Syntax Highlight module and run it successfully you need to follow the following instructions.
——————————————————————————–
Step 1. Unzip the Syntax Highlighter zip file.

Step 2. Copy the syntaxhighlight folder to activecollab >> application >> modules in your site. We have placed it in the similar structure for your better understanding.

Step 3. That’s all login in your system and you will find the new Module ready to be installed

Step 4. After installation, please go to main administration page and click on the toggle nested items icon and enable it.
——————————————————————————–

After installation you will be able to use [syh:lang] tag in your text area input fields.

================================================================================
=                     Usage                =
================================================================================

Usage notes:

1) [syh] does not work, open tags must provide the highlight language, for example [syh:php]

2) Opening tags must be inside a pre-formatted tag (See “Screen Shot #1”)

3) No close tag needed since the open tag is inside a <pre> tag. Even simpler! ;)

4) multiple instances supported now, each instance must be on its own pre-formatted tag (See “Screen Shot #2”)

5) Inside the pre tag you must use shift + enter for new lines

6) tab spaces are now supported and also available on re-editing

7) Use “Clean text and paste” button to paste into the pre tag code from clipboard, DO NOT PASTE IT DIRECTLY INSIDE THE PRE TAG.

8) There is no button in the wysiwyg editor. You have to hand-type the syh tag

Script tested with PHP code only. Works everywhere (pages, discussions, tickets etc) Works great with default theme and also works with Access theme, one issue in Access theme is the height of the lines of the highlighted code when they are in comments.

Example:
[syh:php]<?php … ?>[/syh]
The above code produces this:

Supported languages:
1) AS3
.as
.asc
——————
2) Bash
——————
3) ColdFusion
.cfm
.cfc
——————
4) Cpp
.cpp
——————
5) CSharp
——————
6) Css
.css
——————
7) Delphi
——————
8) Diff
——————
9) Erlang
——————
10) Groovy
——————
11) Java
.java
.class
——————
12) JavaFX
——————
13) JScript
.js
——————
14) Perl
.pl
——————
15) Php
.php
.php3
.php4
.php5
.php6
.phtml
.inc
——————
16) Plain
All other extensions
——————
17) PowerShell
——————
18) Python
.py
——————
19) Ruby
.rb
——————
20) Scala
——————
21) Sql
.sql
——————
22) Vb
.vbp
.vs
——————
23) Xml
.html
.htm
.xml
.xslt

Comments
Leave a Comment