trac-irclog
===========

An IRC log beautifier for the Trac wiki


Introduction
------------

I thought my lovely IRC snippets contained in a Trac
(http://projects.edgewall.com/trac/) wiki would look a little better with the
usual splash of colour I have seen in various places. What did I have to go
and do?  Write one!

Well, not exactly.  I took irclog2html.py (http://mg.pov.lt/irclog2html/),
written by Marius Gedminas, and modified it for use as a Trac wiki-processor.


Changes from irclog2html.py
---------------------------

I would have used irclog2html.py by simply importing it as a module, but it
didn't quite fit my needs:

  * Replaced class NickColourizer with NickClassifer, assigning style classes
    to nicks instead of inline colours.

  * Added nick-colours.css, an example stylesheet (with colours generated from
    NickColourizer).

  * Removed non-XHTML styles

  * Modified regular expression patterns to also match the peculiar format used
    by an Xchat (http://www.xchat.org/) client I have.


Todo
----

  * Stylesheet generator for nick colours (or revert to inline styles?)


Download
--------

Get the wiki-processor and stylesheets from:

    http://www.mivok.net/~simon/projects/trac/irclog/


Usage
-----

Simply drop irclog.py into your $TRAC_ENV/wiki-macros/ directory.

In your wiki pages, write:

    {{{
    #!irclog

    ... IRC snippets ...

    }}}

To make it look nice, include irclog.css and nick-colours.css in your
$TRAC_ENV/templates/site_css.cs file, for example:

    <?cs
    ##################################################################
    # Site CSS - Place custom CSS, including overriding styles here.
    ?>
    @import url(/style/irclog.css);
    @import url(/style/nick-colours.css);


Authors and Licensing
---------------------

Trac wiki-processor written by Simon Ward <simon@mivok.net>

Based on irclog2html.py, written by Marius Gedminas.

Original irclog2html.pl script written by Jeff Waugh with contributions by
Rick Welykochy and Alexander Else.

irclog.py is released under the terms of the GNU GPL. A copy of the GNU GPL
can be obtained from:

    http://www.gnu.org/copyleft/gpl.html