Moodle in English: PHP syntax highlight filter

Dear developers!

I have written simple php syntax highlight filter, using built-in php function highlight_string(). The filter is useful for PHP language teaching.

The filter highlights php code, embraced by <?php and ?>
The example of highlighted code is:


<?php
    if(isset($_GET["a"]) && isset($_GET["a"])) {
     echo intval($_GET["a"]) + intval($_GET["b"]);
}
else {
     echo "Error";
}
?>

You can download filter from:
http://onlineuniversity.ru/filter/php_filter.zip

For my purpose I need also HTML and SQL syntax highlighter. For this and for many other programming languages I have an idea to embed GeSHi
Then it is possible to create filter interpreting 

If you are interested, please write your opinion

Average of ratings: -

Re: PHP syntax highlight filter

by Grigory Rubtsov - Saturday, 18 June 2005, 4:29 AM

I finally embedded GeSHi in a simple way.
You can download test version of a filter from:
http://onlineuniversity.ru/filter/geshi_filter.zip

To Use it:
- Enclose your code in 
- It can highlight c,asm,bash,cpp,css,lisp,matlab,html4strict,php,pascal,xml and many other languages

This filter is helpful for programming languages teaching.

Average of ratings: -

Re: PHP syntax highlight filter

by Darren Smith - Tuesday, 21 June 2005, 6:55 PM

Superb. thank you very much approve

Average of ratings: -

Re: PHP syntax highlight filter

by David Scotson - Tuesday, 21 June 2005, 9:42 PM

That's very nice.

Is there an option to use the more CSS enabled version that uses classes rather than embedded styles. I think I prefer geshi's numbered list option (using CSS to hide the numbers if you wish) rather than large numbers of br tags, though it appears that my copy of Firefox also cut and pastes the numbers, even though the Geshi docs claim this shouldn't happen.

The blocks, modules and various other parts of Moodle have their own CSS in Moodle 1.5 that can then be overriden by users, is it possible for filters to do the same? It would really cut down the page size (50% less code acording to the geshi docs) when using this filter as well as making it easier to choose your own color scheme to fit with your favourite editor or Moodle theme.

I'd vote for including this on Moodle.org once it's done.

Average of ratings: -

Re: PHP syntax highlight filter

by Martin Dougiamas - Tuesday, 21 June 2005, 9:46 PM

Filters can't (yet) unfortunately, but I will certainly add this to moodle.org once it's a bit more tested - great stuff Grigory!

Average of ratings: -

Re: PHP syntax highlight filter

by Julian Ridden - Wednesday, 22 June 2005, 6:09 AM

This is great work. I am sure it will see good use in our senior computer classes.

Average of ratings: -

An update

by Grigory Rubtsov - Sunday, 26 June 2005, 10:09 PM

I have updated geshi filter.
http://onlineuniversity.ru/filter/geshi_filter.zip

1. I have utilized line numbers feature of geshi. Now if you put underscore before language name it make lines numbered. For example use for html syntax with line numbers

2. There is a way of customizing colors (but not supporting some advanced features yet)
- Open /filter/geshi/geshi/contrib/cssgen.php with a web browser
- Select languages and colors you wish and generate stylesheet
- Save stylesheet in you theme directory as geshi.css
- In theme config.php add 'geshi' element to $THEME->sheets array
- In the beginning of filter.php set $CFG->geshifilterexternalcss=true;

Stylesheet for all supported languages in less than 8 kb.

Average of ratings: -

Re: An update

by Manel Lopez - Tuesday, 30 August 2005, 4:01 AM

Hi Grigory

cssgen.php don't works properly

I think it's right in this new file

Best regards

cssgen.php

Average of ratings: -

Re: An update

by Manel Lopez - Tuesday, 30 August 2005, 8:58 AM

Hi again

Sorry but i'm wrong. This file don't works

i get some errors when i unselect all and i get another errors when i select something but css is generated.

Best regards

Average of ratings: -

Re: An update on the Geshi filter

by Wouter De Backer - Friday, 9 December 2005, 6:14 AM

Yours is a great initiative! Why is your filter not directly available for download from the Moodle.org Download section?

Average of ratings: -

Re: An update on the Geshi filter

by Grigory Rubtsov - Saturday, 10 December 2005, 3:53 AM

Thank you! I just don't know how to add to download section.

Average of ratings: -

Re: An update on the Geshi filter

by Wouter De Backer - Saturday, 10 December 2005, 6:48 AM

Could it be that this has to be done manually by the Big Boss? wink

Average of ratings: -

Re: PHP syntax highlight filter

by Nigel McNie - Tuesday, 13 December 2005, 7:14 AM

Hi everyone

I'm the GeSHi developer, working at Catalyst. I've just created a new version of this filter that gives a few improvements:

Upgraded GeSHi to 1.0.7.5, and fixed security hole in old filter because of old GeSHi version
Added support for extra attributes in the tag, such as "linenumbers" and "urls". For example:
Fixed bug where empty source caused invalid output ( was left in output)
Fixed up styles when line numbers are enabled (the size should be more like non-line numbers now, although this is at your browser's option)
Included script that generates a full stylesheet for GeSHi, with instructions on how to include it in your theme, so you can use Moodle's stylesheet caching and GeSHi's class output to have much less source output and save you bandwidth.

My thanks to Grigory for his work on the filter, it gave me a good base to start with. Thanks also to the Catalyst team who put up with my silly questions

If anyone has any suggestions/bugs, please tell me!

[EDIT: filter attached to this post, but you can download from http://geshi.org/downloads/geshi.zip as well]

NOTE: this was developed against HEAD, although I don't think much has changed from 1.5 to HEAD that will affect this filter, my experience with Moodle totals one day :p. If you successfully install it in 1.5, please tell me

NOTE2: Even if you've installed this before, please read the README.txt again, there are new instructions.

geshi.zip

Average of ratings: -

Re: PHP syntax highlight filter

by Grigory Rubtsov - Wednesday, 14 December 2005, 4:29 AM

Dear Nigel!

Thank you for what you have done for opensource and moodle communities.

If one is using moodle WYSISYG editor it often changes places of attributes.

So it often occasionally change from:

to:


Therefore, we need also to account for the possibility that additional attributes are placed before syntaxt="".

Looking forward for new versions of GeSHi and filter.

Average of ratings: -

Re: PHP syntax highlight filter

by Nigel McNie - Wednesday, 14 December 2005, 6:28 AM

Thanks for pointing that out, I wondered why I could not get things working very well in the WYSIWYG text area.

I have uploaded a new version that takes this into account, as well as providing for some configuration inside the filter.php file (so you could set line numbers to be on by default for all code for example). Download is the same as in the other post, and it's attached to this post.

geshi.zip

Average of ratings: -

Re: PHP syntax highlight filter

by Grigory Rubtsov - Thursday, 15 December 2005, 3:31 AM

Thank you for BC with the original plugin. To parse non-geshi tags correctly we need to check for empty syntax parameter.

--- filter-orig.php Wed Dec 14 21:59:23 2005
+++ filter.php Wed Dec 14 22:17:59 2005
@@ -93,7 +93,8 @@
//echo 'options as set:';
//geshi_dbg($options);
+ if($options['syntax']=='')
+ return $data[0];
// BC for original plugin
if ('_' == $options['syntax'][0]) {
$options['linenumbers'] = true;

I also wish to suggest a feature. We often want to highlight code inline, e.g. short SQL statements. GeSHi supports only <pre> and <div> variants and both are blocks. It will be great if we will be able to use option (for example, if using filter with parameter inline="yes").

Average of ratings: -

Re: PHP syntax highlight filter

by Nigel McNie - Thursday, 15 December 2005, 4:58 AM

I have added your patch, but also added to it so that it checks: if the syntax attribute is set but empty then put the contents in a <pre>. If it's not set of course, return it as is.

I have also added support for inline highlighting, using inline="yes".

Download from this post's attachment or the link as normal.

geshi.zip

Average of ratings: -

Re: PHP syntax highlight filter

by Nigel McNie - Thursday, 9 February 2006, 8:13 AM

Again, a new version is available. All I have done is upgraded the included GeSHi to 1.0.7.6.

File attached to this post, or available at the link in the parent.

geshi.zip

Average of ratings: -

Re: PHP syntax highlight filter

by Nigel McNie - Tuesday, 28 March 2006, 1:13 PM

New version again: GeSHi upgraded to 1.0.7.8

geshi.zip

Average of ratings: -

Re: PHP syntax highlight filter

by Martin Dougiamas - Tuesday, 28 March 2006, 1:46 PM

I've installed it on moodle.org

/**
* Given a set of timezone records, put them in the database, replacing what is there
*
* @uses $CFG
* @param array $timezones An array of timezone records
*/
function update_timezone_records($timezones) {
/// Given a set of timezone records, put them in the database

global $CFG;

/// Clear out all the old stuff
execute_sql('TRUNCATE TABLE '.$CFG->prefix.'timezone', false);

/// Insert all the new stuff
foreach ($timezones as $timezone) {
insert_record('timezone', $timezone);
}
}

Average of ratings: -

Re: PHP syntax highlight filter

by Nigel McNie - Wednesday, 29 March 2006, 11:21 AM

Cool!

SELECT testing FROM moodle_geshi_filter WHERE installed = 1

Average of ratings: -

Re: PHP syntax highlight filter

by Martin Dougiamas - Wednesday, 29 March 2006, 1:01 PM

Thanks for the code, Nigel, nice job!

When I fix the modules Database, you should put it in there.

Average of ratings: -

Re: PHP syntax highlight filter

by Nigel McNie - Thursday, 30 March 2006, 6:09 AM

I added it now.

It seems that the WYSIWYG editor plays merry hell with the code though, especially when you edit the post - it seems to be stripping a large part of the whitespace. Nasty...

I will have to look into it some time. I still need to dig through some moodle code first to see how it works though!

Average of ratings: -

Re: PHP syntax highlight filter

by Nicolas Sicard - Friday, 26 January 2007, 10:46 PM

Hi !

This filter could be very useful for me, but I can't find how to make it work properly with the WYSIWYG editor. Can you help me ?

thanks

nicolas.

Average of ratings: -

Re: PHP syntax highlight filter

by Sandy Pittendrigh - Saturday, 11 October 2008, 11:41 PM

I installed and activated the filter and used the span tag as you specified.
My code is highlighted, but indenting is still stripped out.
This is why I wanted a filter in the first place (if condition with
action on next line does not honor the indent).

I fiddled with filter.php a bit.
Still not getting anywhere.
I'll keep trying.

Average of ratings: -

Re: PHP syntax highlight filter

by Andrew McMillan - Friday, 9 December 2005, 8:50 AM

That's great, Grigory!

GeSHi is actually written by one of the guys here at Catalyst (he just started working for us) and we'd been thinking of doing something like this already so we'll be happy to help with any questions.

Regards,
Andrew McMillan

Average of ratings: -

Re: PHP syntax highlight filter

by Grigory Rubtsov - Saturday, 10 December 2005, 3:58 AM

Thank you, Andrew.

In the future I wish to upgrage filter to GeSHi 1.2 as it looks much more robust (according to demo on website), but I don't know when it is best time to switch.

Best wishes,
Grigory Rubtsov.

Average of ratings: -

Re: PHP syntax highlight filter: options

by Wouter De Backer - Saturday, 10 December 2005, 7:06 AM

Is there a way to change some options of this filter in the admin interface? I'd like to:

turn off the effect that every html tag also becomes a link to the december.com site.
turn off the specific font selection when line numbers are shown and default to the browser's choice as is the case with the non-numbered representation of a piece of code.
to influence the amount of indentation

Average of ratings: -

Re: PHP syntax highlight filter: options

by Grigory Rubtsov - Saturday, 10 December 2005, 9:38 PM

I also have encountered some of bugs you mentioned. These are internal features of geshi. Of course some of bugs can be fixed by hacking inside geshi code, but I think filter should be transfered to upcoming geshi 1.2 which is announced to have more transparent interface.

Average of ratings: -