Improved HTML template generation

- Improved the different templates with the standard appledoc header (merged from rasterize/appledoc). - Added the projectCompany and projectName template variable to all template document
pilky · Jul 13, 2011 · 5086370 · 5086370
1 parent 2c14b62
commit 5086370
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 8 deletions.
diff --git a/Generating/GBHTMLTemplateVariablesProvider.m b/Generating/GBHTMLTemplateVariablesProvider.m
@@ -102,6 +102,8 @@ - (NSDictionary *)variablesForClass:(GBClassData *)object withStore:(id)store {
 	NSMutableDictionary *result = [NSMutableDictionary dictionary];
 	[result setObject:page forKey:@"page"];
 	[result setObject:object forKey:@"object"];
+	[result setObject:self.settings.projectCompany forKey:@"projectCompany"];
+	[result setObject:self.settings.projectName forKey:@"projectName"];
 	[result setObject:self.settings.stringTemplates forKey:@"strings"];
 	return result;
 }
@@ -115,6 +117,9 @@ - (NSDictionary *)variablesForCategory:(GBCategoryData *)object withStore:(id)st
 	NSMutableDictionary *result = [NSMutableDictionary dictionary];
 	[result setObject:page forKey:@"page"];
 	[result setObject:object forKey:@"object"];
+	[result setObject:self.settings.projectCompany forKey:@"projectCompany"];
+	[result setObject:self.settings.projectName forKey:@"projectName"];
+
 	[result setObject:self.settings.stringTemplates forKey:@"strings"];
 	return result;
 }
@@ -128,6 +133,8 @@ - (NSDictionary *)variablesForProtocol:(GBProtocolData *)object withStore:(id)st
 	NSMutableDictionary *result = [NSMutableDictionary dictionary];
 	[result setObject:page forKey:@"page"];
 	[result setObject:object forKey:@"object"];
+	[result setObject:self.settings.projectCompany forKey:@"projectCompany"];
+	[result setObject:self.settings.projectName forKey:@"projectName"];
 	[result setObject:self.settings.stringTemplates forKey:@"strings"];
 	return result;
 }
@@ -142,7 +149,10 @@ - (NSDictionary *)variablesForDocument:(GBDocumentData *)object withStore:(id)st
 	NSMutableDictionary *result = [NSMutableDictionary dictionary];
 	[result setObject:page forKey:@"page"];
 	[result setObject:object forKey:@"object"];
+	[result setObject:self.settings.projectCompany forKey:@"projectCompany"];
+	[result setObject:self.settings.projectName forKey:@"projectName"];
 	[result setObject:self.settings.stringTemplates forKey:@"strings"];
+	[self addFooterVarsToDictionary:result];
 	return result;
 }
 
@@ -159,6 +169,9 @@ - (NSDictionary *)variablesForIndexWithStore:(id)store {
 	[result setObject:[self protocolsForIndex] forKey:@"protocols"];
 	[result setObject:[self categoriesForIndex] forKey:@"categories"];
 	[result setObject:self.settings.stringTemplates forKey:@"strings"];
+	[result setObject:self.settings.projectCompany forKey:@"projectCompany"];
+	[result setObject:self.settings.projectName forKey:@"projectName"];
+
 	[self addCustomDocumentWithKey:kGBCustomDocumentIndexDescKey toDictionary:result key:@"indexDescription"];
 	[self registerObjectsUsageForIndexInDictionary:result];
 	return result;
@@ -175,6 +188,9 @@ - (NSDictionary *)variablesForHierarchyWithStore:(id)store {
 	[result setObject:[self protocolsForIndex] forKey:@"protocols"];
 	[result setObject:[self categoriesForIndex] forKey:@"categories"];
 	[result setObject:self.settings.stringTemplates forKey:@"strings"];
+	[result setObject:self.settings.projectCompany forKey:@"projectCompany"];
+	[result setObject:self.settings.projectName forKey:@"projectName"];
+
 	[self registerObjectsUsageForIndexInDictionary:result];
 	return result;
 }
@@ -245,7 +261,14 @@ - (NSString *)pageTitleForProtocol:(GBProtocolData *)object {
 
 - (NSString *)pageTitleForDocument:(GBDocumentData *)object {
 	NSString *template = [self.settings.stringTemplates valueForKeyPath:@"documentPage.titleTemplate"];
-	return [NSString stringWithFormat:template, [[object.nameOfDocument lastPathComponent] stringByDeletingPathExtension]];
+
+	//Remove the -template if any
+	NSString *lastComp=[[object.nameOfDocument lastPathComponent] stringByDeletingPathExtension];
+	NSString *suffix=@"-template";
+	if([lastComp hasSuffix:suffix])
+		lastComp=[lastComp substringToIndex:[lastComp length] - [suffix length]];
+
+	return [NSString stringWithFormat:template, lastComp];
 }
 
 - (NSDictionary *)specificationsForClass:(GBClassData *)object {

diff --git a/Templates/html/document-template.html b/Templates/html/document-template.html
@@ -12,18 +12,30 @@
 		<header id="top_header">
 			<div id="library" class="hideInXcode">
 				{{#page}}<h1><a id="libraryTitle" href="../index.html">{{projectName}} {{strings/objectPage/libraryTitlePostfix}}</a></h1>
-				{{#projectCompanyURL}}<a id="developerHome" href="{{projectCompanyURL}}">{{/projectCompanyURL}}{{projectCompany}}{{#projectCompanyURL}}</a>{{/projectCompanyURL}}{{/page}}
+				<a id="developerHome" href="../index.html">{{projectCompany}}</a>{{/page}}
 			</div>
 
 			<div id="title" role="banner">
-				<h1 class="hideInXcode">{{page/title}}</h1>
+				<h1 class="hideInXcode" id="pageTitleHeader">{{page/title}}</h1>
 			</div>
 			<ul id="headerButtons" role="toolbar"></ul>
 		</header>
 		<article>
 			<a title="{{page/title}}" name="top"></a>
-			<div id="container">	
-				{{#object/comment}}{{#longDescription}}{{>GBCommentComponentsList}}{{/longDescription}}{{/object/comment}}
+			<div id="overview_contents" role="main">
+				<div id="container">	
+					{{#object/comment}}{{#longDescription}}{{>GBCommentComponentsList}}{{/longDescription}}{{/object/comment}}
+				</div>
+				<div id="footer">
+					<hr />
+					<div class="footer-copyright">
+						{{#page}}<p><span class="copyright">&copy; {{copyrightDate}} {{copyrightHolder}}. All rights reserved. (Last updated: {{lastUpdatedDate}})</span>{{/page}}<br />
+						{{#strings/appledocData}}
+						<span class="generator">Generated by <a href="{{homepage}}">{{tool}} {{version}} (build {{build}})</a>.</span></p>
+						{{/strings/appledocData}}
+
+					</div>
+				</div>
 			</div>
 		</article>
 	</body>

diff --git a/Templates/html/hierarchy-template.html b/Templates/html/hierarchy-template.html
@@ -10,7 +10,7 @@
 		<header id="top_header">
 			<div id="library" class="hideInXcode">
 				{{#page}}<h1><a id="libraryTitle" href="index.html">{{projectName}} {{strings/objectPage/libraryTitlePostfix}}</a></h1>
-				<span id="developerHome">{{projectCompany}}</span>{{/page}}
+				<a id="developerHome" href="index.html">{{projectCompany}}</a>{{/page}}
 			</div>
 
 			<div id="title" role="banner">

diff --git a/Templates/html/index-template.html b/Templates/html/index-template.html
@@ -10,7 +10,7 @@
 		<header id="top_header">
 			<div id="library" class="hideInXcode">
 				{{#page}}<h1><a id="libraryTitle" href="index.html">{{projectName}} {{strings/objectPage/libraryTitlePostfix}}</a></h1>
-				<span id="developerHome">{{projectCompany}}</span>{{/page}}
+				<a id="developerHome" href="index.html">{{projectCompany}}</a>{{/page}}
 			</div>
 
 			<div id="title" role="banner">

diff --git a/Templates/html/object-template.html b/Templates/html/object-template.html
@@ -12,7 +12,7 @@
 		<header id="top_header">
 			<div id="library" class="hideInXcode">
 				{{#page}}<h1><a id="libraryTitle" href="../index.html">{{projectName}} {{strings/objectPage/libraryTitlePostfix}}</a></h1>
-				<span id="developerHome">{{projectCompany}}</span>{{/page}}
+				<a id="developerHome" href="../index.html">{{projectCompany}}</a>{{/page}}
 			</div>
 
 			<div id="title" role="banner">