Mercurial > irccd
changeset 20:8384df86e195
Docs: use nohighlight on non code, #418
author | David Demelier <markand@malikania.fr> |
---|---|
date | Fri, 12 Feb 2016 16:12:58 +0100 |
parents | 6b8ca778e589 |
children | 0357a728f8f8 |
files | doc/html/guide/02-install/01-building-from-sources.md doc/html/guide/02-install/02-customize.md doc/html/guide/03-config-format/01-basics.md doc/html/guide/05-irccdctl/02-usage.md doc/html/guide/05-irccdctl/03-commands.md doc/html/guide/06-plugin/01-intro.md doc/html/guide/06-plugin/03-patterns.md doc/html/guide/06-plugin/05-sample-plugin.md doc/html/guide/06-plugin/06-do-and-avoid.md plugins/ask/ask.md plugins/hangman/hangman.md plugins/history/history.md plugins/roulette/roulette.md |
diffstat | 13 files changed, 93 insertions(+), 85 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/html/guide/02-install/01-building-from-sources.md Fri Feb 12 13:51:42 2016 +0100 +++ b/doc/html/guide/02-install/01-building-from-sources.md Fri Feb 12 16:12:58 2016 +0100 @@ -23,7 +23,7 @@ When you're ready, extract the **irccd-x.y.z.tar.gz** where **x.y.z** is the current version. Go to that directory, then type the following commands: -```` +````nohighlight $ mkdir _build_ $ cd _build_ $ cmake ..
--- a/doc/html/guide/02-install/02-customize.md Fri Feb 12 13:51:42 2016 +0100 +++ b/doc/html/guide/02-install/02-customize.md Fri Feb 12 16:12:58 2016 +0100 @@ -6,7 +6,7 @@ You can disable JavaScript support. -```` +````nohighlight $ cmake .. -DWITH_JS=Off ```` @@ -18,7 +18,7 @@ **Warning**: this is not recommended. </div> -```` +````nohighlight $ cmake .. -DWITH_SSL=Off ```` @@ -26,7 +26,7 @@ You can disable all the documentation. -```` +````nohighlight $ cmake .. -DWITH_DOCS=Off ```` @@ -36,7 +36,7 @@ By default if Pandoc is available, the HTML documentation is built, you can disable it. -```` +````nohighlight $ cmake .. -DWITH_HTML=Off ```` @@ -44,7 +44,7 @@ You can disable installation of manuals. -```` +````nohighlight $ cmake .. -DWITH_MAN=Off ```` @@ -57,7 +57,7 @@ To change this, use the following: -```` +````nohighlight $ cmake .. -DCMAKE_INSTALL_PREFIX=/opt/some/directory ```` @@ -67,6 +67,6 @@ For example, on FreeBSD the typical use would be: -```` +````nohighlight $ cmake .. -DWITH_MANDIR=/usr/local/man ````
--- a/doc/html/guide/03-config-format/01-basics.md Fri Feb 12 13:51:42 2016 +0100 +++ b/doc/html/guide/03-config-format/01-basics.md Fri Feb 12 16:12:58 2016 +0100 @@ -6,8 +6,8 @@ The file syntax has following rules: -1. Each option is stored in a section, -2. Some sections may be redefined multiple times, -3. Empty option must have quotes (e.g. `option = ""`). + 1. Each option is stored in a section, + 2. Some sections may be redefined multiple times, + 3. Empty option must have quotes (e.g. `option = ""`). [ini]: https://en.wikipedia.org/wiki/INI_file
--- a/doc/html/guide/05-irccdctl/02-usage.md Fri Feb 12 13:51:42 2016 +0100 +++ b/doc/html/guide/05-irccdctl/02-usage.md Fri Feb 12 16:12:58 2016 +0100 @@ -6,7 +6,7 @@ The general syntax for running an irccdctl command is: -```` +````nohighlight irccdctl commandname arg1 arg2 arg3 ... argn ```` @@ -17,12 +17,12 @@ Some shells may discard arguments if they begins with a hash. For instance, `bash` will not understand the following command: -```` +````nohighlight $ irccdctl server-join localhost #staff ```` Instead, enclose the arguments with quotes -```` +````nohighlight $ irccdctl server-join localhost "#staff" ````
--- a/doc/html/guide/05-irccdctl/03-commands.md Fri Feb 12 13:51:42 2016 +0100 +++ b/doc/html/guide/05-irccdctl/03-commands.md Fri Feb 12 16:12:58 2016 +0100 @@ -8,13 +8,13 @@ **Usage** -```` +````nohighlight $ irccdctl help subject ```` **Example** -```` +````nohighlight $ irccdctl help server-message ```` @@ -24,13 +24,13 @@ **Usage** -```` +````nohighlight $ irccdctl plugin-info name ```` **Example** -```` +````nohighlight $ irccdctl plugin-info ask ```` @@ -40,7 +40,7 @@ **Usage** -```` +````nohighlight $ irccdctl plugin-list ```` @@ -50,13 +50,13 @@ **Usage** -```` +````nohighlight $ irccdctl plugin-load plugin ```` **Example** -```` +````nohighlight $ irccdctl load ask ```` @@ -68,13 +68,13 @@ **Usage** -```` +````nohighlight $ irccdctl plugin-reload name ```` **Example** -```` +````nohighlight $ irccdctl plugin-reload logger ```` @@ -84,13 +84,13 @@ **Usage** -```` +````nohighlight $ irccdctl plugin-unload name ```` **Example** -```` +````nohighlight $ irccdctl plugin-unload logger ```` @@ -100,13 +100,13 @@ **Usage** -```` +````nohighlight $ irccdctl server-cmode server channel mode ```` **Example** -```` +````nohighlight $ irccdctl server-cmode freenode #staff +t ```` @@ -116,13 +116,13 @@ **Usage** -```` +````nohighlight $ irccdctl server-cnotice server channel message ```` **Usage** -```` +````nohighlight $ irccdctl server-cnotice freenode #staff "Don't flood" ```` @@ -132,7 +132,7 @@ **Usage** -```` +````nohighlight $ irccdctl server-connect [options] name host port ```` @@ -147,7 +147,7 @@ **Example** -```` +````nohighlight $ irccdctl server-connect wanadoo chat.wanadoo.fr 6667 $ irccdctl server-connect -s -S -n "undead" wanadoo chat.wanadoo.fr 6697 ```` @@ -158,13 +158,13 @@ **Usage** -```` +````nohighlight $ irccdctl server-disconnect name ```` **Example** -```` +````nohighlight $ irccdctl server-disconnect wanadoo ```` @@ -174,13 +174,13 @@ **Usage** -```` +````nohighlight $ irccdctl server-invite server nickname channel ```` **Example** -```` +````nohighlight $ irccdctl server-invite freenode xorg62 #staff ```` @@ -190,13 +190,13 @@ **Usage** -```` +````nohighlight $ irccdctl server-join server channel [password] ```` **Example** -```` +````nohighlight $ irccdctl server-join freenode #staff ```` @@ -206,13 +206,13 @@ **Usage** -```` +````nohighlight $ irccdctl server-kick server target channel [reason] ```` **Example** -```` +````nohighlight $ irccdctl kick freenode jean #staff "Stop flooding" ```` @@ -222,7 +222,7 @@ **Usage** -```` +````nohighlight $ irccdctl server-list ```` @@ -232,13 +232,13 @@ **Usage** -```` +````nohighlight $ irccdctl server-me server target message ```` **Example** -```` +````nohighlight $ irccdctl server-me freenode #staff "going back soon" ```` @@ -248,13 +248,13 @@ **Usage** -```` +````nohighlight $ irccdctl server-message server target message ```` **Example** -```` +````nohighlight $ irccdctl server-message freenode #staff "Hello from irccd" ```` @@ -264,13 +264,13 @@ **Usage** -```` +````nohighlight $ server-mode server mode ```` **Example** -```` +````nohighlight $ irccdctl server-mode +i ```` @@ -280,13 +280,13 @@ **Usage** -```` +````nohighlight $ irccdctl server-nick server nickname ```` **Example** -```` +````nohighlight $ irccdctl server-nick freenode david ```` @@ -296,13 +296,13 @@ **Usage** -```` +````nohighlight $ irccdctl server-notice server target message ```` **Example** -```` +````nohighlight $ irccdctl server-notice freenode jean "I know you are here." ```` @@ -316,13 +316,13 @@ **Usage** -```` +````nohighlight $ irccdctl server-part server channel [reason] ```` **Example** -```` +````nohighlight $ irccdctl server-part freenode #staff $ irccdctl server-part freenode #botwar "too noisy" ```` @@ -335,13 +335,13 @@ **Usage** -```` +````nohighlight $ irccdctl server-reconnect [server] ```` **Example** -```` +````nohighlight $ irccdctl server-reconnect $ irccdctl server-reconnect wanadoo ```` @@ -352,13 +352,13 @@ **Usage** -```` +````nohighlight $ irccdctl server-topic server channel topic ```` **Example** -```` +````nohighlight $ irccdctl server-topic freenode #wmfs "This is the best channel" ```` @@ -369,13 +369,13 @@ **Usage** -```` +````nohighlight $ irccdctl watch [-f|--format native|json] ```` **Example** -```` +````nohighlight $ irccdctl watch $ irccdctl watch -f json ````
--- a/doc/html/guide/06-plugin/01-intro.md Fri Feb 12 13:51:42 2016 +0100 +++ b/doc/html/guide/06-plugin/01-intro.md Fri Feb 12 16:12:58 2016 +0100 @@ -12,9 +12,9 @@ However, many aspects between Lua and JavaScript are similar: -- Both languages are extremly small with very light API, -- It is easy to sandbox the interpreter for security reasons, -- It is very easy to implement your own API from C++ code. + - Both languages are extremly small with very light API, + - It is easy to sandbox the interpreter for security reasons, + - It is very easy to implement your own API from C++ code. The current JavaScript interpreter is powered by [Duktape][duktape].
--- a/doc/html/guide/06-plugin/03-patterns.md Fri Feb 12 13:51:42 2016 +0100 +++ b/doc/html/guide/06-plugin/03-patterns.md Fri Feb 12 16:12:58 2016 +0100 @@ -115,7 +115,7 @@ For instance, using the **logger** plugin, it's possible to customize the pattern to use when someone joins a channel like that: -```` +````nohighlight #{origin} joined #{channel} ````
--- a/doc/html/guide/06-plugin/05-sample-plugin.md Fri Feb 12 13:51:42 2016 +0100 +++ b/doc/html/guide/06-plugin/05-sample-plugin.md Fri Feb 12 16:12:58 2016 +0100 @@ -31,10 +31,10 @@ The parameters are defined as following: -- **server**, on which server the message happened -- **origin**, who emit the message (full nickname with host) -- **channel**, on which channel -- **message**, and the message content + - **server**, on which server the message happened + - **origin**, who emit the message (full nickname with host) + - **channel**, on which channel + - **message**, and the message content #### Send the response
--- a/doc/html/guide/06-plugin/06-do-and-avoid.md Fri Feb 12 13:51:42 2016 +0100 +++ b/doc/html/guide/06-plugin/06-do-and-avoid.md Fri Feb 12 16:12:58 2016 +0100 @@ -36,6 +36,6 @@ This will output to the irccd log something like: -```` +````nohighlight plugin foo: error condition ````
--- a/plugins/ask/ask.md Fri Feb 12 13:51:42 2016 +0100 +++ b/plugins/ask/ask.md Fri Feb 12 16:12:58 2016 +0100 @@ -20,8 +20,10 @@ Example: - markand: !ask will I be rich? - irccd: markand, No. +````nohighlight +markand: !ask will I be rich? +irccd: markand, No. +```` ## Configuration @@ -32,6 +34,8 @@ **~/.local/config/irccd/plugin/ask/answers.txt**: - Stop dreaming, - Definitely sure! - Maybe +````nohighlight +Stop dreaming, +Definitely sure! +Maybe +````
--- a/plugins/hangman/hangman.md Fri Feb 12 13:51:42 2016 +0100 +++ b/plugins/hangman/hangman.md Fri Feb 12 16:12:58 2016 +0100 @@ -31,7 +31,7 @@ When asking a letter, the message must just be one letter. -```` +````nohighlight markand: c irccd: markand, nice! the word is now c _ _ _ _ jean: k @@ -42,7 +42,7 @@ When asking by a word, just put one word as command. -```` +````nohighlight markand: !hangman couch irccd: markand, this is not the word. jean: !hangman candy @@ -96,7 +96,7 @@ Example: -```` +````nohighlight $ cat ~/.config/irccd/plugin/hangman/words.conf sky irccd
--- a/plugins/history/history.md Fri Feb 12 13:51:42 2016 +0100 +++ b/plugins/history/history.md Fri Feb 12 16:12:58 2016 +0100 @@ -24,10 +24,12 @@ Example: - markand: !history seen jean - irccd: markand, the last time I've seen jean was on 18/01/1989 at 20:55 - markand: !history said jean - irccd: markand, the last thing that jean said was: hello world +````nohighlight +markand: !history seen jean +irccd: markand, the last time I've seen jean was on 18/01/1989 at 20:55 +markand: !history said jean +irccd: markand, the last thing that jean said was: hello world +```` ## Configuration
--- a/plugins/roulette/roulette.md Fri Feb 12 13:51:42 2016 +0100 +++ b/plugins/roulette/roulette.md Fri Feb 12 16:12:58 2016 +0100 @@ -20,12 +20,14 @@ Example: - markand: !roulette - irccd: markand, you're lucky this time - markand: !roulette - irccd: markand, you're lucky this time - markand: !roulette - markand was kicked by irccd [markand, HEADSHOT] +````nohighlight +markand: !roulette +irccd: markand, you're lucky this time +markand: !roulette +irccd: markand, you're lucky this time +markand: !roulette +markand was kicked by irccd [markand, HEADSHOT] +```` ## Configuration