Mercurial > irccd

changeset 370:a60142be369a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Docs: improve headers
author David Demelier <markand@malikania.fr>
date Tue, 06 Dec 2016 19:32:48 +0100
parents 5aca8eeebcf1
children c6fb00344c19
files doc/html/build/build-from-sources.md doc/html/build/build-options.md doc/html/dev/plugin-javascript-introduction.md doc/html/dev/socket-commands.md doc/html/dev/socket-protocol.md doc/html/index.md doc/html/irccd/configuring.md doc/html/irccd/paths.md doc/html/irccdctl/configuring.md doc/html/irccdctl/usage.md doc/html/misc/common-patterns-and-formatting.md doc/html/misc/configuration-syntax.md
diffstat 12 files changed, 72 insertions(+), 80 deletions(-) [+]
line wrap: on
line diff
--- a/doc/html/build/build-from-sources.md	Tue Dec 06 13:17:27 2016 +0100
+++ b/doc/html/build/build-from-sources.md	Tue Dec 06 19:32:48 2016 +0100
@@ -1,5 +1,5 @@
 ---
-title: Building from sources
+header: Building from sources
 guide: yes
 ---
 
--- a/doc/html/build/build-options.md	Tue Dec 06 13:17:27 2016 +0100
+++ b/doc/html/build/build-options.md	Tue Dec 06 19:32:48 2016 +0100
@@ -1,5 +1,5 @@
 ---
-title: Build options
+header: Build options
 guide: yes
 ---
 
--- a/doc/html/dev/plugin-javascript-introduction.md	Tue Dec 06 13:17:27 2016 +0100
+++ b/doc/html/dev/plugin-javascript-introduction.md	Tue Dec 06 19:32:48 2016 +0100
@@ -1,5 +1,5 @@
 ---
-title: JavaScript plugin introduction
+header: JavaScript plugin introduction
 guide: yes
 ---
 
--- a/doc/html/dev/socket-commands.md	Tue Dec 06 13:17:27 2016 +0100
+++ b/doc/html/dev/socket-commands.md	Tue Dec 06 19:32:48 2016 +0100
@@ -1,25 +1,25 @@
 ---
-title: Irccd socket API
+header: Irccd socket API
 guide: true
 ---
 
-## Commands
+# Commands
 
 The following commands are available. Please note that a lot of commands require a server as the first argument, it’s
 one of defined in the **irccd.conf** file in the server section.
 
-### server-cnotice
+## server-cnotice
 
 Send a message notice on a channel.
 
-#### Properties
+## Properties
 
   - **command**: (string) "server-cnotice",
   - **server**: (string) the server unique id,
   - **channel**: (string) the channel name,
   - **message**: (string) the notice message.
 
-#### Example
+## Example
 
 ````json
 {
@@ -30,11 +30,11 @@
 }
 ````
 
-### server-connect
+## server-connect
 
 Connect to a server.
 
-#### Properties
+## Properties
 
   - **command**: (string) "server-connect",
   - **name**: (string) the server unique id,
@@ -50,7 +50,7 @@
   - **reconnectTries**: (int) the number of reconnection to try (Optional, default: -1),
   - **reconnectTimeout**: (int) the number of seconds to wait before retrying to connect (Optional, default: 30).
 
-#### Example
+## Example
 
 ````json
 {
@@ -61,18 +61,18 @@
 }
 ````
 
-### server-disconnect
+## server-disconnect
 
 Disconnect from a server.
 
 If server is not specified, irccd disconnects all servers.
 
-#### Properties
+## Properties
 
   - **command**: (string) "server-disconnect",
   - **server**: (string) the server unique id (Optional, default: none).
 
-#### Example
+## Example
 
 ````json
 {
@@ -81,16 +81,16 @@
 }
 ````
 
-### server-info
+## server-info
 
 Get server information.
 
-#### Properties
+## Properties
 
   - **command**: (string) "server-info",
   - **server**: (string) the server unique id.
 
-#### Example
+## Example
 
 ````json
 {
@@ -99,7 +99,7 @@
 }
 ````
 
-#### Responses
+## Responses
 
   - **name**: (string) the server unique id,
   - **host**: (string) the server hostname,
@@ -112,18 +112,18 @@
   - **username**: (string) the username in use,
   - **realname**: (string) the realname in use.
 
-### server-invite
+## server-invite
 
 Invite the specified target on the channel.
 
-#### Properties
+## Properties
 
   - **command**: (string) "server-invite",
   - **server**: (string) the server unique id,
   - **target**: (string) the nickname to invite,
   - **channel**: (string) the channel.
 
-#### Example
+## Example
 
 ````json
 {
@@ -134,18 +134,18 @@
 }
 ````
 
-### server-join
+## server-join
 
 Join the specified channel, the password is optional.
 
-#### Properties
+## Properties
 
   - **command**: (string) "server-join",
   - **server**: (string) the server unique id,
   - **channel**: (string) the channel to join,
   - **password**: (string) the password (Optional, default: none).
 
-#### Example
+## Example
 
 ````json
 {
@@ -155,11 +155,11 @@
 }
 ````
 
-### server-kick
+## server-kick
 
 Kick the specified target from the channel, the reason is optional.
 
-#### Properties
+## Properties
 
   - **command**: (string) "server-kick",
   - **server**: (string) the server unique id,
@@ -167,7 +167,7 @@
   - **channel**: (string) the channel,
   - **reason**: (string) the reason (Optional, default: none).
 
-#### Example
+## Example
 
 ````json
 {
@@ -179,15 +179,15 @@
 }
 ````
 
-### server-list
+## server-list
 
 Get the list of all connected servers.
 
-#### Properties
+## Properties
 
 - **command**: (string) "server-list".
 
-#### Example
+## Example
 
 ````json
 {
@@ -195,23 +195,23 @@
 }
 ````
 
-#### Responses
+## Responses
 
   - The following properties:
     - **list**: (string list) the list of all server unique ids.
 
-### server-me
+## server-me
 
 Send an action emote.
 
-#### Properties
+## Properties
 
   - **command**: (string) "server-me",
   - **server**: (string) the server unique id,
   - **target**: (string) the target or channel,
   - **message**: (string) the message.
 
-#### Example
+## Example
 
 ````json
 {
@@ -222,18 +222,18 @@
 }
 ````
 
-### server-message
+## server-message
 
 Send a message to the specified target or channel.
 
-#### Properties
+## Properties
 
   - **command**: (string) "server-message",
   - **server**: (string) the server unique id,
   - **target**: (string) the target or channel,
   - **message**: (string) the message.
 
-#### Example
+## Example
 
 ````json
 {
@@ -244,17 +244,17 @@
 }
 ````
 
-### server-mode
+## server-mode
 
 Set the irccd's user mode.
 
-#### Properties
+## Properties
 
   - **command**: (string) "server-mode",
   - **server**: (string) the server unique id,
   - **mode**: (string) the mode.
 
-#### Example
+## Example
 
 ````json
 {
@@ -264,17 +264,17 @@
 }
 ````
 
-### server-nick
+## server-nick
 
 Change irccd's nickname.
 
-#### Properties
+## Properties
 
   - **command**: (string) "server-nick",
   - **server**: (string) the server unique id,
   - **nickname**: (string) the new nickname.
 
-#### Example
+## Example
 
 ````json
 {
@@ -284,18 +284,18 @@
 }
 ````
 
-### server-notice
+## server-notice
 
 Send a private notice to the specified target.
 
-#### Properties
+## Properties
 
   - **command**: (string) "server-notice",
   - **server**: (string) the server unique id,
   - **target**: (string) the target,
   - **message**: (string) the notice message.
 
-#### Example
+## Example
 
 ````json
 {
@@ -306,20 +306,20 @@
 }
 ````
 
-### server-part
+## server-part
 
 Leave the specified channel, the reason is optional.
 
 Not all IRC servers support giving a reason to leave a channel, do not specify it if this is a concern.
 
-#### Properties
+## Properties
 
   - **command**: (string) "server-part",
   - **server**: (string) the unique server id,
   - **channel**: (string) the channel to leave,
   - **reason**: (string) the reason (Optional, default: none).
 
-#### Example
+## Example
 
 ````json
 {
@@ -330,18 +330,18 @@
 }
 ````
 
-### server-reconnect
+## server-reconnect
 
 Force reconnection of one or all servers.
 
 If server is not specified, all servers will try to reconnect.
 
-#### Properties
+## Properties
 
   - **command**: (string) "server-reconnect",
   - **server**: (string) the server unique id (Optional, default: none).
 
-#### Example
+## Example
 
 ````json
 {
@@ -350,18 +350,18 @@
 }
 ````
 
-### server-topic
+## server-topic
 
 Change the topic of the specified channel.
 
-#### Properties
+## Properties
 
   - **command**: (string) "server-topic",
   - **server**: (string) the unique server id,
   - **channel**: (string) the channel,
   - **topic**: (string) the new topic.
 
-#### Example
+## Example
 
 ````json
 {
@@ -372,7 +372,7 @@
 }
 ````
 
-### server-umode
+## server-umode
 
 Change your irccd user mode for the specified server.
 
--- a/doc/html/dev/socket-protocol.md	Tue Dec 06 13:17:27 2016 +0100
+++ b/doc/html/dev/socket-protocol.md	Tue Dec 06 19:32:48 2016 +0100
@@ -1,5 +1,5 @@
 ---
-title: Irccd socket API
+header: Irccd socket API
 guide: true
 ---
 
--- a/doc/html/index.md	Tue Dec 06 13:17:27 2016 +0100
+++ b/doc/html/index.md	Tue Dec 06 19:32:48 2016 +0100
@@ -22,8 +22,8 @@
 And about irccdctl.
 
   - [Configure irccdctl](irccdctl/configuring.html)
+  - [Irccdctl command line usage](irccdctl/usage.html)
   - [List of irccdctl commands](irccdctl/commands.html)
-  - [Irccdctl command line usage](irccdctl/usage.html)
 
 # Plugins
 
--- a/doc/html/irccd/configuring.md	Tue Dec 06 13:17:27 2016 +0100
+++ b/doc/html/irccd/configuring.md	Tue Dec 06 19:32:48 2016 +0100
@@ -1,10 +1,8 @@
 ---
-title: Configuring irccd
+header: Configuring irccd
 guide: yes
 ---
 
-# Configuring irccd
-
 To configure irccd, create a `irccd.conf` file in one of the
 [configuration directories][cfgdir].
 
--- a/doc/html/irccd/paths.md	Tue Dec 06 13:17:27 2016 +0100
+++ b/doc/html/irccd/paths.md	Tue Dec 06 19:32:48 2016 +0100
@@ -1,10 +1,8 @@
 ---
-title: Paths
+header: Paths
 guide: yes
 ---
 
-# Paths
-
 Irccd uses different types of paths depending on the context.
 
   - Configuration
@@ -14,7 +12,7 @@
 Paths prefixed by (W) means they are only used on Windows, others prefixed by
 (U) means they are used on Unix.
 
-## Configuration
+# Configuration
 
 The following directories are searched in the specified order for configuration
 files. For example, the files `irccd.conf` and `irccdctl.conf` will be searched
@@ -32,7 +30,7 @@
   - `C:/Program Files/irccd/etc/irccd.conf`
   - `C:/Users/john/AppData/irccd/config`
 
-## Data
+# Data
 
 The data directory is only used by plugins, it is dedicated to store important
 files such as plugin assets, logs or anything that is meaningful for the user
@@ -64,7 +62,7 @@
   - `C:/Users/john/AppData/irccd/share/plugin/ask`
   - `C:/Program Files/irccd/share/plugin/ask`
 
-## Plugins
+# Plugins
 
 These directories are searched in the following order to load plugins when they
 are not specified by full paths.
--- a/doc/html/irccdctl/configuring.md	Tue Dec 06 13:17:27 2016 +0100
+++ b/doc/html/irccdctl/configuring.md	Tue Dec 06 19:32:48 2016 +0100
@@ -1,5 +1,5 @@
 ---
-title: Configuring irccdctl
+header: Configuring irccdctl
 guide: yes
 ---
 
@@ -7,11 +7,7 @@
 
 You need to define at least one transport before using `irccdctl`.
 
-## Configuration
-
-Configuration of irccdctl is done in the same rules than `irccd`.
-
-### The general section
+# The general section
 
 This section defines the global irccdctl parameters.
 
@@ -26,7 +22,7 @@
 verbose = true
 ````
 
-## The connect section
+# The connect section
 
 The section socket permit irccdctl to connect to a specific irccd listener, only one may be defined. Just like
 transports you can connect to Unix or internet sockets.
--- a/doc/html/irccdctl/usage.md	Tue Dec 06 13:17:27 2016 +0100
+++ b/doc/html/irccdctl/usage.md	Tue Dec 06 19:32:48 2016 +0100
@@ -1,13 +1,13 @@
 ---
-title: Irccdctl usage and options
+header: Irccdctl usage and options
 guide: yes
 ---
 
-## Usage
+# Usage
 
 Usage of irccdctl.
 
-### Syntax
+## Syntax
 
 The general syntax for running an irccdctl command is:
 
@@ -17,7 +17,7 @@
 
 You can have the online documentation by typing `irccdctl help commandname`.
 
-### Shell escaping issue
+## Shell escaping issue
 
 Some shells may discard arguments if they begins with a hash. For instance, `bash` will not understand the following
 command:
--- a/doc/html/misc/common-patterns-and-formatting.md	Tue Dec 06 13:17:27 2016 +0100
+++ b/doc/html/misc/common-patterns-and-formatting.md	Tue Dec 06 19:32:48 2016 +0100
@@ -1,5 +1,5 @@
 ---
-title: Common patterns and formatting
+header: Common patterns and formatting
 guide: yes
 ---
 
--- a/doc/html/misc/configuration-syntax.md	Tue Dec 06 13:17:27 2016 +0100
+++ b/doc/html/misc/configuration-syntax.md	Tue Dec 06 19:32:48 2016 +0100
@@ -1,5 +1,5 @@
 ---
-title: Configuration file format
+header: Configuration file format
 guide: yes
 ---