comparison plugins/links/links.md @ 817:ebe561276c33

doc: start reworking, continue #752 @8h
author David Demelier <markand@malikania.fr>
date Mon, 19 Nov 2018 07:04:42 +0100
parents 4b5dba257d81
children
comparison
equal deleted inserted replaced
816:42992b30f928 817:ebe561276c33
1 # Links plugin
2
1 The plugin **links** is use to analyze links sent on channels. It will load the 3 The plugin **links** is use to analyze links sent on channels. It will load the
2 web page and extract its title on the same channel. 4 web page and extract its title on the same channel.
3 5
4 ## Installation 6 ## Installation
5 7
25 27
26 ## Configuration 28 ## Configuration
27 29
28 The following options are available under the `[plugin.links]` section: 30 The following options are available under the `[plugin.links]` section:
29 31
30 - **timeout**: (int) timeout in seconds before dropping a request (default: 30). 32 - timeout: (int) timeout in seconds before dropping a request (default: 30).
31 33
32 ## Formats 34 ## Formats
33 35
34 The **links** plugin supports the following formats in `[format.links]` section: 36 The **links** plugin supports the following formats in `[format.links]` section:
35 37
36 - **info**: message written when title was parsed correctly 38 - info: message written when title was parsed correctly
37 39
38 ### Keywords supported 40 ### Keywords supported
39 41
40 The following keywords are supported: 42 The following keywords are supported:
41 43
42 | Format | Keywords | Notes | 44 | Format | Keywords | Notes |
43 |--------|-----------------------------------------------------------|-----------------------| 45 |--------|------------------------------------------|-----------------------|
44 | info | channel, nickname, origin, server, title | title is webpage link | 46 | info | channel, nickname, origin, server, title | title is webpage link |