CanadianJeff / apache-highlight

Simple php script to highlight source code on an apache webserver

apache-highlight

This is a php script that when combined with a simple .htaccess file displays source files with syntax highlighting, and provides a link to view the raw file. Our primary use case has been to dump sample code into a directory for our students to browse and download.

It uses the powerful Ace editor for syntax highlighting.

Usage

• Copy highlight.php to some "central" location, like /scripts/highlight.php on your webserver.
• Make sure that apache has the mod_actions module enabled, and that AllowOverride FileInfo Indexes is set for the directory you will be placing your .htaccess file.
• Place an .htaccess file in the directory you want to highlight files from. See the example below:

.htaccess sample

Options +Indexes
IndexOptions FancyIndexing HTMLTable

# Two options to select what will get highlighted by this:
# 1. Highlight everything in this directory tree
ForceType text/plain
Action text/plain /scripts/highlight.php

# 2. Highlight only certain file extensions
Action highlight-code /scripts/highlight.php
AddHandler highlight-code .py
AddHandler highlight-code .java

Sample Screenshot

Notes/Issues

Q. PATH_TRANSLATED isn't working for me.
A. Please refer to Pull Request #1 for an alternative method which requires a little bit more effort but should work.

Q. I get a 404 error with the message The requested URL /scripts/highlight.php/some/path/myfile.java was not found on this server.
A. This can be caused by not updating the path in the .htaccess file. Double check your Action line and make sure it refers to the correct web-path to your highlight.php script.