Mercurial > irccd

annotate plugins/ask/ask.md @ 96:3b24366c7213

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Misc: switch to \ for Doxygen, #480
author David Demelier <markand@malikania.fr>
date Wed, 20 Apr 2016 19:55:25 +0200
parents 9a907e58f978
children 19df514cb61c
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"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5
28
9a907e58f978 Plugin ask: fix errors in documentation
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
6 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
7
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 ## Installation
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 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
11
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 ````ini
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 [plugins]
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 ask = ""
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 ## Usage
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 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
20
28
9a907e58f978 Plugin ask: fix errors in documentation
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
21 ## Example
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22
20
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
23 ````nohighlight
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
24 markand: !ask will I be rich?
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
25 irccd: markand, No.
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
26 ````
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 ## Configuration
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
29
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 By default, **ask** will only answer yes or no. It's possible to add any answers you want in the file **answers.conf**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 located in the ask configuration directory.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 Just add one line per answer like this:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34
28
9a907e58f978 Plugin ask: fix errors in documentation
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
35 <div class="panel panel-info">
9a907e58f978 Plugin ask: fix errors in documentation
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
36 <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
37 <div class="panel-body">
20
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
38 ````nohighlight
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
39 Stop dreaming,
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
40 Definitely sure!
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
41 Maybe
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
42 ````
28
9a907e58f978 Plugin ask: fix errors in documentation
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
43 </div>
9a907e58f978 Plugin ask: fix errors in documentation
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
44 </div>