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

Implement multiple inheritance in Help, allowing variables, fields and related

Browse source 
topics to be inherited from multiple entries.  Operation/Help now also gives
the help hash a default ISA array, to make downstream processing by tests and
documentation compilers easier.
Convert existing Help entries that already used ISA to have an array ref
instead of a singular hash ref.  Also update the Help skeleton to show
the new syntax.
This commit is contained in:
Colin Kuskie 2006-05-31 04:16:40 +00:00
parent d7450926be
commit b4597e50e5
14 changed files with 105 additions and 39 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -9,11 +9,13 @@ 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 => {
# use the following to inherit stuff other help entries
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',
@ -31,6 +33,7 @@ our $HELP = { ##hashref of hashes
{
name => "template.variable.name",
description => "international tag in this namespace describing this var"
required => "is this variable required for the template to work correctly?"
},
],
related => [ ##This lists other help articles that are related to this one