diff --git a/build.xml b/build.xml index ed7802b1d..fc495f7cc 100644 --- a/build.xml +++ b/build.xml @@ -479,7 +479,7 @@ docletpathref="doclet.classpath" classpathref="external.dependencies" classpath="${java.classes}" - additionalparam="-private -build-timestamp "${build.timestamp}" -absolute-version ${build.version} -out ${basedir}/${resource.path} -quiet -J-Xdebug -J-Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=5005"> + additionalparam="-private -build-timestamp "${build.timestamp}" -absolute-version ${build.version} -quiet -J-Xdebug -J-Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=5005"> diff --git a/public/java/src/org/broadinstitute/sting/utils/help/GATKDoclet.java b/public/java/src/org/broadinstitute/sting/utils/help/GATKDoclet.java index 3b581e77b..c1dd843ac 100644 --- a/public/java/src/org/broadinstitute/sting/utils/help/GATKDoclet.java +++ b/public/java/src/org/broadinstitute/sting/utils/help/GATKDoclet.java @@ -48,18 +48,21 @@ public class GATKDoclet extends ResourceBundleExtractorDoclet { public static class DocWorkUnit implements Comparable { // known at the start - String name, filename, group; - DocumentedGATKFeatureHandler handler; - ClassDoc classDoc; - Class clazz; - DocumentedGATKFeature annotation; + final String name, filename, group; + final DocumentedGATKFeatureHandler handler; + final ClassDoc classDoc; + final Class clazz; + final DocumentedGATKFeature annotation; + final String buildTimestamp, absoluteVersion; // set by the handler String summary; Map forTemplate; - public DocWorkUnit(DocumentedGATKFeature annotation, String name, String filename, String group, - DocumentedGATKFeatureHandler handler, ClassDoc classDoc, Class clazz) { + public DocWorkUnit(String name, String filename, String group, + DocumentedGATKFeature annotation, DocumentedGATKFeatureHandler handler, + ClassDoc classDoc, Class clazz, + String buildTimestamp, String absoluteVersion) { this.annotation = annotation; this.name = name; this.filename = filename; @@ -67,6 +70,8 @@ public class GATKDoclet extends ResourceBundleExtractorDoclet { this.handler = handler; this.classDoc = classDoc; this.clazz = clazz; + this.buildTimestamp = buildTimestamp; + this.absoluteVersion = absoluteVersion; } public void setHandlerContent(String summary, Map forTemplate) { @@ -116,9 +121,10 @@ public class GATKDoclet extends ResourceBundleExtractorDoclet { DocumentedGATKFeatureHandler handler = createHandler(doc, feature); if ( handler != null && handler.shouldBeProcessed(doc) ) { String filename = handler.getDestinationFilename(doc); - DocWorkUnit unit = new DocWorkUnit(feature, - doc.name(), filename, feature.groupName(), - handler, doc, clazz ); + DocWorkUnit unit = new DocWorkUnit(doc.name(), + filename, feature.groupName(), + feature, handler, doc, clazz, + buildTimestamp, absoluteVersion); m.add(unit); } } @@ -130,6 +136,7 @@ public class GATKDoclet extends ResourceBundleExtractorDoclet { protected void processDocs(RootDoc rootDoc, PrintStream ignore) { // setup the global access to the root this.rootDoc = rootDoc; + super.loadData(rootDoc, false); try { // basic setup @@ -239,6 +246,8 @@ public class GATKDoclet extends ResourceBundleExtractorDoclet { root.put("data", data); root.put("groups", groups); + root.put("timestamp", buildTimestamp); + root.put("version", absoluteVersion); return root; } diff --git a/public/java/src/org/broadinstitute/sting/utils/help/GenericDocumentationHandler.java b/public/java/src/org/broadinstitute/sting/utils/help/GenericDocumentationHandler.java index cbe526793..777a498c0 100644 --- a/public/java/src/org/broadinstitute/sting/utils/help/GenericDocumentationHandler.java +++ b/public/java/src/org/broadinstitute/sting/utils/help/GenericDocumentationHandler.java @@ -88,6 +88,8 @@ public class GenericDocumentationHandler extends DocumentedGATKFeatureHandler { summaryBuilder.append(tag.text()); root.put("summary", summaryBuilder.toString()); root.put("description", classdoc.commentText()); + root.put("timestamp", toProcess.buildTimestamp); + root.put("version", toProcess.absoluteVersion); for(Tag tag: classdoc.tags()) { root.put(tag.name(), tag.text()); diff --git a/settings/helpTemplates/common.html b/settings/helpTemplates/common.html index 615210e07..ebc060d0a 100644 --- a/settings/helpTemplates/common.html +++ b/settings/helpTemplates/common.html @@ -4,3 +4,12 @@ + +<#macro headerInfo> +

See also Main index | GATK wiki | GATK support forum

+

GATK version ${version} built at ${timestamp}.

+ + +<#macro footerInfo> + + diff --git a/settings/helpTemplates/generic.index.template.html b/settings/helpTemplates/generic.index.template.html index a6ea3da86..56eae97c2 100644 --- a/settings/helpTemplates/generic.index.template.html +++ b/settings/helpTemplates/generic.index.template.html @@ -25,9 +25,12 @@ <@makeHeader title="GATK documentation index"/>

GATK documentation index

+ <@headerInfo /> <#list groups as group> <@emitGroup group=group/> + + <@footerInfo /> diff --git a/settings/helpTemplates/generic.template.html b/settings/helpTemplates/generic.template.html index d029cf8a5..11823687d 100644 --- a/settings/helpTemplates/generic.template.html +++ b/settings/helpTemplates/generic.template.html @@ -45,7 +45,8 @@ <@makeHeader title="${name} documentation"/> -

${name}

+

${name}

+ <@headerInfo />

Brief summary

${summary} <#if author??> @@ -104,5 +105,7 @@ <@argumentDetails arg=arg/> + + <@footerInfo /> diff --git a/settings/helpTemplates/style.css b/settings/helpTemplates/style.css index e513bb527..1b3067044 100644 --- a/settings/helpTemplates/style.css +++ b/settings/helpTemplates/style.css @@ -14,6 +14,11 @@ p, ul, ol, dl, dt, dd, td font-size: 12pt; } +p.version, p.see-also +{ + font-size: 6pt; +} + dt { padding-bottom: 6pt; @@ -35,7 +40,7 @@ a:visited h1, h2, h3 { font-family: Corbel, Arial, Helvetica, Sans-Serif; - font-weight: lighter; + font-weight: bold; text-align: left; color: #bac8da; }