Mercurial > irccd

annotate plugins/ask/ask.md @ 669:6eb4caea77a5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Tests: split libirccd util tests into libcommon, closes #789 @1h While here, remove unneeded and deprecated functions from string_util and adapt existing code to new functions.
author David Demelier <markand@malikania.fr>
date Fri, 06 Apr 2018 22:06:07 +0200
parents c143682678b9
children ebe561276c33
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 title: "Ask plugin"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 header: "Ask plugin"
275
c143682678b9 CMake: improve documentation related to plugins
David Demelier <markand@malikania.fr>
parents: 149
diff changeset
4 guide: yes
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6
28
9a907e58f978 Plugin ask: fix errors in documentation
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
7 The plugin **ask** is funny script that helps you in your life. It will tells you if you will be rich, famous and so on.
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 ## Installation
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 The plugin **ask** is distributed with irccd. To enable it add the following to your `plugins` section:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 ````ini
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 [plugins]
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 ask = ""
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 ## Usage
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 The plugin **ask** reacts to special command, you just need to do `!ask the question` and it will give you a response.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
28
9a907e58f978 Plugin ask: fix errors in documentation
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
22 ## Example
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
20
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
24 ````nohighlight
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
25 markand: !ask will I be rich?
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
26 irccd: markand, No.
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
27 ````
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
149
19df514cb61c Plugin ask: add optional file parameter, #504
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
29 ## File
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
30
149
19df514cb61c Plugin ask: add optional file parameter, #504
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
31 By default, **ask** will only answer yes or no. It's possible to add any answers you want in the file **answers.conf** located in the ask
19df514cb61c Plugin ask: add optional file parameter, #504
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
32 configuration directory.
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 Just add one line per answer like this:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
35
28
9a907e58f978 Plugin ask: fix errors in documentation
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
36 <div class="panel panel-info">
9a907e58f978 Plugin ask: fix errors in documentation
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
37 <div class="panel-heading">~/.config/irccd/plugin/ask/answers.conf</div>
9a907e58f978 Plugin ask: fix errors in documentation
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
38 <div class="panel-body">
20
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
39 ````nohighlight
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
40 Stop dreaming,
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
41 Definitely sure!
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
42 Maybe
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
43 ````
28
9a907e58f978 Plugin ask: fix errors in documentation
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
44 </div>
9a907e58f978 Plugin ask: fix errors in documentation
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
45 </div>
149
19df514cb61c Plugin ask: add optional file parameter, #504
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
46
19df514cb61c Plugin ask: add optional file parameter, #504
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
47 ## Configuration
19df514cb61c Plugin ask: add optional file parameter, #504
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
48
19df514cb61c Plugin ask: add optional file parameter, #504
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
49 The following options are available under the `[plugin.ask]` section:
19df514cb61c Plugin ask: add optional file parameter, #504
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
50
19df514cb61c Plugin ask: add optional file parameter, #504
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
51 - **file**: (string) the path to the database file (Optional, default: **answers.conf** in configuration directory).