Mercurial > irccd
annotate plugins/history/history.md @ 197:1b3365343b18
Irccd: fix default amount in Irccd.File.read to -1 and add test
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Wed, 08 Jun 2016 12:37:55 +0200 |
| parents | 620ff1b794fd |
| children | c143682678b9 |
| 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 The following options are available under the `[plugin.history]` section: | |
| 37 | |
| 31 | 38 - **file**: (string) path to the JSON file for saving information (Optional, default to cache directory). |
|
143
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
39 |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
40 **Deprecated in irccd 2.1.0:** |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
41 |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
42 - **format-error**: Use `[format.history] error` instead, |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
43 - **format-seen**: Use `[format.history] seen` instead, |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
44 - **format-said**: Use `[format.history] said` instead, |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
45 - **format-unknown**: Use `[format.history] unknown` instead, |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
46 - **format-usage**: Use `[format.history] usage` instead. |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
47 |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
48 ### Keywords supported |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
49 |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
50 The following keywords are supported: |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
51 |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
52 | Parameter | Keywords | |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
53 |-----------|-----------------| |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
54 | **file** | channel, server | |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
55 |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
56 ## Formats |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
57 |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
58 The **history** plugin supports the following formats in `[format.history]` section: |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
59 |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
60 - **error**: (string) format when an internal error occured, |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
61 - **seen**: (string) format for showing last seen, |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
62 - **said**: (string) format for showing the last message, |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
63 - **unknown**: (string) format when the user has never been seen, |
|
156
620ff1b794fd
Plugin history: fix typo
David Demelier <markand@malikania.fr>
parents:
143
diff
changeset
|
64 - **usage**: (string) format to show the plugin usage. |
| 0 | 65 |
| 31 | 66 <div class="panel panel-warning"> |
| 67 <div class="panel-heading">If you don't want to specify the **file** parameter, irccd will try to use the plugin cache | |
| 68 path, you must create it.</div> | |
| 69 <div class="panel-body"> | |
| 70 ````nohighlight | |
| 71 $ mkdir -p ~/.cache/irccd/plugin/history | |
| 72 ```` | |
| 73 </div> | |
| 74 </div> | |
| 75 | |
| 0 | 76 ### Keywords supported |
| 77 | |
| 78 The following keywords are supported: | |
| 79 | |
|
143
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
80 | Format | Keywords | Notes | |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
81 |-------------|----------------------------------------------------|------------------------------| |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
82 | (any) | channel, command, nickname, origin, plugin, server | | |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
83 | **seen** | target, (date) | target is the specified nick | |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
84 | **said** | message, target, (date) | | |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
85 | **unknown** | target | | |
| 0 | 86 |
| 87 Example: | |
| 88 | |
| 31 | 89 <div class="panel panel-info"> |
| 90 <div class="panel-heading">~/.config/irccd/irccd.conf</div> | |
| 91 <div class="panel-body"> | |
| 0 | 92 ````ini |
|
143
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
93 [format.history] |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
94 seen = "#{target} has been seen on #{channel} the last time on: %d/%m/%Y %H:%M" |
| 0 | 95 ```` |
| 31 | 96 </div> |
| 97 </div> |