Mercurial > irccd
changeset 412:224e5cc2d243
Docs: various fixes
author | David Demelier <markand@malikania.fr> |
---|---|
date | Thu, 26 Jan 2017 14:06:48 +0100 |
parents | 3006d8e96ba8 |
children | 9bc2da03dbe1 faebf6019e70 |
files | doc/html/dev/plugin-javascript-introduction.md doc/html/irccd/configuring.md doc/html/irccdctl/configuring.md plugins/history/history.md |
diffstat | 4 files changed, 28 insertions(+), 25 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/html/dev/plugin-javascript-introduction.md Wed Jan 25 13:43:24 2017 +0100 +++ b/doc/html/dev/plugin-javascript-introduction.md Thu Jan 26 14:06:48 2017 +0100 @@ -79,7 +79,7 @@ Remember, plugins are made through the event driven mechanism, so we must define a function that will be called when a user said something on the channel. The -function defined on channel message is called `onMessage`. +function defined on channel message is called [onMessage][]. It has the following signature: @@ -123,9 +123,6 @@ will be able to create a bunch of plugins that can fits your needs, such as a content provider, a moderator, a calculator and so on. -[server-api]: @baseurl@/api/module/Irccd.Server/index.html -[server-message]: @baseurl@/api/module/Irccd.Server/method/message.html - # Do and do not There are things which should be avoided if possible. @@ -172,3 +169,6 @@ plugin foo: error condition ```` +[onMessage]: @baseurl@/api/event/onMessage.html +[server-api]: @baseurl@/api/module/Irccd.Server/index.html +[server-message]: @baseurl@/api/module/Irccd.Server/Irccd.Server.prototype.message.html
--- a/doc/html/irccd/configuring.md Wed Jan 25 13:43:24 2017 +0100 +++ b/doc/html/irccd/configuring.md Thu Jan 26 14:06:48 2017 +0100 @@ -76,7 +76,7 @@ # The format section -The format section let you change the irccd's output. It uses the [common patterns](#common-patterns-and-formatting). +The format section let you change the irccd's output. It uses the [common patterns][cp]. Only one keyword is defined, `message` which contains the message that irccd wants to output. @@ -112,7 +112,7 @@ - **name**: (id) the identity unique id, - **nickname**: (string) the nickname (Optional, default: irccd), - - **realname**: (string) the realname (Optional, default: IRC Client daemon), + - **realname**: (string) the realname (Optional, default: IRC Client Daemon), - **username**: (string) the username name (Optional, default: irccd), - **ctcp-version**: (string) what version to respond to CTCP VERSION (Optional, default: IRC Client Daemon), - **ctcp-autoreply**: (bool) enable auto CTCP VERSION reply, (Optional, default: true). @@ -193,7 +193,7 @@ With transports, you can may ask `irccd` to send a message, a notice or even kicking someone from a channel. Irccd will also notify all clients connected to this transport on IRC events. -See [irccdctl chapter](#irccdctl) and the [socket chapter](#irccd-socket-api) for more information. +See [irccdctl chapter][irccdctl] and the [socket chapter][sockets] for more information. There are two type of listeners availables: @@ -207,11 +207,11 @@ The options for **ip** type: - - **port**: (int) port number. - - **address**: (string) address to bind or "\*" for any (Optional, default: \*). - - **family**: (list) ipv6, ipv4. Both are accepted (Optional, default: ipv4). - - **ssl**: (bool) enable SSL (Optional, default: false). - - **key**: (string) path to private key file (Optional, default: none). + - **port**: (int) port number, + - **address**: (string) address to bind or "\*" for any (Optional, default: \*), + - **family**: (list) ipv6, ipv4. Both are accepted (Optional, default: ipv4), + - **ssl**: (bool) enable SSL (Optional, default: false), + - **key**: (string) path to private key file (Optional, default: none), - **certificate**: (string) path to certificate (Optional, default: none). The options for **unix** type: @@ -318,8 +318,11 @@ # Load some plugins. [plugins] -ask = "" # This search for plugin ask -myplugin = /path/to/myplugin.js # This use absolute path +ask = "" # Search ask +myplugin = /path/to/myplugin.js # Use absolute path ```` [cfgdir]: @baseurl@/irccd/paths.html +[cp]: @baseurl@/misc/common-patterns-and-formatting.html +[irccdctl]: @baseurl@/irccdctl/index.html +[sockets]: @baseurl@/dev/socket-commands.html
--- a/doc/html/irccdctl/configuring.md Wed Jan 25 13:43:24 2017 +0100 +++ b/doc/html/irccdctl/configuring.md Thu Jan 26 14:06:48 2017 +0100 @@ -40,7 +40,7 @@ The options for **unix** type: - - **path**: (string) Required. The file path to the socket. + - **path**: (string) The file path to the socket. **Example for internet transports**
--- a/plugins/history/history.md Wed Jan 25 13:43:24 2017 +0100 +++ b/plugins/history/history.md Thu Jan 26 14:06:48 2017 +0100 @@ -54,6 +54,16 @@ |-----------|-----------------| | **file** | channel, server | +<div class="panel panel-warning"> + <div class="panel-heading">If you don't want to specify the **file** parameter, irccd will try to use the plugin cache + path, you must create it.</div> + <div class="panel-body"> +````nohighlight +$ mkdir -p ~/.cache/irccd/plugin/history +```` + </div> +</div> + ## Formats The **history** plugin supports the following formats in `[format.history]` section: @@ -64,16 +74,6 @@ - **unknown**: (string) format when the user has never been seen, - **usage**: (string) format to show the plugin usage. -<div class="panel panel-warning"> - <div class="panel-heading">If you don't want to specify the **file** parameter, irccd will try to use the plugin cache - path, you must create it.</div> - <div class="panel-body"> -````nohighlight -$ mkdir -p ~/.cache/irccd/plugin/history -```` - </div> -</div> - ### Keywords supported The following keywords are supported: