bot: convert previous commit into table

This commit is contained in:
Aminda Suomalainen 2015-08-22 17:03:26 +03:00
parent 4cf4058f39
commit f010a7bf19

View File

@ -33,24 +33,61 @@ written by me.
### Addressing the bot ### Addressing the bot
* Currently the bot replies to the following globally: The following table opens where the bot will reply to in channel. In PM
* prefix characters: `%` `+` `!` the bot replies to everything *(without prefix)*.
* `+ping` `%ping` `+ping`
* can be changed per-channel
* nick in the beginning and end
* `bot: ping` `ping, bot`
* prefix strings: `msb1` & `msb2` (for legacy reasons) and `__`
* can be changed per-channel
* MessageParser (in the middle of line): `__` & `__()`
* Does the bot work?`__ping` for single-worded commands and
`what is Linux? __(wiki Linux)` for commands with multiple words.
* **I won't change this per channel.**
* Checking the different channel-specific addressing methods: <table border="1">
* prefix characters: `channel reply.whenaddressedby.chars` <tr>
* nick in the beginning and end: `channel reply.whenaddressedby.nick` <th>Replies to</th>
`channel reply.whenaddressedby.nick.atend <th>Examples</th>
* prefix strings: `channel reply.whenaddressedby.strings` <th>Changeable per-channel>/th>
</tr>
<tr>
<td>prefix characters: `%` `+` `!`</td>
<td>+ping` `%ping` `+ping`</td>
<td>yes</td>
</tr>
<tr>
<td>nick in the beginning and end</td>
<td>`bot: ping` `ping, bot`</td>
<td>Yes (not nick), but why?</td>
</tr>
<tr>
<td> prefix strings: `msb1` & `msb2` (for legacy reasons) and
`__`</td>
<td>`msb1ping` `msb2ping` `__ping`</td>
<td>yes</td>
</tr>
<tr>
<td>MessageParser (in the middle of line): `__` & `__()`</td>
<td>`Does the bot work? __ping` for single-worded commands and
`what is Linux? __(wiki Linux)` for commands with multiple
words.</td>
<td>**no**(too difficult, but possible)</td>
</tr>
</table>
For checking the channel specific prefixes, refer to the following
commands. They can be used in channel (if you know the prefix) or PM.
<table border="1">
<tr>
<th>Prefix</th>
<th>Command</th>
</tr>
<tr>
<td>Prefix characters</td>
<td>`channel reply.whenaddressedby.chars</td>
</tr>
<tr>
<td>Nick (beginning & end)</td>
<td>`channel reply.whenaddressedby.nick` &
` channel reply.whenaddressedby.nick.atend`
</tr>
<td>prefix strings</td>
<td>`channel reply.whenaddressedby.strings`
</tr>
</table>
### Quick start ### Quick start