diff --git a/docs/bot_options.md b/docs/bot_options.md index d6cfe13b..9f2a9e1e 100644 --- a/docs/bot_options.md +++ b/docs/bot_options.md @@ -59,7 +59,7 @@ Description ### Notes -- {file:encodings.md More information on how Cinch handles encoding issues} +- {file:docs/encodings.md More information on how Cinch handles encoding issues} ## local_host Type @@ -114,7 +114,7 @@ Description ### Notes - If your bot gets kicked for excess flood, try lowering the value of `messages_per_second`. -- See also: {file:bot_options.md#serverqueuesize `server_queue_size`} +- See also: {file:docs/bot_options.md#serverqueuesize `server_queue_size`} ## message_split_end Type @@ -175,7 +175,7 @@ Default value : `nil` Description -: This option overrules {file:bot_options.md#nick `nick`} and allows Cinch +: This option overrules {file:docs/bot_options.md#nick `nick`} and allows Cinch to try multiple nicks before adding underscores. @@ -209,7 +209,7 @@ Description ### Notes - The ping interval should be smaller than - {file:bot_options.md#timeoutsread `timeouts.read`} to prevent Cinch from + {file:docs/bot_options.md#timeoutsread `timeouts.read`} to prevent Cinch from falsely declaring a connection dead. @@ -348,7 +348,7 @@ Description ### Notes - If your bot gets kicked for excess flood, try lowering the value of `server_queue_size`. -- See also: {file:bot_options.md#messagespersecond `messages_per_second`} +- See also: {file:docs/bot_options.md#messagespersecond `messages_per_second`} ## ssl @@ -382,7 +382,7 @@ Default value Description : The path to a directory with certificates. This has to be set - properly for {file:bot_options.md#sslverify `ssl.verify`} to work. + properly for {file:docs/bot_options.md#sslverify `ssl.verify`} to work. ### ssl.client_cert diff --git a/docs/changes.md b/docs/changes.md index ddf8feba..5c8b1794 100644 --- a/docs/changes.md +++ b/docs/changes.md @@ -94,7 +94,7 @@ needs to be aware of available features/quirks, check out ## Reworked logging facilities The logging API has been drastically improved. Check the -{file:logging.md logging documentation} for more information. +{file:docs/logging.md logging documentation} for more information. ## Added match groups @@ -234,7 +234,7 @@ moved from {Cinch} to {Cinch::Constants} - {Cinch::User#away} - {Cinch::User#dcc_send} - See {Cinch::DCC::Outgoing::Send} - {Cinch::User#match} -- {Cinch::User#monitor} - See {file:common_tasks.md#checking-if-a-user-is-online Checking if a user is online} +- {Cinch::User#monitor} - See {file:docs/common_tasks.md#checking-if-a-user-is-online Checking if a user is online} - {Cinch::User#monitored} - {Cinch::User#online?} - {Cinch::User#unmonitor} @@ -297,7 +297,7 @@ instead are made available via {Cinch::Plugin::ClassMethods#set a `set` method} or alternatively plain attribute setters. See -{file:migrating.md#plugin-options the migration guide} for more +{file:docs/migrating.md#plugin-options the migration guide} for more information. ### Channel/Target/User implement Comparable @@ -342,24 +342,24 @@ For more information on timers, see the {Cinch::Timer Timer documentation}. ## New options -- :{file:bot_options.md#dccownip dcc.own_ip} -- :{file:bot_options.md#modes modes} -- :{file:bot_options.md#maxreconnectdelay max_reconnect_delay} -- :{file:bot_options.md#localhost local_host} -- :{file:bot_options.md#delayjoins delay_joins} -- :{file:bot_options.md#saslusername sasl.username} -- :{file:bot_options.md#saslpassword sasl.password} +- :{file:docs/bot_options.md#dccownip dcc.own_ip} +- :{file:docs/bot_options.md#modes modes} +- :{file:docs/bot_options.md#maxreconnectdelay max_reconnect_delay} +- :{file:docs/bot_options.md#localhost local_host} +- :{file:docs/bot_options.md#delayjoins delay_joins} +- :{file:docs/bot_options.md#saslusername sasl.username} +- :{file:docs/bot_options.md#saslpassword sasl.password} ## New events -- :{file:events.md#action action} -- :{file:events.md#away away} -- :{file:events.md#unaway unaway} -- :{file:events.md#dccsend dcc_send} -- :{file:events.md#owner owner} -- :{file:events.md#dehalfop-deop-deowner-devoice deowner} -- :{file:events.md#leaving leaving} -- :{file:events.md#online online} -- :{file:events.md#offline offline} +- :{file:docs/events.md#action action} +- :{file:docs/events.md#away away} +- :{file:docs/events.md#unaway unaway} +- :{file:docs/events.md#dccsend dcc_send} +- :{file:docs/events.md#owner owner} +- :{file:docs/events.md#dehalfop-deop-deowner-devoice deowner} +- :{file:docs/events.md#leaving leaving} +- :{file:docs/events.md#online online} +- :{file:docs/events.md#offline offline} # What has changed in 1.1? @@ -371,16 +371,16 @@ x. **Deprecated methods** ## New events -- :{file:events.md#op op} -- :{file:events.md#dehalfop-deop-deowner-devoice deop} -- :{file:events.md#voice voice} -- :{file:events.md#dehalfop-deop-deowner-devoice devoice} -- :{file:events.md#halfop halfop} -- :{file:events.md#dehalfop-deop-deowner-devoice dehalfop} -- :{file:events.md#ban ban} -- :{file:events.md#unban unban} -- :{file:events.md#modechange mode_change} -- :{file:events.md#catchall catchall} +- :{file:docs/events.md#op op} +- :{file:docs/events.md#dehalfop-deop-deowner-devoice deop} +- :{file:docs/events.md#voice voice} +- :{file:docs/events.md#dehalfop-deop-deowner-devoice devoice} +- :{file:docs/events.md#halfop halfop} +- :{file:docs/events.md#dehalfop-deop-deowner-devoice dehalfop} +- :{file:docs/events.md#ban ban} +- :{file:docs/events.md#unban unban} +- :{file:docs/events.md#modechange mode_change} +- :{file:docs/events.md#catchall catchall} Additionally, plugins are now able to send their own events by using Cinch::Bot#dispatch. @@ -401,16 +401,16 @@ Provides a nicer representation of {Cinch::Message} objects. Provides an easier way of checking if a given user is in a channel ## New options -- {file:bot_options.md#pluginssuffix plugins.suffix} -- {file:bot_options.md#ssluse ssl.use} -- {file:bot_options.md#sslverify ssl.verify} -- {file:bot_options.md#sslcapath ssl.ca_path} -- {file:bot_options.md#sslclientcert ssl.client_cert} -- {file:bot_options.md#nicks nicks} -- {file:bot_options.md#timeoutsread timeouts.read} -- {file:bot_options.md#timeoutsconnect timeouts.connect} -- {file:bot_options.md#pinginterval ping_interval} -- {file:bot_options.md#reconnect reconnect} +- {file:docs/bot_options.md#pluginssuffix plugins.suffix} +- {file:docs/bot_options.md#ssluse ssl.use} +- {file:docs/bot_options.md#sslverify ssl.verify} +- {file:docs/bot_options.md#sslcapath ssl.ca_path} +- {file:docs/bot_options.md#sslclientcert ssl.client_cert} +- {file:docs/bot_options.md#nicks nicks} +- {file:docs/bot_options.md#timeoutsread timeouts.read} +- {file:docs/bot_options.md#timeoutsconnect timeouts.connect} +- {file:docs/bot_options.md#pinginterval ping_interval} +- {file:docs/bot_options.md#reconnect reconnect} diff --git a/docs/encodings.md b/docs/encodings.md index dca94a42..a5c4f5da 100644 --- a/docs/encodings.md +++ b/docs/encodings.md @@ -16,7 +16,7 @@ Cinch tries to work around this issue in two ways, while also keeping the usual Ruby behaviour. ## The `encoding` option -By setting {file:bot_options.md#encoding the `encoding` option}, you +By setting {file:docs/bot_options.md#encoding the `encoding` option}, you set your expectations on what encoding other users will use. Allowed values are instances of Encoding, names of valid encodings (as strings) and the special `:irc` encoding, which will be explained @@ -26,7 +26,7 @@ further down. ## Encoding.default_internal If set, Cinch will automatically convert incoming messages to the encoding defined by `Encoding.default_internal`, unless the special -encoding `:irc` is being used as the {file:bot_options.md#encoding +encoding `:irc` is being used as the {file:docs/bot_options.md#encoding `encoding option`} ## The `:irc` encoding diff --git a/docs/events.md b/docs/events.md index 8df8a902..fa172f57 100644 --- a/docs/events.md +++ b/docs/events.md @@ -72,7 +72,7 @@ Example: debug("User %s just went away: %s" % [m.user, m.message]) end -See also {file:events.md#unaway the `:unaway` event}. +See also {file:docs/events.md#unaway the `:unaway` event}. ## `:ban` @@ -88,7 +88,7 @@ Example: debug("%s just banned %s" % [ban.by, ban.mask]) end -See also {file:events.md#unban the `:unban` event}. +See also {file:docs/events.md#unban the `:unban` event}. ## `:catchall` @@ -102,7 +102,7 @@ IRC message/command, no matter what the type is. The `:channel` event is triggered for channel messages (the usual form of communication on IRC). -See also {file:events.md#private the `:private` event}. +See also {file:docs/events.md#private the `:private` event}. ## `:connect` @@ -193,7 +193,7 @@ describing every change. ## `:offline` This event is triggered when a -{file:common_tasks.md#checking-if-a-user-is-online monitored user} +{file:docs/common_tasks.md#checking-if-a-user-is-online monitored user} goes offline. One additional argument, the user going offline, gets passed to the @@ -203,7 +203,7 @@ handler. ## `:online` This event is triggered when a -{file:common_tasks.md#checking-if-a-user-is-online monitored user} +{file:docs/common_tasks.md#checking-if-a-user-is-online monitored user} comes online. One additional argument, the user coming online, gets passed to the @@ -239,7 +239,7 @@ channel or directly at the bot. It's synonymous with `:privmsg`. The `:private` event is triggered for messages directly towarded at the bot (think /query in traditional IRC clients). -See also {file:events.md#channel the `:channel` event}. +See also {file:docs/events.md#channel the `:channel` event}. ## `:unaway` @@ -254,7 +254,7 @@ Example: debug("User %s no longer is away." % m.user) end -See also {file:events.md#away the `:away` event}. +See also {file:docs/events.md#away the `:away` event}. ## `:unban` diff --git a/docs/migrating.md b/docs/migrating.md index 9bac8a72..f1ab9eca 100644 --- a/docs/migrating.md +++ b/docs/migrating.md @@ -193,7 +193,7 @@ that. Alterntively you can also use the logging-related helper methods provided by {Cinch::Helpers}. For more information on the logging architecture as well as examples -on how to use it, check the {file:logging.md Logging readme}. +on how to use it, check the {file:docs/logging.md Logging readme}. ## Prefix/suffix + string semantics @@ -239,12 +239,12 @@ or The second version is especially interesting to tools like {https://github.com/netfeed/cinchize Cinchize}, which load the configuration from a YAML file. For more information see -{file:bot_options.md Bot options}. +{file:docs/bot_options.md Bot options}. ## Various removed methods -See {file:changes.md#removedrenamed-methods What's changed} +See {file:docs/changes.md#removedrenamed-methods What's changed} ## `on`-handlers now only accepts one pattern diff --git a/lib/cinch/bot.rb b/lib/cinch/bot.rb index a118d28b..dccd35d1 100644 --- a/lib/cinch/bot.rb +++ b/lib/cinch/bot.rb @@ -171,7 +171,7 @@ def synchronize(name, &block) # Registers a handler. # # @param [String, Symbol, Integer] event the event to match. For a - # list of available events, check the {file:events.md Events + # list of available events, check the {file:docs/events.md Events # documentation}. # # @param [Regexp, Pattern, String] regexp every message of the diff --git a/lib/cinch/dcc/outgoing/send.rb b/lib/cinch/dcc/outgoing/send.rb index 6ba8edd6..9915deea 100644 --- a/lib/cinch/dcc/outgoing/send.rb +++ b/lib/cinch/dcc/outgoing/send.rb @@ -27,7 +27,7 @@ module Outgoing # but sending files will probably be the most common case. # # If you're behind a NAT it is necessary to explicitly set the - # external IP using the {file:bot_options.md#dccownip dcc.own_ip + # external IP using the {file:docs/bot_options.md#dccownip dcc.own_ip # option}. # # @example Sending a file to a user