[Summary view] [Print] [Text view]

   1  This extension allows source code to be syntax highlighted on the wiki pages.
   2  This README file might be out of date, have a look at the extension page
   3  for updated informations:
   4  
   5      http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi
   6  
   7  == Requirements ==
   8  
   9  This version of the extension has been tested with GeSHi 1.0.8.11 and MediaWiki 1.24
  10  as of 2014-05-10. It may or may not work with earlier versions of the aforementioned
  11  software. To get releases of this extension compatible with earlier versions of
  12  MediaWiki, visit: 
  13  
  14      http://www.mediawiki.org/wiki/Special:ExtensionDistributor/SyntaxHighlight_GeSHi
  15  
  16  
  17  == Installation ==
  18  
  19  Add this line to your LocalSettings.php:
  20  
  21      require_once ("extensions/SyntaxHighlight_GeSHi/SyntaxHighlight_GeSHi.php");
  22  
  23  == Usage ==
  24  
  25  On the wiki page, you can now use "source" elements:
  26  
  27  <source lang="php">
  28  <?php
  29      v = "string";    // sample initialization
  30  ?>
  31  html text
  32  <?php
  33      echo v;         // end of php code
  34  ?>
  35  </source>
  36  
  37  == Parameters ==
  38  
  39  Please see the documentation of GeSHi on http://qbnz.com/highlighter/geshi-doc.html
  40  for detailed information to use some of the parameters.
  41  
  42  * lang;        Defines the language 
  43  * line;        Corresponds to enable_line_numbers method on GeSHi
  44  * start;    Corresponds to start_line_numbers_at method on GeSHi
  45  * strict;    Corresponds to enable_strict_mode method on GeSHi
  46  
  47  == Note ==
  48  
  49  GeSHi is generous about creating HTML elements: highlighting large blocks of
  50  code can easily generate enough of them to crash a browser. As a guard, symbol
  51  highlighting is turned off for code fragments larger than 100 kB. For fragments
  52  larger than 200 kB, string highlighting is turned off as well.