[Dart-dev] [4976] DART/trunk/doc/html/template.html: Sample template file for a doc page with our current incarnation
nancy at ucar.edu
nancy at ucar.edu
Thu Jun 9 14:02:27 MDT 2011
Revision: 4976
Author: nancy
Date: 2011-06-09 14:02:27 -0600 (Thu, 09 Jun 2011)
Log Message:
-----------
Sample template file for a doc page with our current incarnation
of our header info, and snippets of the other parts of the pages
in our current style.
Added Paths:
-----------
DART/trunk/doc/html/template.html
-------------- next part --------------
Added: DART/trunk/doc/html/template.html
===================================================================
--- DART/trunk/doc/html/template.html (rev 0)
+++ DART/trunk/doc/html/template.html 2011-06-09 20:02:27 UTC (rev 4976)
@@ -0,0 +1,346 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+<HTML>
+<HEAD>
+<TITLE>PROGRAM OR MODULE name_of_thing</TITLE>
+<link rel="stylesheet" type="text/css" href="../doc/html/doc.css">
+<link href="../doc/html/dart.ico" rel="shortcut icon" />
+</HEAD>
+
+<!--
+This template is appropriate for a file at the level of DART/dir1/here
+To use at another directory level in the tree, all 4 relative references
+(e.g. ../doc/html/) need to be changed.
+-->
+
+<BODY>
+<A NAME="TOP"></A>
+
+<H1>PROGRM OR MODULE name_of_thing</H1>
+
+<table border=0 summary="" cellpadding=5>
+<tr>
+ <td valign=middle>
+ <img src="../doc/html/Dartboard9.png" alt="DART project logo" height=70 />
+ </td>
+ <td>
+ <P>Jump to <a href="../index.html">DART Documentation Main Index</a><br />
+ <small><small>version information for this file: <br />
+ <!-- version tag follows, do not edit -->
+ $Id$</small></small>
+ </P></td>
+</tr>
+</table>
+
+<A HREF="#Namelist">NAMELIST</A> /
+<A HREF="#ModulesUsed">MODULES USED</A> /
+<A HREF="#Interface">INTERFACES</A> /
+<A HREF="#FilesUsed">FILES</A> /
+<A HREF="#References">REFERENCES</A> /
+<A HREF="#Errors">ERRORS</A> /
+<A HREF="#FuturePlans">PLANS</A> /
+<A HREF="#PrivateComponents">PRIVATE COMPONENTS</A> /
+<A HREF="#Legalese">TERMS OF USE</A>
+
+<!--==================================================================-->
+<!-- End of standard header info, start of specific info -->
+<!--==================================================================-->
+
+<H2>Overview</H2>
+
+<P>
+Explain in general terms what this is.
+</P>
+
+<!--==================================================================-->
+<!-- Description of the namelist -->
+<!--==================================================================-->
+
+<A NAME="Namelist"></A>
+<HR>
+<H2>NAMELIST</H2>
+<P>
+DART namelists are
+always read from file <em class=file>input.nml</em>.
+</P>
+<P>We adhere to the F90 standard of starting a namelist with an ampersand
+'&' and terminating with a slash '/' for all our namelist input.
+Character strings that contain a '/' must be
+enclosed in quotes to prevent them from prematurely terminating the namelist.
+</P>
+<div class=namelist>
+<pre>
+<em class=call>&bob_nml</em>
+ bob1 = 2
+ bob3 = 4,
+/
+</pre>
+</div>
+
+<div class=indent1>
+<!-- Description -->
+
+<P>
+Any comments about the namelist as a whole.
+</P>
+
+<TABLE border=0 cellpadding=3 width=100%>
+<TR><TH align=left>Contents </TH>
+ <TH align=left>Type </TH>
+ <TH align=left>Description </TH></TR>
+
+<TR><!--contents--><TD valign=top>bob1</TD>
+ <!-- type --><TD valign=top>integer</TD>
+ <!--descript--><TD>what it does, what valid values are.
+ Default value is XX</TD></TR>
+
+<!-- repeat until done -->
+</TABLE>
+
+<!--==================================================================-->
+
+<A NAME="ModulesUsed"></A>
+<HR>
+<H2>MODULES USED</H2>
+<PRE>
+types_mod
+utilities_mod
+random_seq_mod
+time_manager_mod
+ensemble_manager_mod
+</PRE>
+
+<!--==================================================================-->
+<!--Note to authors. The first row of the table is different. -->
+<!--==================================================================-->
+
+<A NAME="Interface"></A>
+<HR>
+<H2>PUBLIC INTERFACES</H2>
+
+<!-- see the html programs in DART/doc/html to generate this table -->
+
+<TABLE>
+<TR><TD><em class=call>use adaptive_inflate_mod, only : </em></TD>
+ <TD><A HREF="#tag">subr/function name </A></TD></TR>
+<TR><TD> </TD><TD><A HREF="#tag2">name2</A></TD></TR>
+</TABLE>
+
+<P>
+Optional namelist interface
+<a href="#Namelist"><em class=code>&bob_nml</em></a>
+may be read from file <em class=file>input.nml</em>.
+</P>
+
+<P>
+ A note about documentation style.
+ Optional arguments are enclosed in brackets
+ <em class=optionalcode>[like this]</em>.
+</P>
+
+<!--===================== DESCRIPTION OF A ROUTINE =====================-->
+
+<A NAME="subroutine1"></A>
+<br>
+<div class=routine>
+<em class=call> call subroutine1(arg1, <em class=optionalcode>[, arg2]</em>)</em>
+<pre>
+real(r8), intent(in) :: <em class=code>arg1</em>
+real(r8), optional, intent(in) :: <em class=optionalcode>arg2</em>
+</pre>
+</div>
+
+<div class=indent1>
+<!-- Description -->
+
+<P>
+describe what this subroutine does.
+</P>
+
+<TABLE width=100% border=0 summary="" cellpadding=3>
+<TR><TD valign=top><em class=code>arg1 </em></TD>
+ <TD>Describe arg1.
+ </TD></TR>
+<TR><TD valign=top><em class=optionalcode>arg2 </em></TD>
+ <TD>Describe optional arg2.
+ </TD></TR>
+</TABLE>
+
+</div>
+<br>
+
+
+<!--===================== DESCRIPTION OF A ROUTINE =====================-->
+
+<A NAME="function1"></A>
+<br>
+<div class=routine>
+<em class=call> var = function1(arg1) </em>
+<pre>
+logical, :: <em class=code>function1</em>
+adaptive_inflate_type, intent(in) :: <em class=code>arg1</em>
+</pre>
+</div>
+
+<div class=indent1>
+<!-- Description -->
+
+<P>
+Describe function.
+</P>
+
+<TABLE width=100% border=0 summary="" cellpadding=3>
+<TR><TD valign=top><em class=code>function1 </em></TD>
+ <TD>describe what this function returns
+ </TD></TR>
+<TR><TD valign=top><em class=code>arg1 </em></TD>
+ <TD>describe function argument
+ </TD></TR>
+</TABLE>
+
+</div>
+<br>
+
+<!--=================== DESCRIPTION OF A LOCAL TYPE ==================-->
+
+<A NAME="bob_type"></A>
+<br>
+<div class=type><pre>
+<em class=call>type bob_type</em>
+ private
+ integer :: bob1
+ integer :: bob2
+end type bob_type
+</pre>
+</div>
+
+<div class=indent1>
+<!-- Description -->
+
+<P>
+describe bob
+</P>
+
+<TABLE border=0 cellpadding=3 width=100%>
+<TR><TH align=left>Component </TH>
+ <TH align=left>Description </TH></TR>
+
+<TR><TD valign=top> bob1</TD>
+ <TD> Describe bob1.
+ </TD></TR>
+
+<TR><TD valign=top> bob2</TD>
+ <TD> Describe bob2.
+ </TD></TR>
+
+</TABLE>
+
+</div>
+<br>
+
+<!--==================================================================-->
+<!-- Describe the Files Used by this module. -->
+<!--==================================================================-->
+
+<A NAME="FilesUsed"></A>
+<HR>
+<H2>FILES</H2>
+
+<P>
+describe files used by code
+</P>
+
+
+<!--==================================================================-->
+<!-- Cite references, if need be. -->
+<!--==================================================================-->
+
+<A NAME="References"></A>
+<HR>
+<H2>REFERENCES</H2>
+<ul>
+<li>author, title.
+<span style="font-style: italic;">publication</span>,
+<span style="font-weight: bold;">volume</span>, pages.<br />
+<a href="http://dx.doi.org/nn.yyyy/rest_of_number"
+target="_blank" >
+doi: nn.yyyy/rest_of_number </a></li>
+<br />
+</ul>
+
+<!--==================================================================-->
+<!-- Describe all the error conditions and codes. -->
+<!--==================================================================-->
+
+<A NAME="Errors"></A>
+<HR>
+<H2>ERROR CODES and CONDITIONS</H2>
+<div class=errors>
+<TABLE border=1 cellspacing=1 cellpadding=10 width=100%>
+<TR><TH>Routine</TH><TH>Message</TH><TH>Comment</TH></TR>
+
+<TR><!-- routine --><TD VALIGN=top>subroutine_name</TD>
+ <!-- message --><TD VALIGN=top>error message text
+ </TD>
+ <!-- comment --><TD VALIGN=top>what it means to the end user.
+ </TD>
+</TR>
+
+</TABLE>
+</div>
+
+<H2>KNOWN BUGS</H2>
+<P>
+none at this time
+</P>
+
+<!--==================================================================-->
+<!-- Describe Future Plans. -->
+<!--==================================================================-->
+
+<A NAME="FuturePlans"></A>
+<HR>
+<H2>FUTURE PLANS</H2>
+<P>
+none at this time
+</P>
+
+<!--==================================================================-->
+<!-- PrivateComponents -->
+<!--==================================================================-->
+
+<A NAME="PrivateComponents"></A>
+<HR>
+<H2>PRIVATE COMPONENTS</H2>
+<P>
+no discussion
+</P>
+
+<!--==================================================================-->
+<!-- Legalese & Metadata -->
+<!--==================================================================-->
+
+<A NAME="Legalese"></A>
+<HR>
+<H2>Terms of Use</H2>
+
+<P>
+DART software - Copyright 2004 - 2011 UCAR.<br>
+This open source software is provided by UCAR, "as is",<br>
+without charge, subject to all terms of use at<br>
+<a href="http://www.image.ucar.edu/DAReS/DART/DART_download">
+http://www.image.ucar.edu/DAReS/DART/DART_download</a>
+</P>
+
+<TABLE border=0 cellpadding=0 width=100% summary="">
+<TR><TD valign=top>Contact: </TD><TD> DART core group </TD></TR>
+<TR><TD valign=top>Revision: </TD><TD> $Revision$ </TD></TR>
+<TR><TD valign=top>Source: </TD><TD> $URL$ </TD></TR>
+<TR><TD valign=top>Change Date: </TD><TD> $Date$ </TD></TR>
+<TR><TD valign=top>Change history: </TD><TD> try "svn log" or "svn diff" </TD></TR>
+</TABLE>
+
+<!--==================================================================-->
+
+</BODY>
+</HTML>
Property changes on: DART/trunk/doc/html/template.html
___________________________________________________________________
Added: svn:mime-type
+ text/html
Added: svn:keywords
+ Date Rev Author HeadURL Id
Added: svn:eol-style
+ native
More information about the Dart-dev
mailing list