Code syntax highlighting: Difference between revisions
No edit summary |
|||
| (10 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
You can color or highlight code snippets within Moodle resources, forum posts etc. To do so you must install the GeSHi (Generic Syntax Highlighter) Filter. This makes the power of | You can color or highlight code snippets within Moodle resources, forum posts etc. To do so you must install the GeSHi (Generic Syntax Highlighter) Filter. This makes the power of GeSHi available in Moodle through the use of a pair of special tags. | ||
== Installing == | == Installing == | ||
You can download the GeSHi filter from | You can download the GeSHi filter from here: | ||
http://geshi.org/downloads/moodle-geshi-filter-0.1.0.zip | |||
To install, unzip that archive into your filter/ directory and then enable it in the admin filter configuration screen. | |||
== Instructions for use == | == Instructions for use == | ||
| Line 11: | Line 13: | ||
Enclose your code in spans like so: | Enclose your code in spans like so: | ||
<nowiki> | <nowiki>[code lang]your code goes here [/code] | ||
[code lang linenumbers]your code with line numbers [/code] | |||
[code lang highlight=1,2,6-9]your code with lines 1, 2 and 6 | |||
to 9 highlighted "extra" [/code] | |||
[code lang linenumbers start=4]start the line numbers at "4" [/code]</nowiki> | |||
=== Supported languages === | === Supported languages === | ||
| Line 21: | Line 27: | ||
* lisp | * lisp | ||
* matlab | * matlab | ||
* [[HTML]] | * [[HTML in Moodle]] | ||
* [[PHP]] | * [[PHP]] | ||
* pascal | * pascal | ||
* sql | |||
* xml | * xml | ||
and many others. See the GeSHi homepage for full details. | and many others. See the GeSHi homepage for full details. | ||
=== | === Options === | ||
See the examples above. This filter is still under development so things may change. | |||
== Demo == | == Demo == | ||
| Line 50: | Line 48: | ||
http://qbnz.com/highlighter/demo.php | http://qbnz.com/highlighter/demo.php | ||
== History == | |||
This filter used to use <nowiki><span syntax="language">...</span></nowiki> as markers for code. However this changed after conflicts with the HTMLArea editor became apparent. | |||
== Development == | |||
At this time this filter is under development. Suggestions for new features and bug reports are welcome, please post them in the [http://moodle.org/mod/forum/discuss.php?d=43266 discussion thread]. | |||
== See also == | == See also == | ||
[http://moodle.org/mod/forum/discuss.php?d=25413 Forum post introducing the Filter] | * [http://moodle.org/mod/forum/discuss.php?d=25413 Forum post introducing the Filter] | ||
[http://qbnz.com/highlighter/ GeSHi homepage] | * [http://moodle.org/mod/forum/discuss.php?d=43266 Forum thread for progress reports and feedback] | ||
* [http://qbnz.com/highlighter/ GeSHi homepage] | |||
[[Category:Administrator]] | [[Category:Administrator]] | ||
[[Category:Filter]] | [[Category:Filter]] | ||
Latest revision as of 18:57, 10 December 2008
You can color or highlight code snippets within Moodle resources, forum posts etc. To do so you must install the GeSHi (Generic Syntax Highlighter) Filter. This makes the power of GeSHi available in Moodle through the use of a pair of special tags.
Installing
You can download the GeSHi filter from here:
http://geshi.org/downloads/moodle-geshi-filter-0.1.0.zip
To install, unzip that archive into your filter/ directory and then enable it in the admin filter configuration screen.
Instructions for use
Enclose your code in spans like so:
[code lang]your code goes here [/code] [code lang linenumbers]your code with line numbers [/code] [code lang highlight=1,2,6-9]your code with lines 1, 2 and 6 to 9 highlighted "extra" [/code] [code lang linenumbers start=4]start the line numbers at "4" [/code]
Supported languages
- asm,
- bash,
- cpp,
- CSS
- lisp
- matlab
- HTML in Moodle
- PHP
- pascal
- sql
- xml
and many others. See the GeSHi homepage for full details.
Options
See the examples above. This filter is still under development so things may change.
Demo
The filter has recently been installed on Moodle.org and can be seen in use there. For example see this post:
http://moodle.org/mod/forum/discuss.php?d=25413#195644
The GeSHi homepage also has an interactive demo.
http://qbnz.com/highlighter/demo.php
History
This filter used to use <span syntax="language">...</span> as markers for code. However this changed after conflicts with the HTMLArea editor became apparent.
Development
At this time this filter is under development. Suggestions for new features and bug reports are welcome, please post them in the discussion thread.