From ab4caf13427b4378935829eccaea2f273f45350d Mon Sep 17 00:00:00 2001
From: JT Smith <jt@plainblack.com>
Date: Sun, 14 May 2006 04:53:13 +0000
Subject: [PATCH] help supports inheritance

---
 docs/changelog/6.x.x.txt                 |  3 +++
 docs/upgrades/templates-6.99.0/help.tmpl |  4 ++--
 lib/WebGUI/Help/Asset_Folder.pm          | 12 ++++-------
 lib/WebGUI/Help/Asset_Wobject.pm         |  8 +++----
 lib/WebGUI/Help/_help.skeleton           | 11 ++++++++++
 lib/WebGUI/Operation/Help.pm             | 27 +++++++++++++++++++++++-
 6 files changed, 50 insertions(+), 15 deletions(-)

diff --git a/docs/changelog/6.x.x.txt b/docs/changelog/6.x.x.txt
index bf57600d3..b38a78f8e 100644
--- a/docs/changelog/6.x.x.txt
+++ b/docs/changelog/6.x.x.txt
@@ -20,6 +20,9 @@
  - Added a wiki-like feature that will automatically bring a user to the
    create a page form if they are in admin mode, and click on a link to
    a page that doesn't exist yet.
+ - Help is now capable of using inheritance.
+ - Template help can/should now be broken out as seperate fields going
+   forward.
  - Many changes for better XHTML compliance.
  - Refactored admin bar to be more dynamic.
  - Removed start/end dates from assets in favor of the workflow system.
diff --git a/docs/upgrades/templates-6.99.0/help.tmpl b/docs/upgrades/templates-6.99.0/help.tmpl
index 39a9380f1..5b5047d90 100644
--- a/docs/upgrades/templates-6.99.0/help.tmpl
+++ b/docs/upgrades/templates-6.99.0/help.tmpl
@@ -6,7 +6,7 @@
 	<tmpl_loop fields>
    		<dt><tmpl_var title></dt>
 	        <dd><tmpl_var description>
-			<tmpl_if uiLevel> <br /><i><tmpl_var uiLevelLabel>:</i><tmpl_var uiLevel> </tmpl_if>
+			<tmpl_if uiLevel> <br /><i><tmpl_var uiLevelLabel>:</i><tmpl_var uiLevel><br /> </tmpl_if>
 		</dd>
         </tmpl_loop>
 </dl>
@@ -39,7 +39,7 @@
 
 ~~~
 <style type="text/css">
-dt {
+dd {
 	margin-bottom: 15px;
 }
 
diff --git a/lib/WebGUI/Help/Asset_Folder.pm b/lib/WebGUI/Help/Asset_Folder.pm
index d73e49ca5..7513aee1c 100644
--- a/lib/WebGUI/Help/Asset_Folder.pm
+++ b/lib/WebGUI/Help/Asset_Folder.pm
@@ -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',
diff --git a/lib/WebGUI/Help/Asset_Wobject.pm b/lib/WebGUI/Help/Asset_Wobject.pm
index 0e7564650..88f786d46 100644
--- a/lib/WebGUI/Help/Asset_Wobject.pm
+++ b/lib/WebGUI/Help/Asset_Wobject.pm
@@ -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'
diff --git a/lib/WebGUI/Help/_help.skeleton b/lib/WebGUI/Help/_help.skeleton
index b55e53be0..a89044c44 100644
--- a/lib/WebGUI/Help/_help.skeleton
+++ b/lib/WebGUI/Help/_help.skeleton
@@ -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',
diff --git a/lib/WebGUI/Operation/Help.pm b/lib/WebGUI/Operation/Help.pm
index e150577bd..f823b67de 100644
--- a/lib/WebGUI/Operation/Help.pm
+++ b/lib/WebGUI/Operation/Help.pm
@@ -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
 			});
 	}