diff options
| author | https://www.google.com/accounts/o8/id?id=AItOawnSY7iTjlvDWPRSPuhOy4h8YLi8_u2qomQ <Richard@web> | 2013-10-19 00:09:13 -0400 |
|---|---|---|
| committer | admin <admin@branchable.com> | 2013-10-19 00:09:13 -0400 |
| commit | 80ec92dec4397f7dafd3a9a4a565448e33f0ce7b (patch) | |
| tree | cf101c0967b9a604ac2a25916c4af3b0ca6703c5 | |
| parent | 3ccdc9d447e21d6b634d425e7e0161670aaafda9 (diff) | |
| download | ikiwiki-80ec92dec4397f7dafd3a9a4a565448e33f0ce7b.tar ikiwiki-80ec92dec4397f7dafd3a9a4a565448e33f0ce7b.tar.gz | |
| -rw-r--r-- | doc/plugins/contrib/irclog.mdwn | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/plugins/contrib/irclog.mdwn b/doc/plugins/contrib/irclog.mdwn new file mode 100644 index 000000000..634f010c9 --- /dev/null +++ b/doc/plugins/contrib/irclog.mdwn @@ -0,0 +1,21 @@ +The [irclog](https://github.com/ironchicken/ikiwiki-irclog) plugin allows including a formatted IRC log in your wiki. + +### Usage + +The `[[!irclog]]` directive takes the following arguments: + +`location` (required) + +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`. + +`earliest` (optional) + +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`. + +`latest` (optional) + +A date/time. Events after this time will not be included. + +`keywords` (optional) + +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). |