onrannual 1.1 (13mar10)

git-svn-id: svn://tug.org/texlive/trunk@17474 c570f23f-e606-0410-a88d-b1316a301751

5 files changed, 118 insertions, 23 deletions

diff --git a/Master/texmf-dist/doc/latex/onrannual/README b/Master/texmf-dist/doc/latex/onrannual/README
index f94cbde893d..f3865991a32 100644
--- a/Master/texmf-dist/doc/latex/onrannual/README
+++ b/Master/texmf-dist/doc/latex/onrannual/README
@@ -45,7 +45,8 @@ you are responsible for figuring out how to process your documents.
 
 FONTS
 The mathptmx package is used to provide Times as the default text font,
-which provides reasonably compatible math support.
+which provides reasonably compatible math support.  Using XeTeX should
+be possible, but it didn't give a bold title font in my testing.
 
 LICENSE
 LaTeX Project Public License 1.3 or (at your option) any later version.  
@@ -56,4 +57,15 @@ None at this time.  Please include a minimal LaTeX file
 with any bug report.
 
 CONTACT
-This package is maintained by adam.maxwell@pnl.gov
\ No newline at end of file
+This package is maintained by adam.maxwell@pnl.gov
+
+CHANGES
+v1.1 2010-03-13 Bugfix release
+  - Title font is now 14pt instead of 17.22pt
+  - Hyperref is now required
+  - Disable PDF bookmarks
+  - Color hyperlinks blue
+  - Changed leading to conform more closely to ONR requirements
+  - Better documentation of optional and required sections
+  - Added some documentation to the skeleton file
+v1.0 2010-02-13 Initial release
diff --git a/Master/texmf-dist/doc/latex/onrannual/sample.bib b/Master/texmf-dist/doc/latex/onrannual/sample.bib
index 50ded0f6c60..9a64eacba1f 100644
--- a/Master/texmf-dist/doc/latex/onrannual/sample.bib
+++ b/Master/texmf-dist/doc/latex/onrannual/sample.bib
@@ -1,6 +1,10 @@
 %% This BibTeX bibliography file was created using BibDesk.
 %% http://bibdesk.sourceforge.net/
 
+@misc{omitifnone,
+    Key = {{\textcolor{blue}{\textbf{Omit if none.}}}},
+    }
+
 @book{Schlichting:2000,
 	Address = {Berlin},
 	Author = {Schlichting, Herrmann and Gersten, Klaus},
diff --git a/Master/texmf-dist/doc/latex/onrannual/skeleton.pdf b/Master/texmf-dist/doc/latex/onrannual/skeleton.pdf
index 9f761a5de72..a2301a2fc5b 100644
--- a/Master/texmf-dist/doc/latex/onrannual/skeleton.pdf
+++ b/Master/texmf-dist/doc/latex/onrannual/skeleton.pdf
diff --git a/Master/texmf-dist/doc/latex/onrannual/skeleton.tex b/Master/texmf-dist/doc/latex/onrannual/skeleton.tex
index 9cd50b02aeb..98d98e050cb 100644
--- a/Master/texmf-dist/doc/latex/onrannual/skeleton.tex
+++ b/Master/texmf-dist/doc/latex/onrannual/skeleton.tex
@@ -3,16 +3,17 @@
 % provide additional characters
 \usepackage{textcomp}
 
-% bibliography style; customize as appropriate
-\usepackage{natbib}
-\bibliographystyle{apalike}
+% Bibliography style; customize as appropriate, or remove if you don't use
+% BibTeX or have no citations.
+\usepackage[round]{natbib}
 \setlength{\bibhang}{0pt}
 
 % allow graphics inclusion
 \usepackage{graphicx}
 
-% optional: use active URLs in the document
-\usepackage[colorlinks=false, pdfborder={0 0 0}]{hyperref}
+% for highlighting messages
+\usepackage{color}
+
 % optional: use hyperref to add in some PDF metadata
 \hypersetup {
     pdftitle={Ocean Battlespace Sensing (OBS) S\&T Department Annual Report},
@@ -73,24 +74,63 @@ phone: (111) 222-5555     fax: (111) 222-6666     email: \href{mailto:second.aut
 
 %% Meat of the document goes here
 \begin{document}
+    
+% The author prefers apalike, but it doesn't work when the year is missing.
+% This causes problems for the fake citation used to show that the
+% references section is optional.
+\bibliographystyle{abbrvnat}
 
 % print the title/author frontmatter
 \maketitle
 
 \section{LONG-TERM GOALS}
-Briefly identify your top-level goals within which your effort exists. 
+Briefly identify your top-level goals within which your effort exists. The goal of this \LaTeX{}
+document class is to allow creation of annual reports matching the ONR requirements, without using a
+commercial word processor.
 
 \section{OBJECTIVES}
-Scientific or technological objectives of this effort. Demonstrate the use of an itemized list.
-\begin{itemize}
-    \item Objective 1
-    \item Objective 2
-\end{itemize}
+This section should contain the scientific or technological objectives of this effort.
 
 \section{APPROACH}
 Describe your proposed technical approach. Briefly identify the key individuals participating in this work at your own
-or other organizations and the roles they play. Look at the Navier-Stokes equations, as given by
-\citet{Schlichting:2000}:
+or other organizations and the roles they play. In the present document, this section will describe the onrannual
+document class.
+
+The source \LaTeX{} file may be downloaded from
+\href{http://mirror.ctan.org/macros/latex/contrib/onrannual/skeleton.tex}{CTAN}, and it is intended that you modify
+it according to the comments within. In \TeX{} Live 2009, this file may also be found in the
+\url{texmf-dist/doc/latex/onrannual} directory under the top-level \TeX{} Live install directory.
+The onrannual class is a modification of the default article class, and including other styles may cause issues 
+with spacing, particularly around section headings.
+
+In the preamble, a few new commands may be used. The \verb=\awardnumber{N00014-000-0000}= macro is used to
+define the award number, and the optional \verb=\projecturl{\url{http://foo.edu}}= is used to define a
+project URL in the title block. ONR also requires a distribution statement to be inserted in the header
+of the first page, and this is defined with the \verb=\distribution{xxx}= macro, where \verb=xxx= is replaced
+with the appropriate text from the current ONR guidelines.
+
+In general, the standard document macros may be used: \verb=\title{My Report Title}= is used to
+set the title, and \verb=\maketitle= is used after \verb=\begin{document}= to display it.
+Getting the author layout correct is slightly tricky, and one example is demonstrated here:
+{
+\scriptsize
+\begin{verbatim}
+\author{First Author}
+\affil{%
+Academic Institute \\
+Laboratory 1 \\
+Somewhere, WA 11111 \\
+% NOTE: the trailing \\ is required at the end of this last line to separate authors
+phone: (111) 222-3333    fax: (111) 222-4444     email: \href{mailto:first.author@ai.edu}{first.author@ai.edu} \\}
+\end{verbatim}
+}
+
+This author and affiliation block is repeated for successive authors.
+Standard \verb=\section= commands are used for sections, and \verb=\bibliography= may be
+used to generate a bibliography. Subsections are not allowed, and will produce an error.
+
+For other sample content to show usage of math and references, we can look at the 
+Navier-Stokes equations, as given by \citet{Schlichting:2000}:
 
 \begin{equation}
     \rho \frac{\partial D\overrightarrow{v}}{Dt} = \overrightarrow{f} - \mathrm{grad} p + \mathrm{Div} \tau
@@ -140,23 +180,33 @@ that `organization' is, how they are using it, and when it is expected to be use
 already being used or has had acquisition funds committed. Examples are `products' entering acquisition, being used by
 industry, or being used by other S\&T organizations such as DARPA).
 
+%% If none, so state
 \section{RELATED PROJECTS}
+\textcolor{blue}{\textbf{If none, so state.}}
 Identify closely related projects and briefly describe the nature of each relationship (include web links as
 appropriate/available).
 
-% This is a bibliography of all references cited in the report.
+% This is a bibliography of all references cited in the report, assuming use of BibTeX
+%% omit this section if there are none
+\nocite{omitifnone} % hack to display the "omit..." text in the refs list
 \bibliography{sample}
 
+%% omit this section if there are none
 \section{PUBLICATIONS}
+\textcolor{blue}{\textbf{Omit if none.}}
 Listing of publications produced during this effort. If you use Bib\TeX, you can use e.g., bibunits or multibib to
 insert a second set of references, or just copy the contents of a .bbl file here.
 
+%% omit this section if there are none
 \section{PATENTS}
+\textcolor{blue}{\textbf{Omit if none.}}
 List all patent applications / awards for the project not reported in prior year's reports, or that have been previously
 reported but whose status has changed. Note at end of item in brackets whether patent has been ``GRANTED'', for example:
 ``\ldots[granted]'', otherwise ``pending'' will be assumed.
 
+%% omit this section if there are none
 \section{HONORS/AWARDS/PRIZES}
+\textcolor{blue}{\textbf{Omit if none.}}
 List any received and not previously reported. Include recipient, recipient's institution, award `name', and award
 sponsor.
 
diff --git a/Master/texmf-dist/tex/latex/onrannual/onrannual.cls b/Master/texmf-dist/tex/latex/onrannual/onrannual.cls
index a2879f2ca7f..df4f27c4bf0 100644
--- a/Master/texmf-dist/tex/latex/onrannual/onrannual.cls
+++ b/Master/texmf-dist/tex/latex/onrannual/onrannual.cls
@@ -1,5 +1,5 @@
 %% onrannual.cls
-%% Copyright 2009 Adam R. Maxwell
+%% Copyright 2009-2010 Adam R. Maxwell
 %
 % This work may be distributed and/or modified under the
 % conditions of the LaTeX Project Public License, either version 1.3
@@ -21,9 +21,22 @@
 % Developed and maintained by Adam R. Maxwell, adam.maxwell@pnl.gov
 %
 
-\ProvidesClass{onrannual}[2009/11/17 v1.0 ONR annual report document class]
+\ProvidesClass{onrannual}[2010/03/13 v1.1 ONR annual report document class]
 \NeedsTeXFormat{LaTeX2e}
 
+%
+% This class is a modification of the standard article class.  The primary
+% documentation is the skeleton.tex file available at CTAN:
+%
+% http://mirror.ctan.org/macros/latex/contrib/onrannual/skeleton.tex
+%
+% Lacking that, note that the following three new commands are provided:
+%
+% \distribution{xxx} where xxx is the appropriate distribution statement A or B
+% \awardnumber{N00014-xxx} where the argument is your award number
+% \projecturl{\url{http:foo}} which is an optional project URL
+%
+
 %% This technique was copied from latex.ltx, since I couldn't find any documented
 %% way to use commands in the preamble.
 \let\@awardnumber\@empty
@@ -36,6 +49,8 @@
 \def\distribution#1{\def\@distribution{#1}}
 
 % Times and Helvetica
+% XeTeX should be an alternative here, but it wasn't producing a bold title,
+% and I didn't want to spend time figuring out why.
 \RequirePackage{mathptmx}
 
 % Remaining packages require article to be loaded
@@ -53,6 +68,9 @@
 % no paragraph indentation; everything has to be flushleft
 \setlength{\parindent}{\z@}
 
+\fontsize{12}{14}
+\selectfont
+
 % use a single line to separate paragraphs
 \setlength{\parskip}{\baselineskip}
 \RequirePackage{parskip}
@@ -67,14 +85,14 @@
 % This is sort of nasty; we have to adjust skip around the headings, as well
 % as the font size, since the parskip package won't fix them.
 \renewcommand\section{\@startsection {section}{1}{\z@}%
-                                   {-1pt}% no skip above the heading
-                                   {0.01\baselineskip}% if positive, is the skip below; else is the skip to right of run-in
+                                   {-10pt}% no skip above the heading
+                                   {7pt}% if positive, is the skip below; else is the skip to right of run-in
                                    {\normalfont\bfseries\MakeUppercase}} % bold, normal size, uppercase
-
+      
 %% ONR reports don't allow for a subsection or subsubsection, conceptually, so redefine
 %% to print an error message instead of allowing headings that look stupid.                               
 \renewcommand\subsection{\PackageError{onrannual}{Subsections not available for ONR reports}{ONR reports do not include sub or lower sectioning.}}  
-\renewcommand\subsubsection{\subsection}                         
+\renewcommand\subsubsection{\subsection}                        
                                    
 %% Copied \maketitle definition from article.cls.  Most adjustments here are for spacing, but
 %% also to avoid printing the date.
@@ -111,7 +129,7 @@
   \vskip 2\baselineskip
   \let \footnote \thanks
     % title font is 14 pt bold
-    {\Large\bfseries \@title}%
+    {\fontsize{14}{\f@baselineskip}\fontseries{b}\selectfont \@title}%
     \vskip \baselineskip
     \setlength{\affilsep}{\z@}%
     {\begin{tabular}[t]{c}%
@@ -124,9 +142,20 @@
   \par
   \vskip 1.5em}
 
+% ONR wants active hyperlinks colored blue, based on email correspondence, so we'll load it last
+% after mucking about with sectioning
+\RequirePackage[colorlinks=true, pdfborder={0 0 0}, linkcolor=black, citecolor=black, urlcolor=blue, bookmarks=false]{hyperref}
+
 %% now for anything that has to be set as late as possible
 \AtBeginDocument{%
 
+    % this is really gruesome, since I don't understand how natbib changes the heading
+    \@ifpackageloaded{natbib}{%
+      \renewcommand\bibsection{%
+       \section{\refname\@mkboth{\MakeUppercase{\refname}}{\MakeUppercase{\refname}}\vspace{7pt}}%
+      }%
+    }{}%
+      
     % for some reason, they want it to look as if a typewriter was used...
     \raggedright%