Changeset 799b60e for perlwrap.pm


Ignore:
Timestamp:
Nov 15, 2008, 8:49:55 AM (12 years ago)
Author:
Geoffrey Thomas <geofft@mit.edu>
Branches:
master, debian, 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:
1 edited

Legend:

Unmodified
Added
Removed
  • perlwrap.pm

    r740d5f7 r799b60e  
    810810displayed in a popup window, with zephyr formatting parsed.
    811811
     812=item $getQuickstart
     813
     814Called by :show quickstart to display 2-5 lines of help on how to
     815start using the protocol. The result from every function registered
     816with this hook will be appended and displayed in an admin message,
     817with zephyr formatting parsed. The format should be
     818"@b(Protocol:)\nSome text.\nMore text.\n"
     819
    812820=back
    813821
     
    818826our @EXPORT_OK = qw($startup $shutdown
    819827                    $receiveMessage $newMessage
    820                     $mainLoop $getBuddyList);
     828                    $mainLoop $getBuddyList
     829                    $getQuickstart);
    821830
    822831our %EXPORT_TAGS = (all => [@EXPORT_OK]);
     
    828837our $mainLoop = BarnOwl::Hook->new;
    829838our $getBuddyList = BarnOwl::Hook->new;
     839our $getQuickstart = BarnOwl::Hook->new;
    830840
    831841# Internal startup/shutdown routines called by the C code
     
    921931}
    922932
     933sub _get_quickstart {
     934    return join("\n", $getQuickstart->run);
     935}
     936
    923937################################################################################
    924938# Built-in perl styles
Note: See TracChangeset for help on using the changeset viewer.