Mercurial > irccd
annotate plugins/history/history.md @ 31:50b7b5d287e8
Plugin history:
- Use file paramater (like hangman),
- Update documentation.
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Mon, 22 Feb 2016 13:25:31 +0100 |
| parents | 8384df86e195 |
| children | aa205621d7d6 |
| rev | line source |
|---|---|
| 0 | 1 --- |
| 2 title: "History plugin" | |
| 3 header: "History plugin" | |
| 4 --- | |
| 5 | |
| 6 The plugin **history** is used to check when someone has been seen for the last time on a channel. For that purpose, | |
| 7 irccd needs to be on that channel forever if possible. | |
| 8 | |
| 9 ## Installation | |
| 10 | |
| 11 The plugin **history** is distributed with irccd. To enable it add the following to your `plugins` section: | |
| 12 | |
| 13 ````ini | |
| 14 [plugins] | |
| 15 history = "" | |
| 16 ```` | |
| 17 | |
| 18 ## Usage | |
| 19 | |
| 20 The plugin **history** only reacts to the special command. It understands `seen` and `said` sub commands. | |
| 21 | |
| 22 - The sub command `seen` tells you when the user has been seen for the last time. | |
| 23 - The sub command `said` tells you what the user has said for the last time. | |
| 24 | |
| 25 Example: | |
| 26 | |
|
20
8384df86e195
Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
27 ````nohighlight |
|
8384df86e195
Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
28 markand: !history seen jean |
|
8384df86e195
Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
29 irccd: markand, the last time I've seen jean was on 18/01/1989 at 20:55 |
|
8384df86e195
Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
30 markand: !history said jean |
|
8384df86e195
Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
31 irccd: markand, the last thing that jean said was: hello world |
|
8384df86e195
Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
32 ```` |
| 0 | 33 |
| 34 ## Configuration | |
| 35 | |
| 36 You can use different formats. | |
| 37 | |
| 38 The following options are available under the `[plugin.history]` section: | |
| 39 | |
| 31 | 40 - **file**: (string) path to the JSON file for saving information (Optional, default to cache directory). |
| 0 | 41 - **format-error**: (string) format when an internal error occured, |
| 42 - **format-seen**: (string) format for showing last seen, | |
| 43 - **format-said**: (string) format for showing the last message, | |
| 44 - **format-unknown**: (string) format when the user has never been seen, | |
| 45 - **format-usage**: (strnig) format to show the plugin usage. | |
| 46 | |
| 31 | 47 <div class="panel panel-warning"> |
| 48 <div class="panel-heading">If you don't want to specify the **file** parameter, irccd will try to use the plugin cache | |
| 49 path, you must create it.</div> | |
| 50 <div class="panel-body"> | |
| 51 ````nohighlight | |
| 52 $ mkdir -p ~/.cache/irccd/plugin/history | |
| 53 ```` | |
| 54 </div> | |
| 55 </div> | |
| 56 | |
| 0 | 57 ### Keywords supported |
| 58 | |
| 59 The following keywords are supported: | |
| 60 | |
| 61 | Format | Keywords | Notes | | |
| 62 |-------------------------|-----------------------------------|---------------------------------| | |
| 63 | (any) | server, channel, nickname, origin | | | |
| 31 | 64 | **file** | server, channel | does not support (any) | |
| 0 | 65 | **format-seen** | target, (date) | target is the specified nick | |
| 66 | **format-said** | target, message, (date) | | | |
| 67 | **format-unknown** | target | | | |
| 68 | |
| 69 Example: | |
| 70 | |
| 31 | 71 <div class="panel panel-info"> |
| 72 <div class="panel-heading">~/.config/irccd/irccd.conf</div> | |
| 73 <div class="panel-body"> | |
| 0 | 74 ````ini |
| 75 [plugin.history] | |
| 76 format-seen = "#{target} has been seen on #{channel} the last time on: %d/%m/%Y %H:%M" | |
| 77 ```` | |
| 31 | 78 </div> |
| 79 </div> |