Difference between revisions of "GeSHi"

From Organic Design wiki
m
m
Line 8: Line 8:
 
Blocks of source code can be wrapped in language tags like usual, as follows:
 
Blocks of source code can be wrapped in language tags like usual, as follows:
 
<pre><php>
 
<pre><php>
    print "foo";
+
print "foo";
 
</php></pre>
 
</php></pre>
 
but also template syntax can be used to make the entire article be rendered by the GeSHi parser. The templates expand to nothing, so they can be placed anywhere in the article without affecting its execution. Here's an example:
 
but also template syntax can be used to make the entire article be rendered by the GeSHi parser. The templates expand to nothing, so they can be placed anywhere in the article without affecting its execution. Here's an example:
 
<pre>
 
<pre>
    {{per1}}
+
{{per1}}
    print "bar";
+
print "bar";
 
</pre>
 
</pre>
  

Revision as of 03:17, 18 April 2007

Syntax highlighting on Organic Design

The standard GeSHi MediaWiki extensions don't quite suit our purposes because our articles containing code are usually directly executed which means that we can't include GeSHi code tags.

Another problem is that we'd often like the ability to use MediaWiki templates even if the content is code, for example when defining LocalSettings articles by transcluding the wiki template and extension templates. So I've also added an extra line of code into the GeSHi extension before it parses the content to achieve this:

Using syntax highlighting on Organic Design wikis

Blocks of source code can be wrapped in language tags like usual, as follows:

<php>
print "foo";
</php>

but also template syntax can be used to make the entire article be rendered by the GeSHi parser. The templates expand to nothing, so they can be placed anywhere in the article without affecting its execution. Here's an example:

{{per1}}
print "bar";

Technical

To get around these issues, I've added a few extra lines after the GeSHi include to allow the tags to be added before parsing if a language template is transcluded. Here's the updated include line: <php> include('extensions/geshi/GeSHiCodeTag.php'); $wgHooks['ParserBeforeStrip'][] = 'GeSHi'; function GeSHi(&$parser, &$text, &$strip_state) {

   if (preg_match('/\\{\\{#(php|perl|c|actionscript|javascript|css)\\}\\}/i',$text,$m)) $text = "<$m[1]>\n$text\n</$m[1]>";
   return true;

</php> Templates or variables must be added which expand to nothing so they don't render as a red link. Also an extra line must be added to the GeSHiCodeTag.php file just before the geshi object is instantiated in the hook function to force the templates to expand. <php> $source = $GLOBALS["wgParser"]->replaceVariables($source); </php>