aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorZoffix Znet <cpan@zoffix.com>2016-08-10 08:53:51 -0400
committerZoffix Znet <cpan@zoffix.com>2016-08-10 08:53:51 -0400
commit145c4c7a116d64f473805c8f67cb15e1be4925e0 (patch)
treec13fc6d6a6301d9837caa148a2cde4cb6e3837db /docs
parent029c43c63b938c991a10cf27eb75907bc6d8623e (diff)
Add ToCs
Diffstat (limited to 'docs')
-rw-r--r--docs/01-basics.md10
-rw-r--r--docs/02-event-reference.md29
-rw-r--r--docs/03-method-reference.md93
-rw-r--r--docs/04-big-picture-behaviour.md5
4 files changed, 137 insertions, 0 deletions
diff --git a/docs/01-basics.md b/docs/01-basics.md
index d7ce0b4..9b7c96a 100644
--- a/docs/01-basics.md
+++ b/docs/01-basics.md
@@ -1,5 +1,15 @@
[[back to doc map]](README.md)
+# 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)
+
# Basics Tutorial
This tutorial covers basic usage of `IRC::Client`, without going into
diff --git a/docs/02-event-reference.md b/docs/02-event-reference.md
index ab4e702..81de5b6 100644
--- a/docs/02-event-reference.md
+++ b/docs/02-event-reference.md
@@ -1,5 +1,34 @@
[[back to doc map]](README.md)
+# 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)
+
# Event Reference
The module offers named, numeric, and convenience events. The named and
diff --git a/docs/03-method-reference.md b/docs/03-method-reference.md
index 6963d64..25893b6 100644
--- a/docs/03-method-reference.md
+++ b/docs/03-method-reference.md
@@ -1,5 +1,98 @@
[[back to doc map]](README.md)
+# 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)
+
# Method Reference
This document describes events available on various objects in use when working
diff --git a/docs/04-big-picture-behaviour.md b/docs/04-big-picture-behaviour.md
index 19f5ae7..bdf7f21 100644
--- a/docs/04-big-picture-behaviour.md
+++ b/docs/04-big-picture-behaviour.md
@@ -1,5 +1,10 @@
[[back to doc map]](README.md)
+# TABLE OF CONTENTS
+- [Big-Picture Behaviour](#big-picture-behaviour)
+ - [Connection Maintenance](#connection-maintenance)
+ - [Nickname Maintenance](#nickname-maintenance)
+
# Big-Picture Behaviour
This document describes the general behaviour of the `IRC::Client` clients.