]> sipb.mit.edu Git - ikiwiki.git/blob - doc/plugins/contrib/irclog.mdwn
(no commit message)
[ikiwiki.git] / doc / plugins / contrib / irclog.mdwn
1 The [irclog](https://github.com/ironchicken/ikiwiki-irclog) plugin allows including a formatted IRC log in your wiki.
2
3 ### Usage
4
5 The `[[!irclog]]` directive takes the following arguments:
6
7 `location` (required)
8
9 The URI of your IRC log file. Currently the URI schemes `file:`, `http:`, and `ssh:` have been implemented. Only `ssh:` has been tested: `ssh://host/path/to/#channel`.
10
11 `earliest` (optional)
12
13 A date/time in the format `%F %T` (i.e. `YYYY-MM-DD HH:MM:SS`). Events before this time will not be included. String comparison is used, so you can omit portions of the date/time if you like, e.g. `YYYY-MM`.
14
15 `latest` (optional)
16
17 A date/time. Events after this time will not be included.
18
19 `keywords` (optional)
20
21 A mapping of keywords to translations, formatted like a Perl hash, e.g.: "richard=>\[[richard]\]". In this case occurrences of "richard" will be replaced with "\[[richard]\]" (which will later be processed as a WikiLink).