← Back to branch summary

~ubuntu-branches/ubuntu/saucy/mediawiki-extensions/saucy

« back to all changes in this revision

Viewing changes to dist/mediawiki-extensions-geshi/usr/share/doc/mediawiki-extensions/geshi/README

  • Committer: Bazaar Package Importer
  • Author(s): Romain Beauxis
  • Date: 2010-05-04 15:13:35 UTC
  • mfrom: (0.1.1 experimental)
  • Revision ID: james.westby@ubuntu.com-20100504151335-54qeucg3ec108q28
Tags: 2.2
http://bugs.debian.org/580066
http://bugs.debian.org/579667
* Added Replaces:/Conflicts: to allow a proper upgrade.
Closes: #580066
* Fixed package descriptions.
Closes: #579667
* Patched mediawiki-extensions-fckeditor to make it work with
  php 5.3. The fix may not be perfect but at least it work.
  Not closing the bug (#579822) for now..

Show diffs side-by-side

added added

removed removed

Lines of Context:
dist/mediawiki-extensions-geshi/usr/share/doc/mediawiki-extensions/geshi/README
 
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
== Installation ==
 
8
 
 
9
Download the latest stable build from
 
10
http://sourceforge.net/project/showfiles.php?group_id=114997, and unzip it into
 
11
your extensions/SyntaxHighlight_GeSHi/ directory. (Note: the zip file creates a 
 
12
sub-directory called geshi/, and places a file geshi.php there)
 
13
 
 
14
Add this line to your LocalSettings.php:
 
15
 
 
16
        require_once("extensions/SyntaxHighlight_GeSHi/SyntaxHighlight_GeSHi.php");
 
17
 
 
18
If your MediaWiki software is obtained via Subversion, then the latest build 
 
19
can be downloaded via the Subversion repository. First of all, is to switch 
 
20
into your extensions/SyntaxHighlight_GeSHi/ directory. Then invoke the command 
 
21
to obtain the latest build of the GeSHi code:
 
22
 
 
23
        svn checkout http://geshi.svn.sourceforge.net/svnroot/geshi/trunk/geshi-1.0.X/src/ geshi
 
24
 
 
25
If needed, change the following line on SyntaxHighlight_GeSHi.class.php to 
 
26
suit the path of your geshi.php file
 
27
    
 
28
        require_once( 'geshi/geshi.php' );
 
29
 
 
30
== Usage ==
 
31
 
 
32
On the wiki page, you can now use "source" elements:
 
33
 
 
34
<source lang="php">
 
35
<?php
 
36
    v = "string";    // sample initialization
 
37
?>
 
38
html text
 
39
<?
 
40
    echo v;         // end of php code
 
41
?>
 
42
</source>
 
43
 
 
44
== Parameters ==
 
45
 
 
46
Please see the documentation of GeSHi on http://qbnz.com/highlighter/geshi-doc.html
 
47
for detailed information to use some of the parameters.
 
48
 
 
49
* lang;         Defines the language 
 
50
* line;         Corresponds to enable_line_numbers method on GeSHi
 
51
* start;        Corresponds to start_line_numbers_at method on GeSHi
 
52
* strict;       Corresponds to enable_strict_mode method on GeSHi