| 1 | trac-irclog |
|---|
| 2 | =========== |
|---|
| 3 | |
|---|
| 4 | An IRC log beautifier for the Trac wiki |
|---|
| 5 | |
|---|
| 6 | |
|---|
| 7 | Introduction |
|---|
| 8 | ------------ |
|---|
| 9 | |
|---|
| 10 | I thought my lovely IRC snippets contained in a Trac |
|---|
| 11 | (http://projects.edgewall.com/trac/) wiki would look a little better with the |
|---|
| 12 | usual splash of colour I have seen in various places. What did I have to go |
|---|
| 13 | and do? Write one! |
|---|
| 14 | |
|---|
| 15 | Well, not exactly. I took irclog2html.py (http://mg.pov.lt/irclog2html/), |
|---|
| 16 | written by Marius Gedminas, and modified it for use as a Trac wiki-processor. |
|---|
| 17 | |
|---|
| 18 | |
|---|
| 19 | Changes from irclog2html.py |
|---|
| 20 | --------------------------- |
|---|
| 21 | |
|---|
| 22 | I would have used irclog2html.py by simply importing it as a module, but it |
|---|
| 23 | didn't quite fit my needs: |
|---|
| 24 | |
|---|
| 25 | * Replaced class NickColourizer with NickClassifer, assigning style classes |
|---|
| 26 | to nicks instead of inline colours. |
|---|
| 27 | |
|---|
| 28 | * Added nick-colours.css, an example stylesheet (with colours generated from |
|---|
| 29 | NickColourizer). |
|---|
| 30 | |
|---|
| 31 | * Removed non-XHTML styles |
|---|
| 32 | |
|---|
| 33 | * Modified regular expression patterns to also match the peculiar format used |
|---|
| 34 | by an Xchat (http://www.xchat.org/) client I have. |
|---|
| 35 | |
|---|
| 36 | |
|---|
| 37 | Todo |
|---|
| 38 | ---- |
|---|
| 39 | |
|---|
| 40 | * Stylesheet generator for nick colours (or revert to inline styles?) |
|---|
| 41 | |
|---|
| 42 | |
|---|
| 43 | Download |
|---|
| 44 | -------- |
|---|
| 45 | |
|---|
| 46 | Get the wiki-processor and stylesheets from: |
|---|
| 47 | |
|---|
| 48 | http://www.mivok.net/~simon/projects/trac/irclog/ |
|---|
| 49 | |
|---|
| 50 | |
|---|
| 51 | Usage |
|---|
| 52 | ----- |
|---|
| 53 | |
|---|
| 54 | Simply drop irclog.py into your $TRAC_ENV/wiki-macros/ directory. |
|---|
| 55 | |
|---|
| 56 | In your wiki pages, write: |
|---|
| 57 | |
|---|
| 58 | {{{ |
|---|
| 59 | #!irclog |
|---|
| 60 | |
|---|
| 61 | ... IRC snippets ... |
|---|
| 62 | |
|---|
| 63 | }}} |
|---|
| 64 | |
|---|
| 65 | To make it look nice, include irclog.css and nick-colours.css in your |
|---|
| 66 | $TRAC_ENV/templates/site_css.cs file, for example: |
|---|
| 67 | |
|---|
| 68 | <?cs |
|---|
| 69 | ################################################################## |
|---|
| 70 | # Site CSS - Place custom CSS, including overriding styles here. |
|---|
| 71 | ?> |
|---|
| 72 | @import url(/style/irclog.css); |
|---|
| 73 | @import url(/style/nick-colours.css); |
|---|
| 74 | |
|---|
| 75 | |
|---|
| 76 | Authors and Licensing |
|---|
| 77 | --------------------- |
|---|
| 78 | |
|---|
| 79 | Trac wiki-processor written by Simon Ward <simon@mivok.net> |
|---|
| 80 | |
|---|
| 81 | Based on irclog2html.py, written by Marius Gedminas. |
|---|
| 82 | |
|---|
| 83 | Original irclog2html.pl script written by Jeff Waugh with contributions by |
|---|
| 84 | Rick Welykochy and Alexander Else. |
|---|
| 85 | |
|---|
| 86 | irclog.py is released under the terms of the GNU GPL. A copy of the GNU GPL |
|---|
| 87 | can be obtained from: |
|---|
| 88 | |
|---|
| 89 | http://www.gnu.org/copyleft/gpl.html |
|---|
