Diff: Help/SyntaxHighlighterPlugin

Note: You are viewing an old revision of this page. View the current version.

Differences between version 2 and previous revision of Help/SyntaxHighlighterPlugin.

Other diffs: Previous Major Revision, Previous Author

Newer page: version 2 Last edited on 22 May 2014 3:01 by harold Revert
Older page: version 1 Last edited on 17 January 2022 18:35 by harold Revert
@@ -1,53 +1,8 @@
-The **~SyntaxHighlighter** [[Help:WikiPlugin|plugin]] will highlight source  
-code in a variety of languages.  
-  
-Highlighting is done in Javascript with [[http://highlightjs .org/ ]].  
-  
-Recognized languages are the following:  
-| Apache | Bash | C# | C++  
-| CSS | ~CoffeeScript | Diff | HTML, XML  
-| HTTP | Ini | JSON | Java  
-| ~JavaScript | Makefile | Markdown | Nginx  
-| Objective C | PHP | Perl | Python  
-| Ruby | SQL  
+The **~SyntaxHighlighter** [[Help:WikiPlugin|plugin]] passes all its arguments through a C++  
+highlighter called "highlight" (available at [[http://www .andre-simon.de ]])
  
 == Arguments == 
-  
-None.  
-  
-The source code is put between {{{<<SyntaxHighlighter}}} and {{{>>}}}.  
-  
-== Example ==  
-  
-{{{  
-<<SyntaxHighlighter  
- #include <stdio.h>  
-  
- int main() {  
- printf("Lalala\n");  
- }  
->>  
-}}}  
-  
-will give:  
-  
-<<SyntaxHighlighter  
- #include <stdio.h>  
-  
- int main() {  
- printf("Lalala\n");  
- }  
->>  
-  
-== History ==  
-  
-The first implementation of this plugin passed all its arguments through a C++  
-highlighter called "highlight" (available at [[http://www.andre-simon.de]]).  
-  
-This implementation allowed the following arguments, which are now ignored.  
-  
-=== Former Arguments ===  
  
 {| class="bordered" 
 |- 
 ! Argument 
@@ -55,9 +10,9 @@
 ! Default value 
 |- 
 | **syntax** 
 
-| //none // (required argument), see http://www.andre-simon.de/doku/highlight/highlight.html 
+| //None // (required argument), see http://www.andre-simon.de/doku/highlight/highlight.html 
 |- 
 | **style** 
 
 | ~[ "ansi", "gnu", "kr", "java", "linux" ~] (required) 
@@ -73,15 +28,43 @@
 | **wrap** 
 
 | 0 (optional) 
 |} 
+  
+== Example ==  
+  
+{{{  
+<<SyntaxHighlighter syntax=c style=kr color=bright  
+ #include <stdio.h>  
+  
+ int main() {  
+ printf("Lalala\n");  
+ }  
+>>  
+}}}  
+  
+will give:  
+  
+<<SyntaxHighlighter syntax=c style=kr color=bright  
+ #include <stdio.h>  
+  
+ int main() {  
+ printf("Lalala\n");  
+ }  
+>>  
+  
+I did not use beautifier, because it used up more than 8M of memory on  
+my system and PHP killed it. I'm not sure whether this is a problem  
+with my integration, or with beautifier itself.  
  
 == Authors == 
  
 * alecthomas 
-* Fixes by [[Help:Reini Urban|Reini Urban]]  
-* Re-implementation with [[http ://highlightjs.org/]] by Alain Peyrat and Marc-Etienne Vargenau , Alcatel-Lucent  
+* Fixes by [[Help:Reini Urban|Reini Urban]]:  
+** support options : syntax, style, color,  
+** php version switch,  
+** HIGHLIGHT_DATA_DIR, HIGHLIGHT_EXE constants
  
 <noinclude> 
 ---- 
 [[PhpWikiDocumentation]] [[CategoryWikiPlugin]] 
 </noinclude> 

version 2

The SyntaxHighlighter plugin passes all its arguments through a C++ highlighter called "highlight" (available at http://www.andre-simon.de).

Arguments

Argument

Description

Default value

syntax

None (required argument), see http://www.andre-simon.de/doku/highlight/highlight.html

style

[ "ansi", "gnu", "kr", "java", "linux" ] (required)

color

null (optional), see highlight/themes

number

0 (optional)

wrap

0 (optional)

Example

<<SyntaxHighlighter syntax=c style=kr color=bright
 #include <stdio.h>

 int main() {
 printf("Lalala\n");
 }
>>

will give:


#include <stdio.h>

 int main() {
 printf("Lalala\n");
 }

I did not use beautifier, because it used up more than 8M of memory on my system and PHP killed it. I'm not sure whether this is a problem with my integration, or with beautifier itself.

Authors

  • alecthomas
  • Fixes by Reini Urban:

    • support options: syntax, style, color,
    • php version switch,
    • HIGHLIGHT_DATA_DIR, HIGHLIGHT_EXE constants,