(no commit message)
authorhttps://www.google.com/accounts/o8/id?id=AItOawnSY7iTjlvDWPRSPuhOy4h8YLi8_u2qomQ <Richard@web>
Sat, 19 Oct 2013 04:09:13 +0000 (00:09 -0400)
committeradmin <admin@branchable.com>
Sat, 19 Oct 2013 04:09:13 +0000 (00:09 -0400)
doc/plugins/contrib/irclog.mdwn [new file with mode: 0644]

diff --git a/doc/plugins/contrib/irclog.mdwn b/doc/plugins/contrib/irclog.mdwn
new file mode 100644 (file)
index 0000000..634f010
--- /dev/null
@@ -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).