oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Since the topical view of the Help has gone away, the TOC labels

Browse source 
are no longer required in the i18n files.  Remove the test and
subroutine from Operation/Help.pm.
This commit is contained in:
Colin Kuskie 2008-05-30 07:22:26 +00:00
parent 844c39e321
commit 9e1cc24271
3 changed files with 0 additions and 75 deletions
Download patch file Download diff file Expand all files Collapse all files

27
lib/WebGUI/Operation/Help.pm
View file

@ -214,33 +214,6 @@ sub _getHelpFilesList {
#-------------------------------------------------------------------
=head2 _getHelpName ( $session, $file )
To support the table of contents, all WebGUI help files have a corresponding
entry in the i18n file for the name of the chapter. This utility routine
will fetch the correct i18n name for the chapter.
=cut
sub _getHelpName {
my $session = shift;
my $file = shift;
my $helpName;
if ($file =~ /^Asset_/) {
$helpName = 'assetName';
}
elsif ($file =~ /^Macro_/) {
$helpName = 'macroName';
}
else {
$helpName = 'topicName';
}
my $i18n = WebGUI::International->new($session);
return $i18n->get($helpName,$file);
}
#-------------------------------------------------------------------
=head2 _related ( $session, $related )
Utility routine for returning a list of topics related the the current help

10
lib/WebGUI/i18n/English/_i18n.skeleton
View file

@ -15,16 +15,6 @@ our $I18N = { ##hashref of hashes
context => q|Provide some context to let the translator know what this message is used for.|
},
#If the help file documents an Asset, it must include an assetName key
#If the help file documents an Macro, it must include an macroName key
#If the help file documents a Workflow Activity, it must include an activityName key
#If the help file documents a Template Parser, it must include an templateParserName key
#For all other types, use topicName
'assetName' => {
message => q|My Asset|,
lastUpdated => 1131394072,
},
};
1;

38
t/Help/toc.t
View file

@ -1,38 +0,0 @@
#-------------------------------------------------------------------
# WebGUI is Copyright 2001-2008 Plain Black Corporation.
#-------------------------------------------------------------------
# Please read the legal notices (docs/legal.txt) and the license
# (docs/license.txt) that came with this distribution before using
# this software.
#-------------------------------------------------------------------
# http://www.plainblack.com info@plainblack.com
#-------------------------------------------------------------------
use FindBin;
use strict;
use lib "$FindBin::Bin/../lib";
use WebGUI::Test;
use WebGUI::Session;
use WebGUI::Operation::Help;
use WebGUI::International;
use Data::Dumper;
#The goal of this test is to make sure that all required labels
#for the help system exist.
use Test::More; # increment this value for each test you create
my $numTests = 0;
my $session = WebGUI::Test->session;
my @helpFileSet = WebGUI::Operation::Help::_getHelpFilesList($session);
$numTests = scalar @helpFileSet;
plan tests => $numTests;
foreach my $fileSet (@helpFileSet) {
my $file = $fileSet->[1];
ok(WebGUI::Operation::Help::_getHelpName($session, $file), "Missing label for $file");
}