From 59998b8d02d21a2a82a0969b0c5ade0727923433 Mon Sep 17 00:00:00 2001
From: Colin Kuskie <colink@perldreamer.com>
Date: Wed, 24 Oct 2007 02:55:17 +0000
Subject: [PATCH] add documentation for the manage friends template

---
 lib/WebGUI/Help/Friends.pm         | 44 ++++++++++++++++++++
 lib/WebGUI/i18n/English/Friends.pm | 65 ++++++++++++++++++++++++++++++
 2 files changed, 109 insertions(+)
 create mode 100644 lib/WebGUI/Help/Friends.pm

diff --git a/lib/WebGUI/Help/Friends.pm b/lib/WebGUI/Help/Friends.pm
new file mode 100644
index 000000000..3d56708d8
--- /dev/null
+++ b/lib/WebGUI/Help/Friends.pm
@@ -0,0 +1,44 @@
+package WebGUI::Help::Friends;
+
+our $HELP = {
+	'manage friends template' => {
+		title => 'manage friends template title',
+		isa => [
+		],
+		variables => [
+			{
+				name => "formHeader",
+				required => 1,
+			},
+			{
+				name => "subjectForm",
+			},
+			{
+				name => "messageForm",
+			},
+			{
+				name => "removeFriendButton",
+				required => 1,
+			},
+			{
+				name => "friends",
+				required => 1,
+                variables => [
+                    { name => "name", },
+                    { name => "profileUrl", },
+                    { name => "status", },
+                    { name => "checkboxForm", },
+                ],
+			},
+			{
+				name => "formFooter",
+				required => 1,
+			},
+		],
+		related => [
+		],
+	},
+
+};
+
+1;
diff --git a/lib/WebGUI/i18n/English/Friends.pm b/lib/WebGUI/i18n/English/Friends.pm
index c90cbeed8..477a4336b 100644
--- a/lib/WebGUI/i18n/English/Friends.pm
+++ b/lib/WebGUI/i18n/English/Friends.pm
@@ -212,6 +212,71 @@ Thanks,
 		lastUpdated => 1187066104,
 	},
 
+    'manage friends template title' => {
+        message     => q{Manage Friends Template Variables},
+        lastUpdated => 1193193904,
+    },
+
+    'manage friends template title' => {
+        message     => q{Manage Friends Template Variables},
+        lastUpdated => 1193193904,
+    },
+
+    'formHeader' => {
+        message     => q{HTML required to begin the form},
+        lastUpdated => 1193193904,
+    },
+
+    'removeFriendButton' => {
+        message     => q{HTML code for a button that will remove all selected Friends.},
+        lastUpdated => 1193193904,
+    },
+
+    'subjectForm' => {
+        message     => q{HTML code for a text form for the subject of emails to send to your Friends.},
+        lastUpdated => 1193193904,
+    },
+
+    'messageForm' => {
+        message     => q{HTML code for a text form for the body of emails to send to your Friends.},
+        lastUpdated => 1193193904,
+    },
+
+    'sendMessageButton' => {
+        message     => q{HTML code for a button to send an email to selected Friends.},
+        lastUpdated => 1193193904,
+    },
+
+    'formFooter' => {
+        message     => q{HTML code for ending this form.},
+        lastUpdated => 1193193904,
+    },
+
+    'friends' => {
+        message     => q{A loop containing information about friends and form controls for selecting them for .},
+        lastUpdated => 1193193904,
+    },
+
+    'name' => {
+        message     => q{The name of this Friend},
+        lastUpdated => 1193193904,
+    },
+
+    'profileUrl' => {
+        message     => q{The URL to this friend's user profile},
+        lastUpdated => 1193193904,
+    },
+
+    'status' => {
+        message     => q{The user's status, either online (logged in) or offline (logged out)},
+        lastUpdated => 1193193904,
+    },
+
+    'checkboxForm' => {
+        message     => q{HTML code for a checkbox.  This checkbox is used to select the Friend to be deleted, or to send them an email.},
+        lastUpdated => 1193194455,
+    },
+
 };
 
 1;