Mercurial > irccd
annotate plugins/links/links.md @ 705:4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
author | David Demelier <markand@malikania.fr> |
---|---|
date | Fri, 06 Jul 2018 22:10:10 +0200 |
parents | |
children | ebe561276c33 |
rev | line source |
---|---|
705
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
1 The plugin **links** is use to analyze links sent on channels. It will load the |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
2 web page and extract its title on the same channel. |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
3 |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
4 ## Installation |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
5 |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
6 The plugin **links** is distributed with irccd. To enable it add the following |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
7 to your `plugins` section: |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
8 |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
9 ```ini |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
10 [plugins] |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
11 links = "" |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
12 ``` |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
13 |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
14 ## Usage |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
15 |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
16 The plugin will automatically fetch web page titles on message that contains |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
17 either *http://something* or *https://something*. |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
18 |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
19 Example of possible output: |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
20 |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
21 ```nohighlight |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
22 markand: http://example.org |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
23 irccd: Example Domain |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
24 ``` |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
25 |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
26 ## Configuration |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
27 |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
28 The following options are available under the `[plugin.links]` section: |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
29 |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
30 - **timeout**: (int) timeout in seconds before dropping a request (default: 30). |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
31 |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
32 ## Formats |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
33 |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
34 The **links** plugin supports the following formats in `[format.links]` section: |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
35 |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
36 - **info**: message written when title was parsed correctly |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
37 |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
38 ### Keywords supported |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
39 |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
40 The following keywords are supported: |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
41 |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
42 | Format | Keywords | Notes | |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
43 |--------|-----------------------------------------------------------|-----------------------| |
4b5dba257d81
Plugin links: brand new plugin, closes #872 @4h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
44 | info | channel, nickname, origin, server, title | title is webpage link | |