From 1d9151e68b9a3eef617427dc45ad34b87d36b410 Mon Sep 17 00:00:00 2001
From: Colin Kuskie <colink@perldreamer.com>
Date: Sat, 1 Jul 2006 02:24:36 +0000
Subject: [PATCH] documentation for the show running workflows screen

---
 lib/WebGUI/Help/Workflow.pm         | 17 +++++++++++++++++
 lib/WebGUI/Operation/Workflow.pm    |  3 ++-
 lib/WebGUI/i18n/English/Workflow.pm | 12 ++++++++++--
 3 files changed, 29 insertions(+), 3 deletions(-)

diff --git a/lib/WebGUI/Help/Workflow.pm b/lib/WebGUI/Help/Workflow.pm
index d3af5b12a..ccd32297a 100644
--- a/lib/WebGUI/Help/Workflow.pm
+++ b/lib/WebGUI/Help/Workflow.pm
@@ -7,6 +7,23 @@ our $HELP = {
 		fields => [
 		],
 		related => [
+			{
+				tag => 'show running workflows',
+				namespace => 'Workflow'
+			},
+		],
+	},
+
+	'show running workflows' => {
+		title => 'show running workflows',
+		body => 'show running workflows body',
+		fields => [
+		],
+		related => [
+			{
+				tag => 'manage workflows',
+				namespace => 'Workflow'
+			},
 		],
 	},
 
diff --git a/lib/WebGUI/Operation/Workflow.pm b/lib/WebGUI/Operation/Workflow.pm
index 23bd33b9a..61d393b43 100644
--- a/lib/WebGUI/Operation/Workflow.pm
+++ b/lib/WebGUI/Operation/Workflow.pm
@@ -421,7 +421,8 @@ sub www_showRunningWorkflows {
 	my $ac = WebGUI::AdminConsole->new($session,"workflow");
 	$ac->addSubmenuItem($session->url->page("op=addWorkflow"), $i18n->get("add a new workflow"));
 	$ac->addSubmenuItem($session->url->page("op=manageWorkflows"), $i18n->get("manage workflows"));
-	return $ac->render($output);
+	$ac->setHelp('show running workflows', 'Workflow');
+	return $ac->render($output, 'show running workflows');
 }
 
 
diff --git a/lib/WebGUI/i18n/English/Workflow.pm b/lib/WebGUI/i18n/English/Workflow.pm
index e25b35b3a..ae0c43da9 100644
--- a/lib/WebGUI/i18n/English/Workflow.pm
+++ b/lib/WebGUI/i18n/English/Workflow.pm
@@ -130,9 +130,17 @@ our $I18N = {
 	'manage workflow help body' => {
 		message => q|
 <p>This is the master screen for managing workflows.  All configured workflows are shown in a table by the title of the workflow, along with icons to edit or delete the workflow and the workflow's status, enabled or disabled. Links are provided to add new workflows and to show which, if any, workflows are presently running.</p>
-<p>The manage workflow screen is accessed from the Admin Console.</p>
+<p>The Manage Workflow screen is accessed from the Admin Console.</p>
 |,
-		lastUpdated => 0,
+		lastUpdated => 1151719637,
+	},
+
+	'show running workflows body' => {
+		message => q|
+<p>This screen can help you debug problems with workflows by showing which workflows are currently running.  The workflows are shown in a table with the name of the workflow, the date it started running.  If the workflow has a defined status, then that status will also be shown, along with the date the workflow's status was last updated.</p>
+<p>The screen will not automatically update.  To update the list of running workflows, reload the page.</p>
+|,
+		lastUpdated => 1151719633,
 	},
 
 	'topicName' => {