Updated/fixed documentation and fixed formatting.

This commit is contained in:
Elijah Perrault committed 2011-02-04 18:41:06 -07:00
1 parent 6162c8343d
commit d536563ea5
7 files changed
+35 -56

No files matched your search

+5 -5
View File
@@ -37,10 +37,10 @@ sub _void
# Help hashes. # Help hashes.
our %HELP_SHORTEN = ( our %HELP_SHORTEN = (
'en' => "This command will shorten an URL using Bit.ly. Syntax: SHORTEN <url>", 'en' => "This command will shorten an URL using Bit.ly. \002Syntax:\002 SHORTEN <url>",
); );
our %HELP_REVERSE = ( our %HELP_REVERSE = (
'en' => "This command will expand a Bit.ly URL. Syntax: REVERSE <url>", 'en' => "This command will expand a Bit.ly URL. \002Syntax:\002 REVERSE <url>",
); );
# Callback for SHORTEN command. # Callback for SHORTEN command.
@@ -173,9 +173,9 @@ Add Bitly to module auto-load and the following to your configuration file:
=over =over
This module adds an extra dependency: LWP::UserAgent. You can get it from This module adds an extra dependency: LWP::UserAgent. You can get it
the CPAN <http://www.cpan.org>. from the CPAN <http://www.cpan.org>.
This module is compatible with Auto version 3.0a2+. This module is compatible with Auto version 3.0.0a2+.
=back =back
+6 -14
View File
@@ -30,9 +30,9 @@ sub _void
return 1; return 1;
} }
# Help hashes. # Help hash.
our %FHELP_CALC = ( our %FHELP_CALC = (
'en' => "This command will calculate an expression using Google Calculator. Syntax: CALC <expression>", 'en' => "This command will calculate an expression using Google Calculator. \002Syntax:\002 CALC <expression>",
); );
# Callback for CALC command. # Callback for CALC command.
@@ -94,14 +94,6 @@ Google Calculator.
=back =back
=head2 How To Use
=over
Add Calc to the module autoload.
=back
=head2 Examples =head2 Examples
=over =over
@@ -115,7 +107,7 @@ Add Calc to the module autoload.
=over =over
* Add Spanish, French and German translations for the help hashes. * Add Spanish, French and German translations for the help hash.
=back =back
@@ -123,9 +115,9 @@ Add Calc to the module autoload.
=over =over
This module requires LWP::UserAgent, URI::Escape and JSON. All are obtainable This module requires LWP::UserAgent, URI::Escape and JSON. All are
from the CPAN <http://www.cpan.org>. obtainable from the CPAN <http://www.cpan.org>.
This module is compatible with Auto version 3.0a2+. This module is compatible with Auto version 3.0.0a2+.
=back =back
+5 -3
View File
@@ -33,10 +33,10 @@ sub _void
# Help hashes. # Help hashes.
our %HELP_8BALL = ( our %HELP_8BALL = (
'en' => "This command will ask the magic 8-Ball your question. Syntax: 8BALL <question>", 'en' => "This command will ask the magic 8-Ball your question. \002Syntax:\002 8BALL <question>",
); );
our %HELP_RIGBALL = ( our %HELP_RIGBALL = (
'en' => "This command will \"rig\" (set) the answer of the next 8-Ball question. Syntax: RIGBALL <answer>", 'en' => "This command will \"rig\" (set) the answer of the next 8-Ball question. \002Syntax:\002 RIGBALL <answer>",
); );
# Callback for 8BALL command. # Callback for 8BALL command.
@@ -143,6 +143,8 @@ command for setting ("rigging") the 8-Ball's next answer.
=over =over
This module is compatible with Auto version 3.0a2+. This module is compatible with Auto version 3.0.0a2+.
Ported from Auto 1.0.
=back =back
-1
View File
@@ -66,7 +66,6 @@ sub fml
return 1; return 1;
} }
# Start initialization. # Start initialization.
API::Std::mod_init("FML", "Xelhua", "1.00", "3.0.0d", __PACKAGE__); API::Std::mod_init("FML", "Xelhua", "1.00", "3.0.0d", __PACKAGE__);
+7 -15
View File
@@ -30,8 +30,8 @@ sub _void
# Help hashes. # Help hashes.
our %HELP_ISITUP = ( our %HELP_ISITUP = (
'en' => "This command will check if a website appears up or down to the bot. Syntax: ISITUP <url>", 'en' => "This command will check if a website appears up or down to the bot. \002Syntax:\002 ISITUP <url>",
); );
# Callback for ISITUP command. # Callback for ISITUP command.
sub check sub check
@@ -80,16 +80,8 @@ __END__
=over =over
This module adds the ISITUP command for checking if a This module adds the ISITUP command for checking if a website
website appears up or down to Auto. appears up or down to Auto.
=back
=head2 How To Use
=over
Add IsItUp to the module autoload.
=back =back
@@ -114,9 +106,9 @@ Add IsItUp to the module autoload.
=over =over
This module requires LWP::UserAgent. All are obtainable This module requires LWP::UserAgent. You can get it from
from the CPAN <http://www.cpan.org>. the CPAN <http://www.cpan.org>.
This module is compatible with Auto version 3.0a2+. This module is compatible with Auto version 3.0.0a2+.
=back =back
+3 -2
View File
@@ -183,8 +183,9 @@ block(s) you wish to use SASL with:
=over =over
This adds an extra dependency: You must build Auto with the --enable-sasl option. This adds an extra dependency: You must build Auto with the
--enable-sasl option.
This module is compatible with Auto v3.0a1+. This module is compatible with Auto v3.0.0a1+.
=back =back
+9 -16
View File
@@ -31,8 +31,8 @@ sub _void
# Help hashes. # Help hashes.
our %HELP_WEATHER = ( our %HELP_WEATHER = (
'en' => "This command will retrieve the weather via Wunderground for the specified location. Syntax: WEATHER <location>", 'en' => "This command will retrieve the weather via Wunderground for the specified location. \002Syntax:\002 WEATHER <location>",
); );
# Callback for Weather command. # Callback for Weather command.
sub weather sub weather
@@ -89,16 +89,8 @@ __END__
=over =over
This module adds the WEATHER command for retrieving This module adds the WEATHER command for retrieving the
the current weather. current weather.
=back
=head2 How To Use
=over
Add Weather to the module autoload.
=back =back
@@ -107,7 +99,8 @@ Add Weather to the module autoload.
=over =over
<JohnSmith> !weather 10111 <JohnSmith> !weather 10111
<Auto> Results for Central Park, New York - Temperature: 27 F (-3 C) Wind Conditions: From the NE at 9 MPH Gusting to 22 MPH Conditions: Overcast <Auto> Results for Central Park, New York - Temperature: 27 F (-3 C) Wind Conditions:
From the NE at 9 MPH Gusting to 22 MPH Conditions: Overcast
<Auto> Heat index: NA Humidity: 89% Pressure: 30.22 in (1023 mb) - Last Updated on February 1, 9:51 PM EST <Auto> Heat index: NA Humidity: 89% Pressure: 30.22 in (1023 mb) - Last Updated on February 1, 9:51 PM EST
=back =back
@@ -124,9 +117,9 @@ Add Weather to the module autoload.
=over =over
This module requires LWP::UserAgent and XML::Simple. Both obtainable This module requires LWP::UserAgent and XML::Simple. Both are
from CPAN <http://www.cpan.org>. obtainable from CPAN <http://www.cpan.org>.
This module is compatible with Auto version 3.0a2+. This module is compatible with Auto version 3.0.0a2+.
=back =back