Mercurial > irccd

comparison plugins/links/links.md @ 705:4b5dba257d81

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
704:13381b9b9215 705:4b5dba257d81
1 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.
3
4 ## Installation
5
6 The plugin **links** is distributed with irccd. To enable it add the following
7 to your `plugins` section:
8
9 ```ini
10 [plugins]
11 links = ""
12 ```
13
14 ## Usage
15
16 The plugin will automatically fetch web page titles on message that contains
17 either *http://something* or *https://something*.
18
19 Example of possible output:
20
21 ```nohighlight
22 markand: http://example.org
23 irccd: Example Domain
24 ```
25
26 ## Configuration
27
28 The following options are available under the `[plugin.links]` section:
29
30 - **timeout**: (int) timeout in seconds before dropping a request (default: 30).
31
32 ## Formats
33
34 The **links** plugin supports the following formats in `[format.links]` section:
35
36 - **info**: message written when title was parsed correctly
37
38 ### Keywords supported
39
40 The following keywords are supported:
41
42 | Format | Keywords | Notes |
43 |--------|-----------------------------------------------------------|-----------------------|
44 | info | channel, nickname, origin, server, title | title is webpage link |