From: Stephen L Johnson <sjohnson@monsters.org>
Date: Sun, 9 Jul 2000 08:03:27 +0000 (+0000)
Subject: update documenation for new message templates
X-Git-Tag: spong-2_7-alpha7~10
X-Git-Url: http://git.etc.gen.nz/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=50d691501b920d47f2610abb566e51d9aa017091;p=spong.git

update documenation for new message templates
---

diff --git a/pod/spong.message.pod b/pod/spong.message.pod
index 30f0a2b..70fd5eb 100755
--- a/pod/spong.message.pod
+++ b/pod/spong.message.pod
@@ -156,11 +156,68 @@ Rules are checked into order. All matching rules are processed.
 
 =over
 
-I know the format can be a little odd at first and overwhelmng at first, but I
+I know the format can be a little odd at first and overwhelming at first, but I
 chose it because of both its simplicity to work with in the code (I don't have
 to parse anything - Perl does all the work), and because it is easy to extend -
 adding additional attributes is quite straightforward.
 
+=head1 MESSAGE TEMPLATES
+
+Notification messages formats are determined by the templates in the
+C<%TEMPLATES> variable in the F<spong.message> file. Templates are seached
+according to the following order: 'contact:module', 'module', 'contact',
+'DEFAULT'. 
+
+Any text in a template string is added verbatim to the message. The list of
+substituation variables can be added to the template strings.
+
+=over
+
+=item !!HOST!!
+
+Full domain of the system of the event message.
+
+=item !!SHORTHOST!!
+
+The short host name of the system of the event message.
+
+=item !!COLOR!! and !!STATUS!!
+
+The status color ('green', 'yellow', or 'red') of the status message.
+
+=item !!WWWSPONG!!
+
+The $WWWSPONG url variable from the F<spong.conf> configuration variable.
+
+=item !!SUMMARY!!
+
+The summary message field in the status message.
+
+=item !!DETAILED!!
+
+The detailed message field of the status message. The value of this variable
+can be very large and have multple lines of text.
+
+=item !!CURTIME!!
+
+The current system time formatted according to $DATETIMEFMT
+
+=item !!DATE!!
+
+The date of the event message formatted according to $DATEFMT
+
+=item !!TIME!!
+
+The date of the event message formmated according to $TIMEFMT
+
+=item !!DATETIME!!
+
+The date/time of the event message formateed according to $DATETIMEFMT
+
+=back
+
+=head2 Messaging Modules
+
 
 =head1 MATCHING LOGIC