summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/onrannual/README
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/onrannual/README
Initial commit
Diffstat (limited to 'macros/latex/contrib/onrannual/README')
-rw-r--r--macros/latex/contrib/onrannual/README71
1 files changed, 71 insertions, 0 deletions
diff --git a/macros/latex/contrib/onrannual/README b/macros/latex/contrib/onrannual/README
new file mode 100644
index 0000000000..f3865991a3
--- /dev/null
+++ b/macros/latex/contrib/onrannual/README
@@ -0,0 +1,71 @@
+Documentation for the onrannual LaTeX package.
+
+BACKGROUND
+This class was not developed by ONR, and as such is not an "official"
+document. The Word template and documentation available from ONR is
+still the canonical reference. The formatting requirements are fairly
+simple, but not a great fit for LaTeX's default spacing and sectioning
+behavior.
+
+Formatting is based on the FY09 report guidance provided by ONR at
+http://www.onr.navy.mil/sci_tech/32/reports/annual (Sept 2009). It's
+likely that distribution statement D will need to change year to year,
+but users should do this manually (i.e., the class won't be updated
+for such changes).
+
+If changes in overall formatting/spacing/sectioning are noted, they
+should be incorporated into an updated version of the class file.
+Please notify the maintainer of any inconsistency between the required
+format and the output of this class.
+
+USAGE
+Usage of the package is demonstrated in the file skeleton.tex
+included with the class file. For users of the standard LaTeX
+classes, it should be trivial to use, since only three new commands
+are provided.
+
+REQUIREMENTS
+A working TeX installation. The class was developed and tested using
+MacTeX 2009, but any semi-recent TeX Live or MikTeX installation should
+be fine. If you're using teTeX, you're on your own.
+
+PROCESSING
+Usage of pdflatex is recommended, as it produces PDF directly. However,
+producing a DVI and then distilling to PDF via dvips or dvipdfm(x) is
+also supported. Standard usage to process the example .tex file at the
+UNIX command line:
+
+pdflatex skeleton
+bibtex skeleton
+pdflatex skeleton
+pdflatex skeleton
+
+This will vary depending on your platform. If you use a GUI front end,
+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. 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.
+See http://www.latex-project.org/lppl.txt for the latest version.
+
+KNOWN BUGS
+None at this time. Please include a minimal LaTeX file
+with any bug report.
+
+CONTACT
+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