Changeset 799b60e for perlwrap.pm

Timestamp:

Nov 15, 2008, 8:49:55 AM (16 years ago)

Author:

Geoffrey Thomas <geofft@mit.edu>

Branches:

master, debian, release-1.10, release-1.4, release-1.5, release-1.6, release-1.7, release-1.8, release-1.9

Children:

3381399

Parents:

43a306c

git-author:

Geoffrey Thomas <geofft@mit.edu> (11/13/08 01:05:57)

git-committer:

Geoffrey Thomas <geofft@mit.edu> (11/15/08 08:49:55)

Message:

Add the :show quickstart command.

In an effort to make barnowl more self-documenting, add a ':show quickstart'
command, which displays about two lines on using each protocol, a getQuickstart
perl hook, and references to this command in the startup message and :help.

Signed-off-by: Geoffrey Thomas <geofft@mit.edu>

File:

• perlwrap.pm (modified) (4 diffs)

perlwrap.pm

@@ -810 +810 @@
 displayed in a popup window, with zephyr formatting parsed.
 
+=item $getQuickstart
+
+Called by :show quickstart to display 2-5 lines of help on how to
+start using the protocol. The result from every function registered
+with this hook will be appended and displayed in an admin message,
+with zephyr formatting parsed. The format should be
+"@b(Protocol:)\nSome text.\nMore text.\n"
+
 =back
 
@@ -818 +826 @@
 our @EXPORT_OK = qw($startup $shutdown
                     $receiveMessage $newMessage
-                    $mainLoop $getBuddyList);
+                    $mainLoop $getBuddyList
+                    $getQuickstart);
 
 our %EXPORT_TAGS = (all => [@EXPORT_OK]);
@@ -828 +837 @@
 our $mainLoop = BarnOwl::Hook->new;
 our $getBuddyList = BarnOwl::Hook->new;
+our $getQuickstart = BarnOwl::Hook->new;
 
 # Internal startup/shutdown routines called by the C code
@@ -921 +931 @@
 }
 
+sub _get_quickstart {
+    return join("\n", $getQuickstart->run);
+}
+
 ################################################################################
 # Built-in perl styles