The hscolour package

[Tags: gpl, library, program]

hscolour is a small Haskell script to colourise Haskell code. It currently has four output formats: ANSI terminal codes, HTML 3.2 with font tags, HTML 4.01 with CSS, and LaTeX.


[Skip to ReadMe]

Properties

Versions1.6, 1.9, 1.10, 1.10.1, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19, 1.20, 1.20.1, 1.20.2, 1.20.3, 1.21, 1.22, 1.23
Change logNone available
Dependenciesbase (<4.4), haskell98 [details]
LicenseGPL
CopyrightMalcolm Wallace, University of York, 2003-2007, Bjorn Bringert 2006
AuthorMalcolm Wallace
MaintainerMalcolm Wallace
Home pagehttp://www.cs.york.ac.uk/fp/darcs/hscolour/
ExecutablesHsColour
UploadedTue Jan 8 13:58:31 UTC 2008 by MalcolmWallace
UpdatedFri Jan 2 22:37:08 UTC 2015 by HerbertValerioRiedel to revision 1
DistributionsDebian:1.22, Fedora:1.20.3, FreeBSD:1.20.3, LTSHaskell:1.22, NixOS:1.23, Stackage:1.23
Downloads63992 total (889 in last 30 days)
Votes
0 []
StatusDocs uploaded by user
Build status unknown [no reports yet]

Modules

[Index]

Downloads

Maintainers' corner

For package maintainers and hackage trustees

Readme for hscolour-1.9

HsColour: A Haskell source-code colouriser.
-------------------------------------------
Copyright:  2003-2007, Malcolm Wallace, University of York
Licence:    GPL

Building:
    hmake HsColour
or
    ghc --make HsColour

Usage:
    HsColour [-Ofile]
             [ -tty | -html | -css | -latex | -mirc ]
             [ -lit   | -anchor  | -partial ]
             [ -nolit | -noanchor| -nopartial ]
             [file.hs]

The program can colourise a Haskell source file for either terminal
output (option -tty), or HTML 3.2 output with font tags (option -html),
or HTML 4.01 output with CSS (option -css), or LaTeX output (option
-latex), or IRC chat client (option -mirc).  The default is for terminal
output, which uses standard ANSI screen codes for the colours.

If no file argument is given, it reads standard input.  Output is
written to the file specified by the -O option, or by default, stdout.

HsColour can add named anchors in HTML or CSS (option -anchor) to
top-level definitions in the source file (functions, datatypes,
classes).  This enables you to make links to a specific location in the
generated file with the standard "file.html#anchor" notation.

If you want to embed several individually colourised fragments into a
larger document, then use the <tt>-partial</tt> option , to omit the
HTML DOCTYPE header, CSS stylesheet link, or LaTeX prologue.

Alternatively, if you have a literate input source (e.g. .lhs file),
then the -lit option passes the literate parts untouched, and
colourises only the code fragments (indicated by Bird-tracks - a
> symbol in the left-most column), as if each was called individually
with -partial.

You can configure the colours for different lexical entities by
editing a configuration file called .hscolour in the current directory.
(An example is included in the distribution.)  The file format is as
a simple Haskell value of type ColourPrefs, constructed using named
fields, as follows:

  data ColourPrefs = ColourPrefs
    { keyword, keyglyph, layout, comment
    , conid, varid, conop, varop
    , string, char, number, cpp
    , selection, variantselection :: [Highlight]
    }

  data Colour = Black | Red | Green | Yellow | Blue | Magenta | Cyan | White

  data Highlight =
      Normal
    | Bold
    | Dim
    | Underscore
    | Blink
    | ReverseVideo
    | Concealed
    | Foreground Colour
    | Background Colour

For CSS output, it is sufficient to edit the hscolour.css file, also in
the distribution.