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

help supports inheritance

Browse source
This commit is contained in:
JT Smith 2006-05-14 04:53:13 +00:00
parent 0673df503d
commit ab4caf1342
6 changed files with 50 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

12
lib/WebGUI/Help/Asset_Folder.pm
View file

@ -5,6 +5,10 @@ our $HELP = {
'folder add/edit' => {
title => 'folder add/edit title',
body => 'folder add/edit body',
isa => {
namespace => "Asset_Wobject",
tag => "wobject add/edit"
},
fields => [
{
title => 'visitor cache timeout',
@ -19,14 +23,6 @@ our $HELP = {
},
],
related => [
{
tag => 'asset fields',
namespace => 'Asset',
},
{
tag => 'wobject add/edit',
namespace => 'Asset_Wobject',
},
{
tag => 'folder template',
namespace => 'Asset_Folder',

8
lib/WebGUI/Help/Asset_Wobject.pm
View file

@ -30,6 +30,10 @@ our $HELP = {
'wobject add/edit' => {
title => '677',
body => '632',
isa => {
tag => 'asset fields',
namespace => 'Asset'
},
fields => [
{
title => '174',
@ -54,10 +58,6 @@ our $HELP = {
},
],
related => [
{
tag => 'asset fields',
namespace => 'Asset'
},
{
tag => 'wobjects using',
namespace => 'Asset_Wobject'

11
lib/WebGUI/Help/_help.skeleton
View file

@ -9,6 +9,11 @@ our $HELP = { ##hashref of hashes
title => 'help article title', #The title and body are looked up in the
body => 'help article title', #i18n file of the same name
# use the following to inherit stuff from another help entry
isa => {
tag => 'some other help tag',
namespace => 'some other help file',
},
fields => [ #This array is used to list hover help for form fields.
{
title => 'form label 1',
@ -22,6 +27,12 @@ our $HELP = { ##hashref of hashes
namespace => 'namespace', #The namespace is called out explicitly
},
],
variables => [
{
name => "template.variable.name",
description => "international tag in this namespace describing this var"
},
],
related => [ ##This lists other help articles that are related to this one
{
tag => 'other help article',

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

@ -46,6 +46,23 @@ sub _load {
my $load = sprintf 'use %-s; $%-s::HELP;', $cmd, $cmd;
my $hash = eval($load);
unless ($@) {
foreach my $tag (keys %{$hash}) {
if ($hash->{$tag}{isa}{namespace}) {
my $other = _load($session, $hash->{$tag}{isa}{namespace});
my $add = $other->{$hash->{$tag}{isa}{tag}}{fields};
@{$hash->{$tag}{fields}} = (@{$hash->{$tag}{fields}}, @{$add});
my $add = $other->{$hash->{$tag}{isa}{tag}}{related};
@{$hash->{$tag}{related}} = (@{$hash->{$tag}{related}}, @{$add});
my $add = $other->{$hash->{$tag}{isa}{tag}}{variables};
foreach my $row (@{$add}) {
push(@{$hash->{$tag}{variables}}, {
name=> $row->{name},
description => $row->{description},
namespace => $row->{namespace} || $hash->{$tag}{isa}{namespace}
});
}
}
}
return $hash
}
else {
@ -260,6 +277,14 @@ sub www_viewHelp {
);
}
#-------------------------------------------------------------------
=head2 _getTemplateVars ( )
Generates help template vars for a template help file.
=cut
sub _getTemplateVars {
my $session = shift;
my $level = shift;
@ -276,7 +301,7 @@ sub _getTemplateVars {
}
push ( @{$template}, {
title => $row->{name},
description=> $i18n->get($row->{description} || $row->{name}),
description=> $i18n->get($row->{description} || $row->{name}, $row->{namespace}),
$label => $indent
});
}