MediaWiki扩展：语法高亮处理

wangsisi

本文取自元维基，欢迎共同翻译、整理与大家共享，促进中文wiki发展^_^

This extension can be seen in action on the Ciscavate.org wiki: [1] The GeSHiHighlight main page is at Ciscavate:MediaWiki_Extensions

The advantages of GeSHiHighlight over GeSHiColor are 1) it handles more langugages, 2) is still being maintained, and 3) seems to work better in general, although I can't vouch for that personally.

(there is a more active-seeming page for GeSHiHilight at: User:Ajqnic:GeSHiHighlight

History (Brief!)

The pre tags in mediawiki are nice, but they don't quite cut it for source code. With that in mind, I went questing for a syntax highlighting extension, and found "SyntaxHighlight" (http://www.wickle.com/wikis/index.php/Syntax_Highlight_extension) by Coffman, but I disagree with the use of two tags--one to specify you are in a code block, and another to specify the language:

1. <code><perl/> foreach(@myarr){print $_;}</code>

复制代码

To get arround that, I hacked Coffman's 1.2 release to accept language tags:

1. <perl>foreach(@myarr){print $_;}</perl>
   
2. <java>public class foo{ /* .... */ }</java>
   

复制代码

That version is available here: ...... but I'm not planning on updating it again.

There is another drawback--SyntaxHighlight uses enscript, which (IMO) produces horrible results---better than just pre when dealing with source code, but I want more than comments, strings and keywords to be fontified.

Enter GeSHi.

MediaWiki and GeSHi

GeSHi (found here: http://qbnz.com/highlighter/index.php ) is a syntax highlighing library written in php. I'm new to php (and by new, I mean I wrote my first line of php code about 4 hours prior writing this--see above) and I was amazed at how easy it was to use GeSHi (this says nothing about my love/hate for php in general...).

Why GeSHi?

    * Better highlighting. Flat-out kicks enscript's ass. I'm not fond of the default colors, but that can be dealt with later.
    * php. enscript, being an external program was writing files with md5hash names, which caused update issues when I was testing, command line params changed causing issues, not quite as elegant. (Using an external program was also my first inclination when thinking about this problem--I actually almost discarded GeSHi because of this narrow-mindedness.)
    * It seems to be actively developed. The release I'm using now is only about a week old.

So, where's the source? Here:

1. <?php
   
2. # GeSHiHighlight.php
   
3. #
   
4. # By: E. Rogan Creswick (aka: Largos)
   
5. # creswick@gmail.com
   
6. # wiki.ciscavate.org
   
7. #
   
8. # License: GeSHi Highlight is released under the Gnu Public License (GPL), and comes with no warranties.
   
9. # The text of the GPL can be found here: http://www.gnu.org/licenses/gpl.html
   
10. # Loosely based on SyntaxHighlight.php by Coffman, (www.wickle.com)
    
11. 
    
12. class SyntaxSettings {};
    
13. 
    
14. $wgSyntaxSettings = new SyntaxSettings;                                                                                                                                                                                                                                 
    
15. $wgExtensionFunctions[] = "wfSyntaxExtension";                                                                                                                 
    
16. 
    
17. function wfSyntaxExtension() {                                                                                                                                 
    
18.         global $wgParser;
    
19.         $langArray = geshi_list_languages("extensions\\geshi\\geshi");
    
20. #       $langArray = array("actionscript","ada","apache","asm","asp","bash",
    
21. #                          "caddcl","cadlisp","c","cpp","css","delphi",
    
22. #                          "html4strict","java","javascript","lisp", "lua",
    
23. #                          "nsis","oobas","pascal","perl","php-brief","php",
    
24. #                          "python","qbasic","sql","vb","visualfoxpro","xml");
    
25. 
    
26.         foreach ( $langArray as $lang ){
    
27.              if ($lang == "") continue;                                          
    
28.              $wgParser->setHook( $lang,                                                                                                                           
    
29.                 create_function( '$text', '$geshi = new GeSHi(rtrim(ltrim($text,"\n\r")), ' . $lang . ', "includes/geshi");
    
30.                                         return $geshi->parse_code();'));         
    
31.         }                                                                                                                                                      
    
32. }        
    
33. 
    
34. /**
    
35. * function: geshi_list_languages
    
36. * -------------------------
    
37. * List supported languages by reading the files in the geshi/geshi subdirectory
    
38. * (added by JeffK -- Jeff, any more contact info?)  -- I haven't tested the code is is, will do that shortly. -Rogan
    
39. *
    
40. */
    
41. function geshi_list_languages ( $path = 'geshi/' )
    
42. {
    
43.     if ($handle = opendir($path)) {
    
44.        /* Loop over the directory. */
    
45.        while (false !== ($file = readdir($handle))) {
    
46.            /* Drop the current and parent dir entries */
    
47.            if( "." !== $file && ".." !== $file )
    
48.            {
    
49.            /* Drop files that dont end with .php */
    
50.            if( ".php" == substr($file, strrpos($file, "."),4))
    
51.            {
    
52.                $lang_list .= substr($file, 0, strrpos($file, ".")).",";
    
53.            }
    
54.            }
    
55.        }
    
56. 
    
57.        closedir($handle);
    
58.     }
    
59.     return explode(",", $lang_list);
    
60. }                                                                                                                                                      
    
61. ?>

复制代码

Yep, that's IT. Bang. pretty syntax highlighting with 28 language tags, for 28 languages (disclaimer: I haven't tested all these, and I have suspicions about html4strict working out of the box, but still.)

Installation

    * Install GeSHi per the GeSHi install instructions (link above)
    * Don't forget to include GeSHi also:  

1.    include_once("geshi.php")

复制代码

* Either cut & paste the above, or downloade GeSHiHighlight.php here: add file
    * Put GeSHiHighlight.php in your mediaWiki extensions folder
    * Add:  

1.   include("extensions/GeSHiHighlight.php");

复制代码

      to LocalSettings.php