gatk-3.8/settings/helpTemplates/generic.template.html

64 lines
1.6 KiB
HTML

<#macro argumentlist name myargs>
<#if myargs?size != 0>
<tr><th colspan="4" align="left">${name}</th></tr>
<#list myargs as arg>
<tr>
<td><a href="#${arg.name}">${arg.name}</a></td>
<td><a href="#${arg.name}">${arg.synonyms}</a></td>
<td>${arg.type}</td>
<td>${arg.summary}</td>
</tr>
<#--
<td>${arg.required}</td>
-->
</#list>
</#if>
</#macro>
<#macro argumentDetails arg>
<h3><a name="${arg.name}">${arg.name} / ${arg.synonyms}</a></h3>
Summary: ${arg.summary}<br>
Attributes: ${arg.attributes}<br>
Type: ${arg.type}<br>
Options: ${arg.options}<br>
Details: ${arg.fulltext}<br>
</#macro>
<html>
<head>
<title>${name} documentation</title>
</head>
<body>
<h1>${name}<h1>
<h2>Summary</h2>
${summary}
<#if author??>
<h2>Author</h2>
${author}
</#if>
<h2>Description</h2>
${description}
<#-- Create the argument summary -->
<h2>Arguments</h2>
<table border="1" cellpadding="2">
<tr>
<th>Name</th>
<th>Synonyms</th>
<th>Type</th>
<th>Summary</th>
</tr>
<@argumentlist name="Required" myargs=arguments.required/>
<@argumentlist name="Optional" myargs=arguments.optional/>
<@argumentlist name="Hidden" myargs=arguments.hidden/>
<@argumentlist name="Depreciated" myargs=arguments.depreciated/>
</table>
<#-- Create the argument details -->
<h2>Argument details</h2>
<#list arguments.all as arg>
<@argumentDetails arg=arg/>
</#list>
</body>
</html>