modules/geshifilter/README.txt

// $Id$

============================
GeSHi Filter (Drupal Module)
============================


DESCRIPTION
-----------
The GeShi Filter is a Drupal module for syntax highlighting of pieces of
source code. It implements a filter that formats and highlights the syntax of
source code between for example <code>...</code>.


DEPENDENCY
----------
This module requires the third-party library GeShi 1.0.x (Generic Syntax
Highlighter, written by Nigel McNie) which can be found at
  http://qbnz.com/highlighter
See installation procedure below for more information.


INSTALLATION
------------
1. Extract the GeSHi Filter module tarball and place the entire geshifilter
  directory into your Drupal setup (e.g. in sites/all/modules).

2. Download the GeSHi library from
  http://sourceforge.net/projects/geshi/files/geshi
  Make sure you download a version of the branch 1.0.x and not a version
  from the branch 1.1.x (also described as geshi-dev), which is not yet
  supported by the GeSHi filter module.
  Place the entire extracted 'geshi' folder (which contains geshi.php)
  in the geshifilter directory (e.g. as /sites/all/modules/geshifilter/geshi)

3. Enable this module as any other Drupal module by navigating to
  administer > site building > modules


CONFIGURATION
-------------
1. The general GeSHi Filter settings can be found by navigating to:
  administer > site configuration > geshifilter
2. Further configuration instructions can be found by following the
  "more help..." link at the top of that general settings page, which leads
  to www.example.com/?q=admin/help/geshifilter . This requires you have the
  'help' module enabled.


USAGE
-----
The basic usage (with the default settings) is:
  <code language="java">
  for (int i; i<10; ++i) {
    dothisdothat(i);
  }
  </code>
When language tags are enabled (like "<java>" for Java) you can also do
  <java>
  for (int i; i<10; ++i) {
    dothisdothat(i);
  }
  </java>
More options and tricks can be found in the filter tips of the input format at
www.example.com/?q=filter/tips .


AUTHORS
-------
Original module by:
  Vincent Filby <vfilby at gmail dot com>

Drupal.org hosted version for Drupal 4.7:
  Vincent Filby <vfilby at gmail dot com>
  Michael Hutchinson (http://compsoc.dur.ac.uk/~mjh/contact)
  Damien Pitard <dpdev00 at gmail dot com>

Port to Drupal 5:
  rötzi (http://drupal.org/user/73064)
  Stefaan Lippens (http://drupal.org/user/41478)
1	// $Id$
2
3	============================
4	GeSHi Filter (Drupal Module)
5	============================
6
7
8	DESCRIPTION
9	-----------
10	The GeShi Filter is a Drupal module for syntax highlighting of pieces of
11	source code. It implements a filter that formats and highlights the syntax of
12	source code between for example <code>...</code>.
13
14
15	DEPENDENCY
16	----------
17	This module requires the third-party library GeShi 1.0.x (Generic Syntax
18	Highlighter, written by Nigel McNie) which can be found at
19	http://qbnz.com/highlighter
20	See installation procedure below for more information.
21
22
23	INSTALLATION
24	------------
25	1. Extract the GeSHi Filter module tarball and place the entire geshifilter
26	directory into your Drupal setup (e.g. in sites/all/modules).
27
28	2. Download the GeSHi library from
29	http://sourceforge.net/projects/geshi/files/geshi
30	Make sure you download a version of the branch 1.0.x and not a version
31	from the branch 1.1.x (also described as geshi-dev), which is not yet
32	supported by the GeSHi filter module.
33	Place the entire extracted 'geshi' folder (which contains geshi.php)
34	in the geshifilter directory (e.g. as /sites/all/modules/geshifilter/geshi)
35
36	3. Enable this module as any other Drupal module by navigating to
37	administer > site building > modules
38
39
40	CONFIGURATION
41	-------------
42	1. The general GeSHi Filter settings can be found by navigating to:
43	administer > site configuration > geshifilter
44	2. Further configuration instructions can be found by following the
45	"more help..." link at the top of that general settings page, which leads
46	to www.example.com/?q=admin/help/geshifilter . This requires you have the
47	'help' module enabled.
48
49
50	USAGE
51	-----
52	The basic usage (with the default settings) is:
53	<code language="java">
54	for (int i; i<10; ++i) {
55	dothisdothat(i);
56	}
57	</code>
58	When language tags are enabled (like "<java>" for Java) you can also do
59	<java>
60	for (int i; i<10; ++i) {
61	dothisdothat(i);
62	}
63	</java>
64	More options and tricks can be found in the filter tips of the input format at
65	www.example.com/?q=filter/tips .
66
67
68	AUTHORS
69	-------
70	Original module by:
71	Vincent Filby <vfilby at gmail dot com>
72
73	Drupal.org hosted version for Drupal 4.7:
74	Vincent Filby <vfilby at gmail dot com>
75	Michael Hutchinson (http://compsoc.dur.ac.uk/~mjh/contact)
76	Damien Pitard <dpdev00 at gmail dot com>
77
78	Port to Drupal 5:
79	rötzi (http://drupal.org/user/73064)
80	Stefaan Lippens (http://drupal.org/user/41478)