aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorZoffix Znet <cpan@zoffix.com>2016-08-10 08:55:19 -0400
committerZoffix Znet <cpan@zoffix.com>2016-08-10 08:55:19 -0400
commit5fefbef2308fb5b2beea1fe938696f79d74c66c0 (patch)
tree52269c2ffc6d9c685b84c5fe9beda18ad608368d /docs
parent145c4c7a116d64f473805c8f67cb15e1be4925e0 (diff)
Improve TOC alignment
Diffstat (limited to 'docs')
-rw-r--r--docs/01-basics.md14
-rw-r--r--docs/02-event-reference.md52
-rw-r--r--docs/03-method-reference.md180
-rw-r--r--docs/04-big-picture-behaviour.md4
4 files changed, 125 insertions, 125 deletions
diff --git a/docs/01-basics.md b/docs/01-basics.md
index 9b7c96a..2af95c6 100644
--- a/docs/01-basics.md
+++ b/docs/01-basics.md
@@ -2,13 +2,13 @@
# TABLE OF CONTENTS
- [Basics Tutorial](#basics-tutorial)
- - [Blog Tutorial](#blog-tutorial)
- - [Subscribing to Events](#subscribing-to-events)
- - [Event Handler Input](#event-handler-input)
- - [Responding to Events](#responding-to-events)
- - [Example: Echo Bot](#example-echo-bot)
- - [Generating Messages](#generating-messages)
- - [Up Next](#up-next)
+- [Blog Tutorial](#blog-tutorial)
+- [Subscribing to Events](#subscribing-to-events)
+ - [Event Handler Input](#event-handler-input)
+- [Responding to Events](#responding-to-events)
+ - [Example: Echo Bot](#example-echo-bot)
+- [Generating Messages](#generating-messages)
+- [Up Next](#up-next)
# Basics Tutorial
diff --git a/docs/02-event-reference.md b/docs/02-event-reference.md
index 81de5b6..5d841a5 100644
--- a/docs/02-event-reference.md
+++ b/docs/02-event-reference.md
@@ -2,32 +2,32 @@
# TABLE OF CONTENTS
- [Event Reference](#event-reference)
- - [Responding to Events](#responding-to-events)
- - [Event Map](#event-map)
- - [Event Triggers](#event-triggers)
- - [`irc-addressed`](#irc-addressed)
- - [`irc-all`](#irc-all)
- - [`irc-connected`](#irc-connected)
- - [`irc-join`](#irc-join)
- - [`irc-mentioned`](#irc-mentioned)
- - [`irc-mode`](#irc-mode)
- - [`irc-mode-channel`](#irc-mode-channel)
- - [`irc-mode-me`](#irc-mode-me)
- - [`irc-nick`](#irc-nick)
- - [`irc-notice`](#irc-notice)
- - [`irc-notice-channel`](#irc-notice-channel)
- - [`irc-notice-me`](#irc-notice-me)
- - [`irc-numeric`](#irc-numeric)
- - [`irc-part`](#irc-part)
- - [`irc-privmsg`](#irc-privmsg)
- - [`irc-privmsg-channel`](#irc-privmsg-channel)
- - [`irc-privmsg-me`](#irc-privmsg-me)
- - [`irc-quit`](#irc-quit)
- - [`irc-started`](#irc-started)
- - [`irc-to-me`](#irc-to-me)
- - [`irc-unknown`](#irc-unknown)
- - [`irc-XXX`](#irc-xxx)
- - [Up Next](#up-next)
+- [Responding to Events](#responding-to-events)
+- [Event Map](#event-map)
+- [Event Triggers](#event-triggers)
+ - [`irc-addressed`](#irc-addressed)
+ - [`irc-all`](#irc-all)
+ - [`irc-connected`](#irc-connected)
+ - [`irc-join`](#irc-join)
+ - [`irc-mentioned`](#irc-mentioned)
+ - [`irc-mode`](#irc-mode)
+ - [`irc-mode-channel`](#irc-mode-channel)
+ - [`irc-mode-me`](#irc-mode-me)
+ - [`irc-nick`](#irc-nick)
+ - [`irc-notice`](#irc-notice)
+ - [`irc-notice-channel`](#irc-notice-channel)
+ - [`irc-notice-me`](#irc-notice-me)
+ - [`irc-numeric`](#irc-numeric)
+ - [`irc-part`](#irc-part)
+ - [`irc-privmsg`](#irc-privmsg)
+ - [`irc-privmsg-channel`](#irc-privmsg-channel)
+ - [`irc-privmsg-me`](#irc-privmsg-me)
+ - [`irc-quit`](#irc-quit)
+ - [`irc-started`](#irc-started)
+ - [`irc-to-me`](#irc-to-me)
+ - [`irc-unknown`](#irc-unknown)
+ - [`irc-XXX`](#irc-xxx)
+- [Up Next](#up-next)
# Event Reference
diff --git a/docs/03-method-reference.md b/docs/03-method-reference.md
index 25893b6..2d27a82 100644
--- a/docs/03-method-reference.md
+++ b/docs/03-method-reference.md
@@ -2,96 +2,96 @@
# TABLE OF CONTENTS
- [Method Reference](#method-reference)
- - [Message Objects (`IRC::Client::Message` and subclasses)](#message-objects-ircclientmessage-and-subclasses)
- - [Message Object Hierarchy](#message-object-hierarchy)
- - [Methods and Attributes](#methods-and-attributes)
- - [`IRC::Client::Message`](#ircclientmessage)
- - [`.irc`](#irc)
- - [`.nick`](#nick)
- - [`.username`](#username)
- - [`.host`](#host)
- - [`.usermask`](#usermask)
- - [`.command`](#command)
- - [`.server`](#server)
- - [`.args`](#args)
- - [`.Str`](#str)
- - [`IRC::Client::Message::Join`](#ircclientmessagejoin)
- - [`.channel`](#channel)
- - [`IRC::Client::Message::Nick`](#ircclientmessagenick)
- - [`.new-nick`](#new-nick)
- - [`IRC::Client::Message::Numeric`](#ircclientmessagenumeric)
- - [`IRC::Client::Message::Part`](#ircclientmessagepart)
- - [`.channel`](#channel-1)
- - [`IRC::Client::Message::Ping`](#ircclientmessageping)
- - [`.reply`](#reply)
- - [`IRC::Client::Message::Quit`](#ircclientmessagequit)
- - [`IRC::Client::Message::Unknown`](#ircclientmessageunknown)
- - [`.Str`](#str-1)
- - [`IRC::Client::Message::Mode`](#ircclientmessagemode)
- - [`.modes`](#modes)
- - [`IRC::Client::Message::Mode::Channel`](#ircclientmessagemodechannel)
- - [`.channel`](#channel-2)
- - [`IRC::Client::Message::Mode::Me`](#ircclientmessagemodeme)
- - [`IRC::Client::Message::Notice`](#ircclientmessagenotice)
- - [`.text`](#text)
- - [`.replied`](#replied)
- - [`.Str`](#str-2)
- - [`IRC::Client::Message::Notice::Channel`](#ircclientmessagenoticechannel)
- - [`.channel`](#channel-3)
- - [`.reply`](#reply-1)
- - [`IRC::Client::Message::Notice::Me`](#ircclientmessagenoticeme)
- - [`.reply`](#reply-2)
- - [`IRC::Client::Message::Privmsg`](#ircclientmessageprivmsg)
- - [`.text`](#text-1)
- - [`.replied`](#replied-1)
- - [`.Str`](#str-3)
- - [`IRC::Client::Message::Privmsg::Channel`](#ircclientmessageprivmsgchannel)
- - [`.channel`](#channel-4)
- - [`.reply`](#reply-3)
- - [`IRC::Client::Message::Privmsg::Me`](#ircclientmessageprivmsgme)
- - [`.reply`](#reply-4)
- - [Server Object (`IRC::Client::Server`)](#server-object-ircclientserver)
- - [Labels](#labels)
- - [Methods and Attributes](#methods-and-attributes-1)
- - [`.label`](#label)
- - [`.channels`](#channels)
- - [`.nick`](#nick-1)
- - [`.alias`](#alias)
- - [`.host`](#host-1)
- - [`.port`](#port)
- - [`.password`](#password)
- - [`.username`](#username-1)
- - [`.userhost`](#userhost)
- - [`.userreal`](#userreal)
- - [`.Str`](#str-4)
- - [Writable Non-Writable Attributes](#writable-non-writable-attributes)
- - [`.current-nick`](#current-nick)
- - [`.is-connected`](#is-connected)
- - [`.has-quit`](#has-quit)
- - [`.has-quit`](#has-quit-1)
- - [Client Object (`IRC::Client`)](#client-object-ircclient)
- - [Methods and Attributes](#methods-and-attributes-2)
- - [`.join`](#join)
- - [`.new`](#new)
- - [`:channels`](#channels-1)
- - [`:debug`](#debug)
- - [`:filters`](#filters)
- - [`:host`](#host-2)
- - [`:nick`](#nick-2)
- - [`:alias`](#alias-1)
- - [`:password`](#password-1)
- - [`:plugins`](#plugins)
- - [`:port`](#port-1)
- - [`:servers`](#servers)
- - [`:username`](#username-2)
- - [`:userhost`](#userhost-1)
- - [`:userreal`](#userreal-1)
- - [`.nick`](#nick-3)
- - [`.part`](#part)
- - [`.quit`](#quit)
- - [`.run`](#run)
- - [`.send`](#send)
- - [Up Next](#up-next)
+- [Message Objects (`IRC::Client::Message` and subclasses)](#message-objects-ircclientmessage-and-subclasses)
+ - [Message Object Hierarchy](#message-object-hierarchy)
+ - [Methods and Attributes](#methods-and-attributes)
+ - [`IRC::Client::Message`](#ircclientmessage)
+ - [`.irc`](#irc)
+ - [`.nick`](#nick)
+ - [`.username`](#username)
+ - [`.host`](#host)
+ - [`.usermask`](#usermask)
+ - [`.command`](#command)
+ - [`.server`](#server)
+ - [`.args`](#args)
+ - [`.Str`](#str)
+ - [`IRC::Client::Message::Join`](#ircclientmessagejoin)
+ - [`.channel`](#channel)
+ - [`IRC::Client::Message::Nick`](#ircclientmessagenick)
+ - [`.new-nick`](#new-nick)
+ - [`IRC::Client::Message::Numeric`](#ircclientmessagenumeric)
+ - [`IRC::Client::Message::Part`](#ircclientmessagepart)
+ - [`.channel`](#channel-1)
+ - [`IRC::Client::Message::Ping`](#ircclientmessageping)
+ - [`.reply`](#reply)
+ - [`IRC::Client::Message::Quit`](#ircclientmessagequit)
+ - [`IRC::Client::Message::Unknown`](#ircclientmessageunknown)
+ - [`.Str`](#str-1)
+ - [`IRC::Client::Message::Mode`](#ircclientmessagemode)
+ - [`.modes`](#modes)
+ - [`IRC::Client::Message::Mode::Channel`](#ircclientmessagemodechannel)
+ - [`.channel`](#channel-2)
+ - [`IRC::Client::Message::Mode::Me`](#ircclientmessagemodeme)
+ - [`IRC::Client::Message::Notice`](#ircclientmessagenotice)
+ - [`.text`](#text)
+ - [`.replied`](#replied)
+ - [`.Str`](#str-2)
+ - [`IRC::Client::Message::Notice::Channel`](#ircclientmessagenoticechannel)
+ - [`.channel`](#channel-3)
+ - [`.reply`](#reply-1)
+ - [`IRC::Client::Message::Notice::Me`](#ircclientmessagenoticeme)
+ - [`.reply`](#reply-2)
+ - [`IRC::Client::Message::Privmsg`](#ircclientmessageprivmsg)
+ - [`.text`](#text-1)
+ - [`.replied`](#replied-1)
+ - [`.Str`](#str-3)
+ - [`IRC::Client::Message::Privmsg::Channel`](#ircclientmessageprivmsgchannel)
+ - [`.channel`](#channel-4)
+ - [`.reply`](#reply-3)
+ - [`IRC::Client::Message::Privmsg::Me`](#ircclientmessageprivmsgme)
+ - [`.reply`](#reply-4)
+- [Server Object (`IRC::Client::Server`)](#server-object-ircclientserver)
+ - [Labels](#labels)
+ - [Methods and Attributes](#methods-and-attributes-1)
+ - [`.label`](#label)
+ - [`.channels`](#channels)
+ - [`.nick`](#nick-1)
+ - [`.alias`](#alias)
+ - [`.host`](#host-1)
+ - [`.port`](#port)
+ - [`.password`](#password)
+ - [`.username`](#username-1)
+ - [`.userhost`](#userhost)
+ - [`.userreal`](#userreal)
+ - [`.Str`](#str-4)
+ - [Writable Non-Writable Attributes](#writable-non-writable-attributes)
+ - [`.current-nick`](#current-nick)
+ - [`.is-connected`](#is-connected)
+ - [`.has-quit`](#has-quit)
+ - [`.has-quit`](#has-quit-1)
+- [Client Object (`IRC::Client`)](#client-object-ircclient)
+ - [Methods and Attributes](#methods-and-attributes-2)
+ - [`.join`](#join)
+ - [`.new`](#new)
+ - [`:channels`](#channels-1)
+ - [`:debug`](#debug)
+ - [`:filters`](#filters)
+ - [`:host`](#host-2)
+ - [`:nick`](#nick-2)
+ - [`:alias`](#alias-1)
+ - [`:password`](#password-1)
+ - [`:plugins`](#plugins)
+ - [`:port`](#port-1)
+ - [`:servers`](#servers)
+ - [`:username`](#username-2)
+ - [`:userhost`](#userhost-1)
+ - [`:userreal`](#userreal-1)
+ - [`.nick`](#nick-3)
+ - [`.part`](#part)
+ - [`.quit`](#quit)
+ - [`.run`](#run)
+ - [`.send`](#send)
+- [Up Next](#up-next)
# Method Reference
diff --git a/docs/04-big-picture-behaviour.md b/docs/04-big-picture-behaviour.md
index bdf7f21..ad48211 100644
--- a/docs/04-big-picture-behaviour.md
+++ b/docs/04-big-picture-behaviour.md
@@ -2,8 +2,8 @@
# TABLE OF CONTENTS
- [Big-Picture Behaviour](#big-picture-behaviour)
- - [Connection Maintenance](#connection-maintenance)
- - [Nickname Maintenance](#nickname-maintenance)
+- [Connection Maintenance](#connection-maintenance)
+- [Nickname Maintenance](#nickname-maintenance)
# Big-Picture Behaviour