Added a tab in the Help table of contents for Workflow related

docs.  Reworked all the workflow activity docs to support this.
This commit is contained in:
Colin Kuskie 2006-07-02 18:24:07 +00:00
parent 8515db2311
commit 7ec8da234d
59 changed files with 71 additions and 62 deletions

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_ArchiveOldThreads;
our $HELP = {
'add/edit archive old threads' => {
title => 'topicName',
title => 'activityName',
body => 'archive old threads body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_CacheEMSPrereqs;
our $HELP = {
'cache ems prereqs' => {
title => 'topicName',
title => 'activityName',
body => 'cache ems prereqs body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_CleanDatabaseCache;
our $HELP = {
'clean database cache' => {
title => 'topicName',
title => 'activityName',
body => 'clean database cache body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_CleanFileCache;
our $HELP = {
'clean file cache' => {
title => 'topicName',
title => 'activityName',
body => 'clean file cache body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_CleanLoginHistory;
our $HELP = {
'clean login history' => {
title => 'topicName',
title => 'activityName',
body => 'clean login history body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_CleanTempStorage;
our $HELP = {
'clean temp storage' => {
title => 'topicName',
title => 'activityName',
body => 'clean temp storage body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_CommitVersionTag;
our $HELP = {
'commit version tag' => {
title => 'topicName',
title => 'activityName',
body => 'commit version tag body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_CreateCronJob;
our $HELP = {
'create cron job' => {
title => 'topicName',
title => 'activityName',
body => 'create cron job body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_DecayKarma;
our $HELP = {
'decay karma' => {
title => 'topicName',
title => 'activityName',
body => 'decay karma body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_DeleteExpiredSessions;
our $HELP = {
'delete expired sessions' => {
title => 'topicName',
title => 'activityName',
body => 'delete expired sessions body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_ExpireGroupings;
our $HELP = {
'expire groupings' => {
title => 'topicName',
title => 'activityName',
body => 'expire groupings body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_ExpireSubscriptionCodes;
our $HELP = {
'expire subscription codes' => {
title => 'topicName',
title => 'activityName',
body => 'expire subscription codes body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_ExportVersionTagToHtml;
our $HELP = {
'export version tag to html' => {
title => 'topicName',
title => 'activityName',
body => 'export version tag to html body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_GetCsPost;
our $HELP = {
'get cs post' => {
title => 'topicName',
title => 'activityName',
body => 'get cs post body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_NotifyAboutUser;
our $HELP = {
'notify about user' => {
title => 'topicName',
title => 'activityName',
body => 'notify about user body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_NotifyAboutVersionTag;
our $HELP = {
'notify about version tag' => {
title => 'topicName',
title => 'activityName',
body => 'notify about version tag body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_ProcessRecurringPayments;
our $HELP = {
'process recurring payments' => {
title => 'topicName',
title => 'activityName',
body => 'process recurring payments body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_PurgeOldAssetRevisions;
our $HELP = {
'purge old asset revisions' => {
title => 'topicName',
title => 'activityName',
body => 'purge old asset revisions body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_PurgeOldTrash;
our $HELP = {
'purge old trash' => {
title => 'topicName',
title => 'activityName',
body => 'purge old trash body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_RequestApprovalForVersionTag;
our $HELP = {
'request approval for version tag' => {
title => 'topicName',
title => 'activityName',
body => 'request approval for version tag body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_RollbackVersionTag;
our $HELP = {
'rollback version tag' => {
title => 'topicName',
title => 'activityName',
body => 'rollback version tag body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_RunCommandAsUser;
our $HELP = {
'run command as user' => {
title => 'topicName',
title => 'activityName',
body => 'run command as user body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_SendQueuedMailMessages;
our $HELP = {
'send queued mail messages' => {
title => 'topicName',
title => 'activityName',
body => 'send queued mail messages body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_SummarizePassiveProfileLog;
our $HELP = {
'summarize passive profile log' => {
title => 'topicName',
title => 'activityName',
body => 'summarize passive profile log body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_SyncProfilesToLdap;
our $HELP = {
'sync profiles to ldap' => {
title => 'topicName',
title => 'activityName',
body => 'sync profiles to ldap body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_TrashClipboard;
our $HELP = {
'trash clipboard' => {
title => 'topicName',
title => 'activityName',
body => 'trash clipboard body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_TrashExpiredEvents;
our $HELP = {
'trash expired events' => {
title => 'topicName',
title => 'activityName',
body => 'trash expired events body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_TrashVersionTag;
our $HELP = {
'trash version tag' => {
title => 'topicName',
title => 'activityName',
body => 'trash version tag body',
isa => [
{

View file

@ -2,7 +2,7 @@ package WebGUI::Help::Workflow_Activity_UnlockVersionTag;
our $HELP = {
'unlock version tag' => {
title => 'topicName',
title => 'activityName',
body => 'unlock version tag body',
isa => [
{

View file

@ -207,6 +207,9 @@ sub _getHelpName {
elsif ($file =~ /^Macro_/) {
$helpName = 'macroName';
}
elsif ($file =~ /^Workflow_Activity_/) {
$helpName = 'activityName';
}
else {
$helpName = 'topicName';
}
@ -261,7 +264,7 @@ A scalar ref to the array of data that will be broken into columns.
sub _columnar {
my ($session, $columns, $list) = @_;
my @entries = @{ $list };
my $fraction = round(@entries/3 + 0.50);
my $fraction = round(@entries/$columns + 0.50);
my $output = '<tr><td valign="top">';
@entries = sort { $a->[0] cmp $b->[0] } @entries;
my $i = 0;
@ -431,21 +434,27 @@ sub www_viewHelpTOC {
label => $i18n->get('topicName', 'Macros'),
uiLevel => 1,
},
workf => {
label => $i18n->get('topicName', 'Workflow'),
uiLevel => 1,
},
);
my $i;
my @files = _getHelpFilesList($session,);
my %entries;
my $tabForm = WebGUI::TabForm->new($session, \%tabs);
foreach my $fileSet (@files) {
my $file = $fileSet->[1];
##This whole sorting routine sucks and should be replaced
my $tab = lc substr $file, 0, 5;
if (exists $tabs{$tab} or $tab eq "wobje") {
if (exists $tabs{$tab} or $tab eq "wobje" or $tab eq "workf") {
push @{ $entries{$tab} } , [_getHelpName($session,$file), $file];
}
else {
push @{ $entries{'other'} }, [_getHelpName($session,$file), $file];
}
}
my $tabForm = WebGUI::TabForm->new($session, \%tabs);
foreach my $tab ( keys %tabs ) {
my $tabPut = '<table width="100%" class="content"><tr><td valign="top">';
$tabPut .= _columnar($session, 3, $entries{$tab});

View file

@ -1,7 +1,7 @@
package WebGUI::i18n::English::Workflow_Activity_ArchiveOldThreads;
our $I18N = {
'topicName' => {
'activityName' => {
message => q|Archive Old Threads|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -1,7 +1,7 @@
package WebGUI::i18n::English::Workflow_Activity_CacheEMSPrereqs;
our $I18N = {
'topicName' => {
'activityName' => {
message => q|Cache EMS Prerequisites|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -19,7 +19,7 @@ our $I18N = {
lastUpdated => 0,
},
'topicName' => {
'activityName' => {
message => q|Clean Database Cache|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -19,7 +19,7 @@ our $I18N = {
lastUpdated => 0,
},
'topicName' => {
'activityName' => {
message => q|Clean File Cache|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -13,7 +13,7 @@ our $I18N = {
lastUpdated => 0,
},
'topicName' => {
'activityName' => {
message => q|Clean Login History|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -13,7 +13,7 @@ our $I18N = {
lastUpdated => 0,
},
'topicName' => {
'activityName' => {
message => q|Clean Temp Storage|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -2,7 +2,7 @@ package WebGUI::i18n::English::Workflow_Activity_CommitVersionTag;
our $I18N = {
'topicName' => {
'activityName' => {
message => q|Commit Version Tag|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -2,7 +2,7 @@ package WebGUI::i18n::English::Workflow_Activity_CreateCronJob;
our $I18N = {
'topicName' => {
'activityName' => {
message => q|Create Cron Job|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -25,7 +25,7 @@ our $I18N = {
lastUpdated => 0,
},
'topicName' => {
'activityName' => {
message => q|Decay Karma|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -1,7 +1,7 @@
package WebGUI::i18n::English::Workflow_Activity_DeleteExpiredSessions;
our $I18N = {
'topicName' => {
'activityName' => {
message => q|Delete Expired Sessions|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -1,7 +1,7 @@
package WebGUI::i18n::English::Workflow_Activity_ExpireGroupings;
our $I18N = {
'topicName' => {
'activityName' => {
message => q|Expire Groupings|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -1,7 +1,7 @@
package WebGUI::i18n::English::Workflow_Activity_ExpireSubscriptionCodes;
our $I18N = {
'topicName' => {
'activityName' => {
message => q|Expire Subscription Codes|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -2,7 +2,7 @@ package WebGUI::i18n::English::Workflow_Activity_ExportVersionTagToHtml;
our $I18N = {
'topicName' => {
'activityName' => {
message => q|Export Version Tag to HTML|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -1,7 +1,7 @@
package WebGUI::i18n::English::Workflow_Activity_GetCsPost;
our $I18N = {
'topicName' => {
'activityName' => {
message => q|Get Collaboration System Posts from Email|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -37,7 +37,7 @@ our $I18N = {
lastUpdated => 0,
},
'topicName' => {
'activityName' => {
message => q|Notify About User|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -1,7 +1,7 @@
package WebGUI::i18n::English::Workflow_Activity_NotifyAboutVersionTag;
our $I18N = {
'topicName' => {
'activityName' => {
message => q|Notify About Version Tag|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -2,7 +2,7 @@ package WebGUI::i18n::English::Workflow_Activity_ProcessRecurringPayments;
our $I18N = {
'topicName' => {
'activityName' => {
message => q|Process Recurring Payments|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -2,7 +2,7 @@ package WebGUI::i18n::English::Workflow_Activity_PurgeOldAssetRevisions;
our $I18N = {
'topicName' => {
'activityName' => {
message => q|Purge Old Asset Revisions|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -2,7 +2,7 @@ package WebGUI::i18n::English::Workflow_Activity_PurgeOldTrash;
our $I18N = {
'topicName' => {
'activityName' => {
message => q|Purge Old Trash|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -2,7 +2,7 @@ package WebGUI::i18n::English::Workflow_Activity_RequestApprovalForVersionTag;
our $I18N = {
'topicName' => {
'activityName' => {
message => q|Request Approval For Version Tag|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -2,7 +2,7 @@ package WebGUI::i18n::English::Workflow_Activity_RollbackVersionTag;
our $I18N = {
'topicName' => {
'activityName' => {
message => q|Rollback Version Tag|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -13,7 +13,7 @@ our $I18N = {
lastUpdated => 0,
},
'topicName' => {
'activityName' => {
message => q|Run Command As User|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -1,7 +1,7 @@
package WebGUI::i18n::English::Workflow_Activity_SendQueuedMailMessages;
our $I18N = {
'topicName' => {
'activityName' => {
message => q|Send Queued Mail Messages|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -1,7 +1,7 @@
package WebGUI::i18n::English::Workflow_Activity_SummarizePassiveProfileLog;
our $I18N = {
'topicName' => {
'activityName' => {
message => q|Summarize Passive Profile Log|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -1,7 +1,7 @@
package WebGUI::i18n::English::Workflow_Activity_SyncProfilesToLdap;
our $I18N = {
'topicName' => {
'activityName' => {
message => q|Sync Profiles To LDAP|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -13,7 +13,7 @@ our $I18N = {
lastUpdated => 0,
},
'topicName' => {
'activityName' => {
message => q|Empty Clipboard to Trash|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -2,7 +2,7 @@ package WebGUI::i18n::English::Workflow_Activity_TrashExpiredEvents;
our $I18N = {
'topicName' => {
'activityName' => {
message => q|Trash Expired Events|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -2,7 +2,7 @@ package WebGUI::i18n::English::Workflow_Activity_TrashVersionTag;
our $I18N = {
'topicName' => {
'activityName' => {
message => q|Trash Version Tag|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,

View file

@ -2,7 +2,7 @@ package WebGUI::i18n::English::Workflow_Activity_UnlockVersionTag;
our $I18N = {
'topicName' => {
'activityName' => {
message => q|Unlock Version Tag|,
context => q|The name of this workflow activity.|,
lastUpdated => 0,