aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Guide.pm
diff options
context:
space:
mode:
authorTom Feist <shabble@cowu.be>2010-07-12 20:13:36 +0000
committerTom Feist <shabble@cowu.be>2010-07-12 20:13:36 +0000
commitb0ae07d0e1a750afabce530d23288212ca1fd5b6 (patch)
treec0905e3ac6b4cb2dbe5fb4caaa2abb10bca8f666 /docs/Guide.pm
parentmore reformattingm, added a guide.pm for general stuff (diff)
downloadirssi-scripts-b0ae07d0e1a750afabce530d23288212ca1fd5b6.tar.gz
irssi-scripts-b0ae07d0e1a750afabce530d23288212ca1fd5b6.zip
started marking up signals for auto-generation
Diffstat (limited to 'docs/Guide.pm')
-rw-r--r--docs/Guide.pm16
1 files changed, 13 insertions, 3 deletions
diff --git a/docs/Guide.pm b/docs/Guide.pm
index 78aae10..2f71e1c 100644
--- a/docs/Guide.pm
+++ b/docs/Guide.pm
@@ -37,18 +37,21 @@ network connections or processes, and restore any Irssi modifications made.
=head1 ANATOMY OF A SCRIPT
-In this section, we develop a very simplistic script
+In this section, we develop a very simplistic script and look at the
+necessary code.
=head2 Preamble
=head1 USEFUL THINGS
-=head2 Sharing code between scripts
-
+=head2 Sharing Code Between Scripts
There are 2 main ways for scripts to communicate, either via emitting and
handling Irssi signals, or by calling functions from one another directly.
+=head3 Using Signals
+
+=head3 Using Functions
=head2 If In Doubt, Dump!
@@ -63,6 +66,13 @@ Dump perl object (e.g. C</dump Irssi::active_win>):
/alias DUMP script exec use Data::Dumper\; print Data::Dumper->new([\\$0-])->Dump
+=head2 Making Script Look Native
+
+=head3 Provide Help
+
+=head3 Use Tab Completion
+
+=head3 Use Settings for Customisation
=head1 OTHER RESOURCES