Code syntax highlighting: Difference between revisions

Latest revision as of 09:44, 14 May 2018

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:

https://moodle.org/plugins/view.php?plugin=filter_geshi

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 under the source of html editor like so:

<span syntax="code" linenumbers="yes">your code with line numbers</span>

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 GeSHi homepage also has an interactive demo.

http://qbnz.com/highlighter/demo.php

Development

The last development for this filter appears to have been in 2017. Bug reports are welcome, please post them in the github issues system.

@@ Line 5: / Line 5: @@
 You can download the GeSHi filter from here:
-http://geshi.org/downloads/moodle-geshi-filter-0.1.0.zip
+https://moodle.org/plugins/view.php?plugin=filter_geshi
 To install, unzip that archive into your filter/ directory and then enable it in the admin filter configuration screen.
@@ Line 11: / Line 11: @@
 == Instructions for use ==
-Enclose your code in spans like so:
+Enclose your code in spans under the source of html editor like so:
- <nowiki>[code lang]your code goes here [/code]
+<nowiki><span syntax="code">your code goes here</span></nowiki>
-[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]
+<nowiki><span syntax="code" linenumbers="yes">your code with line numbers</span></nowiki>
-[code lang linenumbers start=4]start the line numbers at "4" [/code]</nowiki>
 === Supported languages ===
@@ Line 26: / Line 25: @@
 * lisp
 * matlab
-* [[HTML]]
+* [[HTML in Moodle]]
 * [[PHP]]
 * pascal
@@ Line 39: / Line 38: @@
 == 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 <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].
+The last development for this filter appears to have been in 2017. Bug reports are welcome, please post them in the [https://github.com/enovation/moodle-filter_geshi/issues github issues system].
 == See also ==
-* [http://moodle.org/mod/forum/discuss.php?d=25413 Forum post introducing the Filter]
-* [http://moodle.org/mod/forum/discuss.php?d=43266 Forum thread for progress reports and feedback]
 * [http://qbnz.com/highlighter/ GeSHi homepage]
+* [[MoodleDocs:Style_guide#PHP_syntax_highlighting]] that does not need any additional filter
 [[Category:Administrator]]
 [[Category:Filter]]
+[[es:Resaltado de sintaxis de codigo]]

Documentation