diff --git a/.gitignore b/.gitignore index 0e4326feb5b2829759daf9eeab6700a4a5ad9a25..80c7b33f27160a1e9319177f11d7a1d6a24b6546 100644 --- a/.gitignore +++ b/.gitignore @@ -23,3 +23,12 @@ *.temp *.toc *.fdb_latexmk +ornltm/ornl-template-example.pdf +ornlltr/ornl-ltr-template-example.pdf +ornltm/ornl-tm-template-example.pdf +ornl-report-example.pdf +ornl-letter-class/ORNL-letter-example.pdf +ornl-letter-class/ornl-letter-template.zip +ornl-report-example.synctex(busy) +ornl-report-example.bbl-SAVE-ERROR +.vscode/settings.json diff --git a/README.md b/README.md index f06bb73e545201a07dcd085d16b95a7750e6a575..feebfdf393bb70c3dc50b957ad23985935b060b3 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,51 @@ -# ORNL Technical Memo LaTeX template +# Official ORNL Report Templates for LaTeX -This is a completely overhauled version of the official template available at -the [ORNL branding -page](https://portal09.ornl.gov/sites/cm/branding/sitepages/technical-reports.aspx). -Unlike that template, the `ornltm` class is meant to separate the document -styling from your document's content. You should almost be able to replace the -`\documentclass{ornltm}` line in your file with -`\documentclass{elsarticle}` and submit it as a journal article. +As a fork of Seth Johnson's [ornltm project](https://code.ornl.gov/s3j/ornltm), +these are completely overhauled versions of the official ORNL report templates. +In addition to updating and tweaking the TM class (`ornltm`) and example with +the latest requirements for ORNL technical memos, ORNL TechComms has created two +additional options for SPR and LTR documents and added them to the `ornltm` +class. -## Example +Unlike the old ORNL templates, the `tm`, `spr`, and `ltr` options within the +`ornltm` class are meant to separate the document styling from your document's +content. You can change from TM to SPR simply by changing the document class's +options from `\documentclass[tm]{ornltm}` to `\documentclass[spr]{ornltm}` and +recompiling. -To build the LaTeX example, simply: -```console -$ cd example -$ make -``` +With some tweaking, you can also replace the `\documentclass[tm]{ornltm}` line +in your file with `\documentclass{elsarticle}` and submit it as a journal +article or vice versa. + +## Example -This uses [an advanced Makefile](http://www.bouncingchairs.net/oss) to build -the document, but you can run manually with +To build the LaTeX example, run the following shell command: ```console -$ export TEXINPUTS=$(cd .. && pwd)/ornltm:$TEXINPUTS $ latexmk -pdf ornl-template-example ``` -to get the main document and references. Some of the advanced features like -acronyms, sorted bibliographies, and indexes require extra commands which the -Makefile can do automatically and will not be described here. ## Installation -Once you have cloned this repository, you should install the `ornltm` package. +Once you have cloned this repository, you can install the `ornltm` package. The very primitive Makefile at the root of this repository has a good chance of -working: +working (replace `` with your actual user name): ```console $ make install -cp -rp ornltm /Users/s3j/Library/texmf/tex/latex/ +cp -rp ornltm /Users//Library/texmf/tex/latex/ ``` -at which point your LaTeX distribution should be able to find the class file. -To verify this, make sure that `kpsewhich` can find the ornltm class. +at which point your LaTeX distribution should be able to find the class file. To +verify this, make sure that `kpsewhich` can find the `ornltm` class (again, +replace `` with your actual user name). ```console $ kpsewhich ornltm.cls -/Users/s3j/Library/texmf/tex/latex/ornltm/ornltm.cls +/Users//Library/texmf/tex/latex/ornltm/ornltm.cls ``` ## Documentation The documentation essentially consists of the -[example](./example/ornl-template-example.tex). Commands that must be defined -in the document header are: +[example](ornl-report-example.tex). Commands that must be defined +in the document header are as follows: | Command | Description | | ------------ | ----------------------------------------- | @@ -57,13 +56,15 @@ in the document header are: | `\reportnum{...}` | Report number. | -Optional commands for the document header are: +Optional commands for the document header are as follows: | Command | Description | | ------------ | ----------------------------------------- | | `\reportdraft` | Mark the document as a draft. | | `\reportphoto{...}` | Specify a path to override the cover photo. | -| `\restrict{...}{...}` | Print restrictions instead of "unlimited" | +| `\restrict{...}` | Print restrictions instead of "unlimited." | +| `\cui{...}` | Print CUI header and footer. | +| `\crada{...}` | Print CRADA box and report number on cover. | @@ -83,11 +84,12 @@ set up document styling for the three main sections of the document. - The table of contents titles are not uppercase like in the Microsoft Word template. You can replicate the effect as you would in Microsoft Word by - manually uppercasing section headers. + manually uppercasing section headers. This is an open issue, and a workaround + is being investigated. ## Contributions -To contribute to this LaTeX class, simply follow the standard open source guidelines. Create an account on the -[ORNL GitLab page](https://code.ornl.gov/), fork the [ornltm -repository](https://code.ornl.gov/s3j/ornltm), push a branch to your +To contribute to these LaTeX classes, simply follow the standard open source guidelines. Create an account on the +[ORNL GitLab page](https://code.ornl.gov/), fork the [ORNL templates +repository](https://code.ornl.gov/ornl-tech-comms/official-ornl-latex-templates), push a branch to your repository, and create a pull request. diff --git a/example/Variables.ini b/example/Variables.ini index cefbbedd54741f05d38e6b5e4ae4f45d428337aa..34dc7d549ab843aba7f866b06ebe180f223ff888 100644 --- a/example/Variables.ini +++ b/example/Variables.ini @@ -1,4 +1,4 @@ -onlysources.tex ?= ornl-template-example.tex +onlysources.tex ?= ornl-report-example.tex # These next two lines should only be necessary if you haven't installed the package _saved_TEXINPUTS := ${TEXINPUTS} export TEXINPUTS := .:$(CURDIR)/../ornltm:$(_saved_TEXINPUTS) diff --git a/example/abbreviations.tex b/example/abbreviations.tex new file mode 100644 index 0000000000000000000000000000000000000000..f26c6a8f4ee77c416bbb114471f6880315bbd9f1 --- /dev/null +++ b/example/abbreviations.tex @@ -0,0 +1,31 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% ABBREVIATIONS +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Uses the Acro package called in CLS and styled in the STY. Note that acronyms +%% that aren't used in the document won't be printed in the list. +%% Declare your abbreviations below. + +\DeclareAcronym{doe}{ + short = DOE , + long = US Department of Energy +} + +\DeclareAcronym{nrc}{ + short = NRC , + long = Nuclear Regulatory Commission +} + +\DeclareAcronym{ornl}{ + short = ORNL , + long = Oak Ridge National Laboratory +} + +\DeclareAcronym{tnr}{ + short = TNR , + long = Times New Roman +} + +\DeclareAcronym{tm}{ + short = TM , + long = Technical Memo +} \ No newline at end of file diff --git a/example/ornl-report-example.tex b/example/ornl-report-example.tex new file mode 100644 index 0000000000000000000000000000000000000000..d36f9798a6837faf7b70d7e78f5e8daac519da2c --- /dev/null +++ b/example/ornl-report-example.tex @@ -0,0 +1,652 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% File: ornl-template-example.tex +% Authors: Seth R Johnson, *Sam Crawford, and John Batson +% *Corresponding author, crawfordst.@ornl.gov +% Date: Tuesday March 18, 2025 @ 13:58 +% +% Example of ORNL report template +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Select the appropriate option for a TM [tm], SPR [spr], or LTR [ltr] report. +\documentclass[tm]{ornltm} % Use for TM report. +%\documentclass[spr]{ornltm} % Use for SPR report. +%\documentclass[ltr]{ornltm} % Use for LTR report. + +%% Optional packages that are simply part of this example document +\usepackage{threeparttable} % Table with captions and tablenotes +\usepackage{booktabs} % Toprule, midrule, bottomrule +\usepackage{multirow} % Extend table entries over multiple rows +\usepackage{pdflscape} % Allows landscape pages for wide figures and tables + +%% Bibliography styling. WARNING: the biblatex-chicago package removes the +%% footnote rule. +\usepackage[authordate,autocite=inline,backend=biber,natbib]{biblatex-chicago} % Author-date style +%\usepackage{biblatex} % Numerical style + +\bibliography{example.bib} % Replace with your bib filename. + +%% Use inline small italic blue for comments rather than placing them in the +%% margin. +\definecolor{note}{RGB}{48,96,192} +\renewcommand{\marginpar}[1]{{\small\em\color{note}[#1]}} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% AUTHORSHIP & PUBLISHING +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +%%% AUTHOR'S LIST +%% Note: multiple authors are separated with the \and command. +%% Per ORNL guidance, please keep the number of authors at six or fewer. + +\author{First Author \and Second Author \and Third Author \and Fourth Author \and Fifth Author \and Sixth Author} + +%%% AUTHOR's LIST WITH AFFILIATIONS (SPR ONLY) +%% Define authors with affiliations. Does not apply to TM or LTR. Comment out if not using. +%% Note: multiple authors are separated with the \and command. +%% Per ORNL guidance, please keep the number of authors at six or fewer. + +%\author{First Author\affilnum{1} \and Second Author\affilnum{2} \and Third Author\affilnum{3} \and Fourth Author\affilnum{4} \and Fifth Author\affilnum{5} \and Sixth Author\affilnum{6} \and Seventh Author\affilnum{7} \and Eighth Author\affilnum{8} \and Ninth Author\affilnum{9} \and Tenth Author\affilnum{10}} + +%%% AFFILIATIONS (SPR ONLY) +%% Note: Does not apply to TM or LTR. + +%\affiliation{\affilnum{1}Oak Ridge National Laboratory \\ \affilnum{2}University of Tennessee, Knoxville \\} + +%%% DOCUMENT TITLE +%% Note: if using an explicit line break in the title, you must use the \protect +%% command before it. + +\title{Oak Ridge National Laboratory \protect\\ Official Report Template: \protect\\ Title Must Match RESolution Title \protect\\} + +%%% PUBLICATION DATE +%% Specify date or use current month and year with \today command. + +%\date{April 2024} +\date{\today} + +%%% REPORT NUMBER +%% Note: This number must match number provided by RESolution. + +\reportnum{ORNL/XX-XXXX/XXX} % Replace first XX with TM, SPR, or LTR. + +%%% DIVISION NAME +%% Define division/directorate name. Replace ``Division Name'' with your +%% division/directorate. + +\division{Division Name} + +%%% SPONSOR OPTIONS FOR SPR +%% Leave commented out or remove for TM and LTR. + +%%% SPONSOR NUMBER +%% SPR only. Comment out if not using. + +%\sponsornum{Sponsor No. (if needed)} + +%%% SPONSOR LOGO(s) +%% SPR only. Add sponsor logos by listing file names below. The cover can accommodate two sponsor logos. + +%\SponsorLogoOne{luggage/logo-placeholder.jpg} % Sponsor logo one. Comment out if not using. +%\SponsorLogoTwo{luggage/logo-placeholder.jpg} % Sponsor logo two. Comment out if not using. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% DOCUMENT RESTRICTIONS +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +%%% DRAFT +%% Mark the report as a draft with the \reportdraft command. Comment out for public release +%% and unlimited distribution. + +\reportdraft + +%%% GENERAL RESTRICTIONS +%% Add a restriction notice to the cover page and headers/footers. +%% Select option by removing the % that precedes it. + +%\restrict{UT-BATTELLE BUSINESS SENSITIVE} +%\restrict{UT-BATTELLE BUSINESS PERSONAL} +%\restrict{UT-BATTELLE INTERNAL USE ONLY} +%\restrict{Not for public release.} +%\restrict{UNCLASSIFIED CONTROLLED NUCLEAR INFORMATION} + +%%% CUI +%% Add a CUI notice to the header and footer. Use % to toggle on or off. +%% Note: CUI supercedes restrict. If both are enabled, only CUI will print. +%% Update with appropriate category and designating authority for your document. + +%\cui{CUI//CATEGORY/SUBCATEGORY//DISSEM} % Replace with appropriate markings. +%\cuiDA{Authority Name, ORNL} % Define the CUI designating authority. Can be organization, individual, or both. +%\cuiPh{(XXX)~XXX-XXXX} % Define phone number for designated authority. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% CRADA INSTRUCTIONS +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +%%% CRADA - General Info +%% +%% This command adds the CRADA notice to front cover and ORNL-851 form as the third page. +%% +%% Draft or public release is determined by toggling \reportdraft (line 99, above). +%% +%% If this report contains CRADA protected information, then toggle +%% the \cradaprotected command (line 157, below) by uncommenting it. +%% Note that this replaces the DRAFT notice. Only use for final document. +%% + +%% CRADA form ORNL-851 +%% +%% Once your CRADA document is final, please fill out and sign the ORNL-851.pdf +%% form that resides in this repository. You can also download ORNL-851.pdf from +%% https://ornl.sharepoint.com/sites/forms/ornl/Forms/Forms%20View.aspx. +%% + +%% Instructions for Overleaf/ShareLaTeX: +%% Download ORNL-851.pdf and open in Adobe Acrobat, fill it out, and +%% use the "Export to..." option to save the file as ORNL-851-complete.jpg. +%% Upload ORNL-851-complete.jpg to Overleaf/ShareLaTeX and replace the +%% old ORNL-851-complete.jpg file. DO NOT CHANGE THE FILE NAME. +%% Your completed form should appear on the third page. + +%% Instructions for local/repository: +%% Open ORNL-851.pdf in Adobe Acrobat, fill it out, and +%% use the "Export to..." option to save the file as ORNL-851-complete.jpg. +%% Replace old file. DO NOT CHANGE THE FILE NAME. +%% Your completed form should appear on the third page. + + +%\crada{CRADA no. NFE-XX-XXXXX} % Include CRADA report number. +%\cradaprotected{ten (10) years} % If protected, include nondisclosure period in years. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% ABBREVIATIONS +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Uses the Acro package called in the CLS (line 61) and styled in the STY (lines +%% 135--144). Note that acronyms that aren't used in the document won't be printed +%% in the list. Declare your abbreviations in abbreviations.tex. + +\input{abbreviations.tex} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% FRONT MATTER +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\begin{document} +\frontmatter + +% Prints TABLE OF CONTENTS +\tableofcontents % Comment out for LTR + +% Prints LIST OF FIGURES +\listoffigures % Comment out for LTR + +% Prints LIST OF TABLES +\listoftables % Comment out for LTR + +%% Prints LIST OF ABBREVIATIONS +\printacronyms % Comment out for LTR. Requires acro package. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%% ADDITIONAL FRONT MATTER (OPTIONAL) +\begin{foreword} % Remove foreword environment if not using (lines 217--291). + +Material after the Table of Contents, List of Figures, List of Tables, and List of +Abbreviations may include any or all of the following sections and should begin +on an odd-numbered page in the order listed below: + +\begin{itemize} + \item Foreword \marginpar{Note: spelling is not ``Forward.''} + \item Preface + \item Acknowledgments + \item Executive summary, or Summary + \item Abstract +\end{itemize} + +Each section of the front material begins on an odd-numbered page (the +\verb|\section| command inserts a \verb|\cleardoublepage| before each one). The +abstract, if very brief, may begin on page 1 inserted above the introduction +section. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\subsection*{TM, SPR, or LTR?} + +\textbf{Technical Memos (TMs)} are the primary report type produced at the lab, +and TM is the default option for this document's class. The TM template has been +approved by DOE for ORNL's use. The picture on the front cover is the only +design or branding element that may be changed. Use the RESolution Publications +system to generate an ORNL/TM report number by entering the report in the system +and selecting the TM category. + +\textbf{Letter reports (LTRs)} are for externally published letter reports, not +letters or sponsor reports. Use the RESolution Publications system to generate +an ORNL/LTR report number by entering the report in the system and selecting the +LTR category. Notably, LTR reports should be limited to 10 pages of narrative +text. Longer documents should use the TM option. + +\textbf{Sponsor reports (SPRs)} are for reports funded by outside sponsors that +have not provided their own guidelines and/or templates. If the sponsor (e.g., +Nuclear Regulatory Commission) has provided a template, then use it. Otherwise, +use the ORNL SPR option in this example. Notably, even if you are using a +sponsor's template, you must still use the RESolution Publications system to +generate an ORNL/SPR report number by entering the report in the system and +selecting the SPR category. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\subsection*{General Information} + +Document margins are 1 in.~all around. Generally, the \ac{tm} styling reflects +the defaults of Microsoft Word because that is the publishing application of +choice for the \ac{doe}. \Acp{tm} are more fun to write in \LaTeX. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\subsection*{Footnotes} + +Text footnotes are 9 pt. \ac{tnr} with no space between notes.\footnote{Footnotes +are 9 pt. \ac{tnr} with no space between notes.} Footnote indicators in text can be +superscript Arabic numerals as shown above or as superscript symbols +(using markup changes) as shown below. + +%% Use symbols for footnotes +\renewcommand*{\thefootnote}{\fnsymbol{footnote}} + +If symbols, then they will appear in the following order: \footnote{First}, +\footnote{Second}, \footnote{Third}, \footnote{Fourth}, \footnote{Fifth}, and +\footnote{etc}. Symbols \emph{are not} used as table footnote indicators (see +Section~\ref{sec:tables}). + +%% Use Arabic numbers for footnotes +\renewcommand*{\thefootnote}{\arabic{footnote}} +% Restore footnote count +\setcounter{footnote}{0} + +Footnotes may be used in addition to the author-date citation method, in which +case, the footnotes provide additional information to the text---not +bibliographic citations. +\end{foreword} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% ABSTRACT +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\mainmatter +\begin{abstract} + +The abstract, if short, is inserted here (after \verb|\mainmatter|) before the +introduction section. If the abstract is long, then it should be inserted +\emph{before} \verb|\mainmatter|, and the introduction below will be the first +entry on the page. This \acl{tm} class is used for reports at \acl{ornl}. + +\end{abstract} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% DOCUMENT CONTENT +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\acresetall % Reset abbreviations for narrative. +\section{FIRST-ORDER HEADING} +\label{sec:firstsec} +\marginpar{Sections and subsections must be manually capitalized to render +properly in the table of contents.} + +Begin text here. You can reference abbreviations such as \ac{ornl}, and, because +we are using the \verb|Acro| package, they will be defined on first instance and +automatically shortened on subsequent appearances---e.g., \ac{ornl}---unless you +reset the counter by using \verb|\acresetall|. They will also appear in the List +of Abbreviations. Note that any abbreviations used prior to the narrative are +reset! They are reset again for the appendix because these elements stand alone. + +The body of the document is paginated consecutively (i.e., 1, 2, 3) or by +section (i.e., 1-1, 2-1, 3-1) using Arabic numbers centered at the bottom of +each page. Blank backup pages are not numbered. + +When typing your document in LaTeX, it might be useful to break the line at the +right-hand side by hitting the return key so that any version control system you +might be using can recognize changes with better granularity. These version +control systems (e.g., SVN, Git, Mercurial) track changes by line number, so the +more frequent line breaks that a document has, the better control over changes +and merges the author(s) will have. These breaks are treated as spaces in the +final output. We recommend breaking lines at 80 characters. Some text editors +have a hotkey and/or extensions for this procedure (e.g., Rewrap for VS Code). + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\subsection{SECOND-ORDER HEADING} + +Begin text here. + +Another paragraph is here. + +\subsubsection{Third-Order Heading} + +Begin text. + +\paragraph{Fourth-Order Heading} + +Begin text here. + +\subparagraph{Fifth-Order Heading} + +Ask yourself, ``Do I \emph{really} need five or more hierarchical levels in my +document?'' + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\marginpar{A \texttt{\textbackslash cleardoublepage} should be inserted here if the preceding +section is not too short.} + +\section{FIGURE PLACEMENT} +\label{sec:figures} + +\subsection{FIGURES} + +Insert figures after the text callout but as close to the callout as possible. +They always have a caption describing them, and they are always numbered. LaTeX +automatically floats tables and figures depending on how much space is left on +the page where they are processed. If there is not enough room on +the current page, then the float is moved to the top of the next page. Figures are +numbered consecutively (i.e., Figure~1, Figure~2) except in large reports, in +which they may be numbered consecutively by section (i.e., Figure~1.1, +Figure~1.2). + +All figures are pulled in from source files that should be placed in a directory +that the author can link to from the LaTeX file. In this template, the image +files for the figures are in a subfolder named ``figures,'' which is +standard practice for LaTeX documents. + +\begin{figure}[ht] + \centering + \includegraphics[width=5.5in, height=2.5in]{figures/fig1.png} + \longcaption{All figure captions are 10 pt, bold, \ac{tnr}.}{Only the first sentence of + a figure caption is bold.} +\end{figure} + +Text can go in between figures. LaTeX will pretty much place the figures +wherever it sees fit based on the parameters described above---unless you +explicitly command it to do otherwise. + +\begin{figure}[ht] + \centering + \includegraphics[width=6.2in, height=2.75in, keepaspectratio=true]{figures/fig1.png} + \caption{One-line figure captions are bold.} +\end{figure} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\section{TABLE PLACEMENT} +\label{sec:tables} + +\subsection{TABLES} + +As with figures, tables are numbered consecutively or consecutively by section +and should follow their callout (see Table \ref{tab:1}) in the text as closely +as possible. LaTeX automatically floats tables and figures depending on how +much space is left on the page where they are processed. If there is +not enough room on the current page, then the float is moved to the top of the next +page. Tables are formatted using small \ac{tnr}. To accommodate large tables, the +font size can be decreased and, if necessary, landscaped (Table~\ref{tab:2}). + +\begin{table}[ht] + \centering + \begin{threeparttable} + \caption{Table caption is bold, centered, and initial cap with no period at + end of title}\label{tab:1} + \newcommand\tworow[1]{\multirow{2}{*}{#1}} + \begin{tabular}{c c c c c c} + \toprule + \tworow{EM project\tnote{a}} & \tworow{Recycling method} & \tworow{Amount + recycled (lb)} & \multicolumn{3}{c}{Cost (\$)} \\ \cline{4-6} + & & & Recycling & Disposal & Storage \\ \midrule + Metals recycle & Smelting & 1,072,000 & 1,565,763 & 1,338,447 & 1,608,000 \\ + Cooling tower\tnote{b} & Decontamination & 459,000 & 605,880 & 573,120 & + 688,500 \\ + \em{Total} & & 1,601,150 & 2,266,491 & 2,004,973 & 2,401,725 \\ + \bottomrule + \end{tabular} + \begin{tablenotes} + \item \emph{Note:} A general note to the table as a whole is not linked to + a superscript letter. It is formatted like this note. Table footnotes are + 9~pt, or, as with larger tables, 1~pt smaller than the table body text. + \item[a] Footnote callouts are lowercase, italic, superscript letters in + sequence from left to right. + \item[b] For multipage tables, the footnote appears only on the last page of + the table. + \end{tablenotes} + \end{threeparttable} +\end{table} + +\begin{landscape} % Creates a page break and orients the new page(s) in landscape mode, including the header and footer. +\begin{table} + \caption{This table is too wide for a portrait orientation and uses the pdflscape package for landscape}\label{tab:2} + \centering + \begin{tabular}{llllllllllll} + \toprule + Key & Def. & Definition & Key & Def. & Definition & Key & Def. & Definition \\ + \midrule + RND= & given & random number & PNU= & NO & use delayed neutron & SMU= & NO & self-multiplication \\ + TME= & no limit & execution time (min) & AMX= & NO & all mixture xsecs & NUB= & YES & neutrons per fission \\ + TBA= & 10 min & batch time (min) & XAP= & NO & xsec angles \& probs. & PAX= & NO & albedo-xsec array \\ + WTA= & 0.5 & average weight & XS1= & NO & 1D xsecs & TFM= & NO & coordinate transform \\ + WTH= & 3.0 & wt. for splitting & XS2= & NO & 2D xsecs & PMF= & NO & print angular fluxes \\ + WTL= & 1/WTH & Russian Roulette wt. & XSL= & NO & 2D Pl xsecs & MFX= & NO & compute mesh fluxes \\ + SIG= & 0.0 & deviation limit & PKI= & NO & fission spectrum & PMS= & NO & print mesh fluxes \\ + \bottomrule + \end{tabular} +\end{table} +\end{landscape} + +\section{FIGURE WRAPPING} +\label{sec:figwrap} + +The template uses the \verb|wrapfig| package to enable text to wrap neatly +around figures. You can adjust the padding and placement by using the +\verb|trim| and \verb|width| variables. + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam elementum euismod +rutrum. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur +ridiculus mus. Suspendisse gravida nunc est, at viverra augue rhoncus et. In +varius luctus enim, venenatis ullamcorper ipsum volutpat at. Pellentesque +habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. +Aliquam vel blandit sem. Etiam vel erat nibh. Vestibulum vulputate, neque vel +aliquet consequat, tortor magna sagittis magna, nec bibendum nulla ligula ut +nunc. Curabitur sed lorem in orci vestibulum imperdiet. + +\begin{wrapfigure}{r}{7cm} % Set box alignment {r} and size {7cm} + \centering % Center figure within box + \includegraphics[trim=2cm 0cm 2cm 0.5cm,width=4.5cm]{example-image-a} %Set image dimension smaller than box + \caption{Wrapped figure.} % Add caption + \vspace{-0.5cm} % Adjust white space under caption. +\end{wrapfigure} + +Curabitur eleifend vel leo eu malesuada. Donec ultricies cursus ante, sit amet +tincidunt enim ultrices id. Sed vel odio vel risus gravida aliquam vel eu neque. +Donec in ipsum ac risus varius aliquam facilisis sed neque. Nunc suscipit neque +at augue volutpat viverra. Proin sit amet nunc a lectus condimentum elementum. +Nullam porttitor felis ipsum, sit amet facilisis felis volutpat et. + +Quisque bibendum ligula ut sapien placerat, vitae faucibus neque luctus. +Maecenas semper elementum tortor id laoreet. Aenean condimentum tellus ante, et +condimentum magna sodales quis. Morbi interdum lobortis massa at pulvinar. Proin +et suscipit mauris. Maecenas aliquam lorem ipsum, nec dapibus nibh aliquam +vitae. Sed et molestie sapien. Nullam commodo id mauris quis mollis. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\section{CITATIONS} +\label{sec:citations} + +\subsection{USING IN-TEXT CITATIONS} +For the \ac{ornl} \ac{tm} reports, \textit{Chicago Manual of Style} references and +citations are preferred. Of these, you can choose between author-date + +references cited or footnote + references cited. + +Author-date style is set by default and is preferred. Use +the \verb|\autocite| command to defer to the default citation style, which will give +you the following: \autocite{knuthwebsite}. + +If for some reason you don't want the citation to be surrounded by parentheses, +you can use the \verb|\cite| command like this: \cite{einstein}. Or you can place +parentheses around the year by using the \verb|\citet| command like this: +\citet{einstein}. + +You can also push abbreviated citations into the footnotes using a \verb|\footcite| +command, like this. \footcite{latexcompanion} + +For all of the examples above, you do not have to change anything other than the +actual citation command. However, you (advanced users) can change the +bibliography further by changing the bibliography styles on line 23. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\section{LISTS} +\label{sec:lists} + +Flanges used in ultra-high vacuum service are commonly closed with metallic +gaskets or seals. The geometry of the seal interface is critical for proper +function. Experience has shown that flanges subjected to conventional welding +techniques distort beyond a point that they can be sealed. +\vspace{12pt} + +\begin{itemize} + \item \textbf{Apply itemize to format an unordered list with bullets.} + \emph{Add extra space between items if preferred.} Flanges used in + ultra-high vacuum service are commonly closed with metallic gaskets or + seals. The geometry of the seal interface is critical for proper function. + Experience has shown that flanges subjected to conventional welding + techniques distort beyond a point that they can be sealed. + \begin{itemize} + \item \textbf{Apply second itemize to format a sublist.} Flanges + used in ultra-high vacuum service are commonly closed with metallic + gaskets or seals. The geometry of the seal interface is critical for + proper function. Experience has shown that flanges subjected to + conventional welding techniques distort beyond a point that they can be + sealed. + \end{itemize} + \item \textbf{Apply itemize for format ``Bullet (last item)'' to format the + ending item.} Flanges used in ultra-high vacuum service are commonly closed + with metallic gaskets or seals. The geometry of the seal interface is + critical for proper function. Experience has shown that flanges subjected to + conventional welding techniques distort beyond a point that they can be + sealed. +\end{itemize} + +\subsection{SECOND-ORDER HEADING} + +Flanges used in ultra-high vacuum service are commonly closed with metallic +gaskets or seals. The geometry of the seal interface is critical for proper +function. Experience has shown that flanges subjected to conventional welding +techniques distort beyond a point that they can be sealed. + +You can also create an ordered/numbered list with \verb|enumerate|. + +\begin{enumerate} + \item Flanges used in ultra-high vacuum service are commonly closed with + metallic gaskets or seals. The geometry of the seal interface is critical + for proper function. Experience has shown that flanges subjected to + conventional welding techniques distort beyond a point that they can be + sealed. + \item Flanges used in ultra-high vacuum service are commonly closed with + metallic gaskets or seals. The geometry of the seal interface is critical + for proper function. Experience has shown that flanges subjected to + conventional welding techniques distort beyond a point that they can be + sealed. +\end{enumerate} + +\subsubsection{Third-Order Heading} + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. + +\paragraph{Fourth-order heading} + +Cras elementum pellentesque lacinia. Pellentesque habitant morbi tristique +senectus et netus et malesuada fames ac turpis egestas. Curabitur ornare libero +ipsum, quis volutpat diam sagittis porta. Aenean rhoncus dignissim leo, sed +lobortis lectus tempus venenatis. Proin pulvinar lectus a tellus finibus, quis +sodales nisl ullamcorper. Aliquam vel ornare ex, tristique faucibus velit. Fusce +scelerisque, lacus eget tincidunt varius, quam diam bibendum nulla, eu molestie +urna neque ac eros. Vestibulum dolor lectus, bibendum a mi nec, rhoncus +imperdiet ante. Cum sociis natoque penatibus et magnis dis parturient montes, +nascetur ridiculus mus. Duis gravida orci nec bibendum lobortis. Morbi leo +magna, ultricies eu interdum id, volutpat ac justo. Quisque mattis, turpis eu +interdum congue, augue odio ultricies ipsum, quis venenatis magna diam a nisl. +Vivamus finibus, mi vitae rhoncus pretium, mauris turpis fermentum dolor, id +volutpat nunc mauris sed urna. + +\paragraph{Fourth-order heading} + +Aliquam volutpat maximus orci nec dignissim. Sed varius, tellus non auctor +convallis, lorem enim convallis dolor, at ultrices libero tortor rutrum arcu. +Cras imperdiet sit amet nisl quis iaculis. Sed et tempus libero. Aenean a nisl +metus. Etiam ut orci id libero pretium pretium. Nam mauris est, pretium lobortis +leo ut, scelerisque posuere sapien. Vivamus posuere venenatis sem at +pellentesque. + +\paragraph{Fourth-order heading} + +Aenean imperdiet vestibulum faucibus. Aliquam id nulla elementum ipsum +scelerisque viverra. Pellentesque fringilla ultricies libero interdum dictum. +Quisque id pellentesque nisl, posuere convallis urna. Aliquam urna neque, +molestie efficitur congue nec, ornare vitae erat. Duis a sagittis ante. Aliquam +lacinia placerat dapibus. In in finibus dolor. Morbi id aliquet ante, et mattis +quam. Nunc rutrum viverra leo, et eleifend nulla interdum vitae. Donec nec +finibus nibh. Integer interdum nibh enim, id porta libero vestibulum vel. Sed +efficitur justo sed diam suscipit varius. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% REFERENCES +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +% Bibliography support via biblatex +\section{REFERENCES}% Create heading for references to include in ToC. +\printbibliography[heading=none]% Print references without biblatex's heading. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% APPENDICES +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\appendix +\acresetall % Reset abbreviations for Appendices. +\section{FIRST APPENDIX} +\label{sec:firstapp} + +If each appendix contains similarly formatted text as the body of the document +(i.e., first-order headings), then flysheets are not necessary. If first-order +headings cannot be used (e.g., with computer data or forms), then a flysheet should +be used. + +\begin{equation}\label{eq:appeq} + 2 + 2 = 4 +\end{equation} + +\begin{figure}[htb] + \centering + \includegraphics[width=5.5in, height=2.5in]{example-image-a} + \caption{Figure caption.} +\end{figure} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\section{SECOND APPENDIX} +\label{sec:secondapp} +If each appendix contains similarly formatted text as the body of the document +(i.e., first-order headings), then flysheets are not necessary. If first-order +headings cannot be used (e.g., with computer data or forms), then a flysheet should +be used. + +\begin{table}[h] + \centering + \caption{A regular table in the appendix} + \label{tab:app-table} + \begin{tabular}{ccccc} + \toprule + Class & Precision & Recall & F1-Score & Support \\ + \midrule + 0 & 1.00 & 1.00 & 1.00 & 476075 \\ + 1 & 1.00 & 0.99 & 0.99 & 81294 \\ \midrule + Accuracy & - & - & 1.00 & 557369 \\ + Macro Avg. & 1.00 & 0.99 & 1.00 & 557369 \\ + Weighted Avg. & 1.00 & 1.00 & 1.00 & 557369 \\ \bottomrule + \end{tabular} + \end{table} + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Back cover page +\backmatter + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\end{document} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% end of ornltm/ornl-template-example.tex +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% diff --git a/example/ornl-tm-template-example.tex b/example/ornl-tm-template-example.tex deleted file mode 100644 index 780f4754c6a4b43a21cf56054116f1792015dfed..0000000000000000000000000000000000000000 --- a/example/ornl-tm-template-example.tex +++ /dev/null @@ -1,527 +0,0 @@ -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% File : ornltm/ornl-template-example.tex -% Author: Seth R Johnson, Sam Crawford,* and John Batson -% * Corresponding author -% Date : Fri Oct 27 16:19:46 2023 -% -% Example of ORNL tech memo template -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% Use the ``draft'' option to compile more quickly. -\documentclass{ornltm} -%\documentclass[draft]{ornltm} - -% Uncomment these to hide a particular page. -%\renewcommand\makeostipage\relax -%\renewcommand\makecoverpage\relax -%\renewcommand\maketitlepage\relax - -% Optional packages that are simply part of this example document -\usepackage{threeparttable} % Table with captions and tablenotes -\usepackage{booktabs} % Toprule, midrule, bottomrule -\usepackage[final]{microtype} % Better PDF typesetting -\usepackage{multirow} % Extend table entries over multiple rows - -% Bibliography styling. WARNING: the biblatex-chicago package removes the -% footnote rule. -\usepackage[authordate,strict,backend=biber,autolang=other,bibencoding=inputenc]{biblatex-chicago} % Author-date style. -%\usepackage{biblatex} % Numerical style. - -\bibliography{example.bib} % Replace with your bib filename. - -% Use inline small italic blue for comments rather than placing them in the -% margin. -\definecolor{note}{RGB}{48,96,192} -\renewcommand{\marginpar}[1]{{\small\em\color{note}[#1]}} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% AUTHORSHIP & PUBLISHING -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -% Specify authors below. -% Note: multiple authors are separated with the \and command. -%\author{First Author \and Second Author \and Third Author\affilnum{1}} -\author{First Author \and Second Author\affilnum{1} \and Third Author\affilnum{2}} - -\affiliation{% - \affilnum{1}University of Tennessee \\ - \affilnum{2}Starfleet -} - -% Specify title. -% Note: if using an explicit line break in the title, you must use the \protect -% command before it. -\title{Oak Ridge National Laboratory \protect\\ Official TM Template: \protect\\ Title Must Match RESolution Title} - -% Specify date of publication. -%\date{September 16, 2016} -\date{\today} - -% Define report number. This number must match number provided by RESolution. -\reportnum{ORNL/TM-XXXX/XXX} - -% Define division/directorate name. Replace "Division Name" with your -% division/directorate. -\division{Division Name} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% DOCUMENT RESTRICTIONS -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -%%% DRAFT -% Mark the report as a draft. Comment out for public release -% and unlimited distribution. - - \reportdraft - -%%% GENERAL RESTRICTIONS -% Add a restriction notice to the cover page and headers/footers. -% Select option by removing the % that precedes it. - -% \restrict{UT-BATTELLE BUSINESS SENSITIVE} -% \restrict{UT-BATTELLE BUSINESS PERSONAL} -% \restrict{UT-BATTELLE INTERNAL USE ONLY} -% \restrict{Not for public release.} -% \restrict{UNCLASSIFIED CONTROLLED NUCLEAR INFORMATION} - -%%% CRADA -% Add CRADA notice to front cover. Draft or public release are determined -% by toggling \reportdraft (above). - -% \crada{CRADA number NFE-XX-XXXXX} - -%%% CUI -% Add a CUI notice to the header and footer. Use % to toggle on or off. Note: CUI supercedes restrict. If both are enabled, only CUI will print. -% Update with appropriate category for your document. - -% \cui{CUI//CATEGORY/SUBCATEGORY//DISSEM} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% ABBREVIATIONS -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% Uses the Acro package called in CLS. Note that acronyms that aren't used in the document won't be printed in the list. - -\DeclareAcronym{doe}{ - short = DOE , - long = US Department of Energy - } -\DeclareAcronym{nrc}{ - short = NRC , - long = Nuclear Regulatory Commission - } -\DeclareAcronym{tm}{ - short = TM , - long = Technical Memo -} -\DeclareAcronym{ornl}{ - short = ORNL , - long = Oak Ridge National Laboratory -} -\DeclareAcronym{tnr}{ - short = TNR , - long = Times New Roman -} -\DeclareAcronym{msc}{ - short = MSC , - long = many such cases -} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% FRONT MATTER -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\begin{document} -\frontmatter - -\tableofcontents -% LIST OF FIGURES: optional if fewer than 5 are used -\listoffigures - -% LIST OF TABLES: optional if fewer than 5 are used -\listoftables - -% Print LIST OF ABBREVIATIONS (optional) -\printacronyms - - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% ADDITIONAL FRONT MATTER (OPTIONAL) -\section*{Foreword} - -Material after the Contents, List of Figures, List of Tables, and the Acronym -list may include any or all of the following sections and should begin on an -odd-numbered page in the order listed below: - -\begin{itemize} - \item Foreword \marginpar{Note: spelling is not ``Forward.''} - \item Preface - \item Acknowledgments - \item Executive summary, or Summary - \item Abstract -\end{itemize} - -Each section of the front material begins on an odd-numbered page (the -\verb|\section| command inserts a \verb|\cleardoublepage| before each one). The -abstract, if very brief, may begin on page 1 inserted above the introduction -section. - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\subsection*{General Information} - -Document margins are 1 in.~all around. Generally, the \ac{tm} styling reflects -the defaults of Microsoft Word, because that is the publishing application of -choice for the \ac{doe}. \Aclp{tm} are more fun to write in \LaTeX. - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\subsection*{Footnotes} - -Text footnotes are 9 pt., \ac{tnr} with no space between notes. \footnote{Footnotes -are 9pt., \ac{tnr} with no space between notes.} Footnote indicators in text can be -superscript Arabic numerals as shown above or as superscript symbols -(using markup changes) as shown below. - -% Use symbols for footnotes -\renewcommand*{\thefootnote}{\fnsymbol{footnote}} - -If symbols, they will appear the following order: \footnote{First}, -\footnote{Second}, \footnote{Third}, \footnote{Fourth}, \footnote{Fifth}, -\footnote{etc}. Symbols \emph{are not} used as table footnote indicators (see -Section~\ref{sec:tables}). - -% Use Arabic numbers for footnotes -\renewcommand*{\thefootnote}{\arabic{footnote}} -% Restore footnote count -\setcounter{footnote}{0} - -Footnotes may be used in addition to the author-date citation method, in which -case, the footnotes provide additional information to the text, not -bibliographic citations. - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% ABSTRACT -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\mainmatter -\begin{abstract} - -The abstract, if short, is inserted here (after \verb|\mainmatter|) before the -introduction section. If the abstract is long, it should be inserted -\emph{before} \verb|\mainmatter|, and the introduction below will be the first -method on the page. This \acl{tm} class is used for reports at \acl{ornl}. - -\end{abstract} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% DOCUMENT CONTENT -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\section{FIRST-ORDER HEADING} -\label{sec:firstsec} -\marginpar{Sections and subsections must be manually capitalized to render -properly in the table of contents.} - -Begin text here. You can reference acronyms such as \ac{ornl}, and when -referencing the next time they will automatically be replaced with shortened -versions such as \ac{ornl}. - -The body of the document is paginated consecutively (i.e., 1, 2, 3) or by -section (i.e., 1-1, 2-1, 3-1) using Arabic numbers centered at the bottom of -each page. Blank backup pages are not numbered. - -When typing your document in LaTeX, it might be useful to break the line at the -right-hand side by hitting the return key so that any version control system you -might be using can recognize changes with better granularity. These version -control systems (e.g., SVN, Git, Mercurial) track changes by line number, so the -more frequent line breaks that a document has, the better control over changes -and merges the author(s) will have. These breaks are treated as spaces in the -final output. - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\subsection{SECOND-ORDER HEADING} - -Begin text here. - -Another paragraph is here. - -\subsubsection{Third-Order Heading} - -Begin text. - -\paragraph{Fourth-Order Heading} - -Begin text here. - -\subparagraph{Fifth-Order Heading} - -Ask yourself, ``Do I \emph{really} need five or more hierarchical levels in my -document?'' \Ac{msc}. - - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\marginpar{A \texttt{\textbackslash cleardoublepage} should be inserted here if the preceding -section is not too short.} - -\section{FIGURE PLACEMENT} -\label{sec:figures} - -\subsection{FIGURES} - -Insert figures after the text callout but as close to the callout as possible. -(They always have a caption describing them and they are always numbered. LaTeX -automatically floats Tables and Figures, depending on how much space is left on -the page at the point that they are processed. If there is not enough room on -the current page, the float is moved to the top of the next page.) Figures are -numbered consecutively (i.e., Figure 1, Figure 2) except in large reports, where -they may be numbered consecutively by section (i.e., Figure 1.1, Figure 1.2). - -All figures are pulled in from source files that should be placed in a directory -to which the author can link in the LaTeX file. In this template, the image -files for the figures are in the same directory as the main LaTeX document, but -it is common practice to also place them in a sub folder named ``figures'' or -similar. - -\begin{figure}[ht] - \centering - \includegraphics[width=5.5in, height=2.5in]{figures/fig1.png} - \longcaption{All figure captions are 10 pt, bold, \ac{tnr}.}{If you have a - two-line or more figure caption it is flush left. Only the first sentence of - a figure caption is bold.} -\end{figure} - -Text can go in between figures. LaTeX will pretty much place the figures -wherever it wants unless you explicitly command it to do otherwise. - -\begin{figure}[ht] - \centering - \includegraphics[width=6.2in, height=2.75in, keepaspectratio=true]{figures/fig1.png} - \caption{One-line figure captions are centered.} -\end{figure} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\section{TABLE PLACEMENT} -\label{sec:tables} - -\subsection{TABLES} - -As with figures, tables are numbered consecutively, or consecutively by section, -and should follow their callout (see Table \ref{tab:1}) in the text as closely -as possible. (LaTeX automatically floats Tables and Figures, depending on how -much space is left on the page at the point that they are processed. If there is -not enough room on the current page, the float is moved to the top of the next -page.) Tables are formatted using small \ac{tnr}. To accommodate large tables, the -font size can be decreased and, if necessary, landscaped. - -\begin{table}[ht] - \centering - \begin{threeparttable} - \caption{Table caption is bold, centered, and initial cap with no period at - end of title}\label{tab:1} - \newcommand\tworow[1]{\multirow{2}{*}{#1}} - \begin{tabular}{c c c c c c} - \toprule - \tworow{EM project\tnote{a}} & \tworow{Recycling method} & \tworow{Amount - recycled (lb)} & \multicolumn{3}{c}{Cost (\$)} \\ \cline{4-6} - & & & Recycling & Disposal & Storage \\ \midrule - Metals recycle & Smelting & 1,072,000 & 1,565,763 & 1,338,447 & 1,608,000 \\ - Cooling tower\tnote{b} & Decontamination & 459,000 & 605,880 & 573,120 & - 688,500 \\ - \em{Total} & & 1,601,150 & 2,266,491 & 2,004,973 & 2,401,725 \\ - \bottomrule - \end{tabular} - \begin{tablenotes} - \item \emph{Note:} A general note to the table as a whole is not linked to - a superscript letter. It is formatted like this note. Table footnotes are - 9~pt, or as with larger tables, 1~pt smaller than the table body text. - \item[a] Footnote call-outs are lowercase, italic, superscript letters in - sequence from left to right, then - \item[b] For multipage tables, the footnote appears only on the last page of - the table. Beginning on the second page and following pages of a multipage - table, use Table N as the table caption. - \end{tablenotes} - \end{threeparttable} -\end{table} - - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam elementum euismod -rutrum. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur -ridiculus mus. Suspendisse gravida nunc est, at viverra augue rhoncus et. In -varius luctus enim, venenatis ullamcorper ipsum volutpat at. Pellentesque -habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. -Aliquam vel blandit sem. Etiam vel erat nibh. Vestibulum vulputate, neque vel -aliquet consequat, tortor magna sagittis magna, nec bibendum nulla ligula ut -nunc. Curabitur sed lorem in orci vestibulum imperdiet. - -Curabitur eleifend vel leo eu malesuada. Donec ultricies cursus ante, sit amet -tincidunt enim ultrices id. Sed vel odio vel risus gravida aliquam vel eu neque. -Donec in ipsum ac risus varius aliquam facilisis sed neque. Nunc suscipit neque -at augue volutpat viverra. Proin sit amet nunc a lectus condimentum elementum. -Nullam porttitor felis ipsum, sit amet facilisis felis volutpat et. - -Quisque bibendum ligula ut sapien placerat, vitae faucibus neque luctus. -Maecenas semper elementum tortor id laoreet. Aenean condimentum tellus ante, et -condimentum magna sodales quis. Morbi interdum lobortis massa at pulvinar. Proin -et suscipit mauris. Maecenas aliquam lorem ipsum, nec dapibus nibh aliquam -vitae. Sed et molestie sapien. Nullam commodo id mauris quis mollis. - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\section{CITATIONS} -\label{sec:citations} - -\subsection{USING IN-TEXT CITATIONS} -For the \ac{ornl} \ac{tm} reports, \textit{Chicago Manual of Style} references and -citations are preferred. Of these, you can choose between author-date + -references cited or footnote + references cited. - -Author-date style is set by default and is preferred. Use -the autocite command to defer to the default citation style, which will give -you the following: \autocite{knuthwebsite}. - -If for some reason you don't want the citation to be surrounded by parentheses, -you can use the cite command like this: \cite{einstein}. - -You can also push abbreviated citations into the footnotes using a footcite -command, like this. \footcite{latexcompanion} - -For all of the examples above, you do not have to change anything other than the -actual citation command. However, you (advanced users) can change the -bibliography further by changing the bibliography styles. - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\section{LISTS} -\label{sec:lists} - -Flanges used in ultra-high vacuum service are commonly closed with metallic -gaskets or seals. The geometry of the seal interface is critical for proper -function. Experience has shown that flanges subjected to conventional welding -techniques distort beyond a point that they can be sealed. -\vspace{12pt} - -\begin{itemize} - \item \textbf{Apply itemize to format a bullet list.} \emph{Add extra space - between items if preferred.} Flanges used in ultra-high vacuum service are - commonly closed with metallic gaskets or seals. The geometry of the seal - interface is critical for proper function. Experience has shown that flanges - subjected to conventional welding techniques distort beyond a point that - they can be sealed. - \begin{itemize} - \item \textbf{Apply second itemize to format a sub-dashed list.} Flanges - used in ultra-high vacuum service are commonly closed with metallic - gaskets or seals. The geometry of the seal interface is critical for - proper function. Experience has shown that flanges subjected to - conventional welding techniques distort beyond a point that they can be - sealed. - \end{itemize} - \item \textbf{Apply itemize for format ``Bullet (last item)'' to format the - ending item.} Flanges used in ultra-high vacuum service are commonly closed - with metallic gaskets or seals. The geometry of the seal interface is - critical for proper function. Experience has shown that flanges subjected to - conventional welding techniques distort beyond a point that they can be - sealed. -\end{itemize} - -\subsection{SECOND-ORDER HEADING} - -Flanges used in ultra-high vacuum service are commonly closed with metallic -gaskets or seals. The geometry of the seal interface is critical for proper -function. Experience has shown that flanges subjected to conventional welding -techniques distort beyond a point that they can be sealed. - -You can also use numbered lists. - -\begin{enumerate} - \item Flanges used in ultra-high vacuum service are commonly closed with - metallic gaskets or seals. The geometry of the seal interface is critical - for proper function. Experience has shown that flanges subjected to - conventional welding techniques distort beyond a point that they can be - sealed. - \item Flanges used in ultra-high vacuum service are commonly closed with - metallic gaskets or seals. The geometry of the seal interface is critical - for proper function. Experience has shown that flanges subjected to - conventional welding techniques distort beyond a point that they can be - sealed. -\end{enumerate} - -\subsubsection{Third-Order Heading} - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. - -\paragraph{Fourth-order heading} - -Cras elementum pellentesque lacinia. Pellentesque habitant morbi tristique -senectus et netus et malesuada fames ac turpis egestas. Curabitur ornare libero -ipsum, quis volutpat diam sagittis porta. Aenean rhoncus dignissim leo, sed -lobortis lectus tempus venenatis. Proin pulvinar lectus a tellus finibus, quis -sodales nisl ullamcorper. Aliquam vel ornare ex, tristique faucibus velit. Fusce -scelerisque, lacus eget tincidunt varius, quam diam bibendum nulla, eu molestie -urna neque ac eros. Vestibulum dolor lectus, bibendum a mi nec, rhoncus -imperdiet ante. Cum sociis natoque penatibus et magnis dis parturient montes, -nascetur ridiculus mus. Duis gravida orci nec bibendum lobortis. Morbi leo -magna, ultricies eu interdum id, volutpat ac justo. Quisque mattis, turpis eu -interdum congue, augue odio ultricies ipsum, quis venenatis magna diam a nisl. -Vivamus finibus, mi vitae rhoncus pretium, mauris turpis fermentum dolor, id -volutpat nunc mauris sed urna. - -\paragraph{Fourth-order heading} - -Aliquam volutpat maximus orci nec dignissim. Sed varius, tellus non auctor -convallis, lorem enim convallis dolor, at ultrices libero tortor rutrum arcu. -Cras imperdiet sit amet nisl quis iaculis. Sed et tempus libero. Aenean a nisl -metus. Etiam ut orci id libero pretium pretium. Nam mauris est, pretium lobortis -leo ut, scelerisque posuere sapien. Vivamus posuere venenatis sem at -pellentesque. - -\paragraph{Fourth-order heading} - -Aenean imperdiet vestibulum faucibus. Aliquam id nulla elementum ipsum -scelerisque viverra. Pellentesque fringilla ultricies libero interdum dictum. -Quisque id pellentesque nisl, posuere convallis urna. Aliquam urna neque, -molestie efficitur congue nec, ornare vitae erat. Duis a sagittis ante. Aliquam -lacinia placerat dapibus. In in finibus dolor. Morbi id aliquet ante, et mattis -quam. Nunc rutrum viverra leo, et eleifend nulla interdum vitae. Donec nec -finibus nibh. Integer interdum nibh enim, id porta libero vestibulum vel. Sed -efficitur justo sed diam suscipit varius. - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% REFERENCES -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -% Bibliography support via biblatex -\section{REFERENCES}% Create heading for references to include in ToC. -\printbibliography[heading=none]% Print references without biblatex's heading. - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% APPENDICES -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\appendix -\section{FIRST APPENDIX} -\label{sec:firstapp} - -If each appendix contains similarly formatted text as the body of the document -(i.e., first-order headings) then flysheets are not necessary. If first-order -headings cannot be used, such as with computer data or forms, a flysheet should -be used. - -\begin{equation}\label{eq:appeq} - 2 + 2 = 5 -\end{equation} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\section{SECOND APPENDIX} -\label{sec:secondapp} -If each appendix contains similarly formatted text as the body of the document -(i.e., first-order headings) then flysheets are not necessary. If first-order -headings cannot be used, such as with computer data or forms, a flysheet should -be used. - - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% Back cover page -\backmatter - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\end{document} -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% end of ornltm/ornl-template-example.tex -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% diff --git a/ornltm/logo-placeholder.jpg b/ornltm/logo-placeholder.jpg new file mode 100644 index 0000000000000000000000000000000000000000..64a78c834ed42827e692ed1c7ba6404302d7f19e Binary files /dev/null and b/ornltm/logo-placeholder.jpg differ diff --git a/ornltm/ltr-background.png b/ornltm/ltr-background.png new file mode 100644 index 0000000000000000000000000000000000000000..652d954c33fca4ef42e44c6f9ec274a0b2c02f63 Binary files /dev/null and b/ornltm/ltr-background.png differ diff --git a/ornltm/ltr-gradient-bar.png b/ornltm/ltr-gradient-bar.png new file mode 100644 index 0000000000000000000000000000000000000000..dc2bc8ab2057eb2822f773fb57b5116091f39f28 Binary files /dev/null and b/ornltm/ltr-gradient-bar.png differ diff --git a/ornltm/ornltm-style.sty b/ornltm/ornltm-style.sty index d4bb9e2b11e5f2aaa933954a770d71b0f0e4a5d1..396b97902bc7b78199b75d603bf782dfb61d1492 100644 --- a/ornltm/ornltm-style.sty +++ b/ornltm/ornltm-style.sty @@ -1,7 +1,7 @@ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% File : ornltm/ornltm/ornltm-style.sty +% File: ornltm-style.sty % Author: Seth R Johnson with contributions by Sam Crawford and John Batson -% Date : Fri Oct 27 16:19:46 2023 +% Date: Friday August 01, 2024 @ 15:48 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \NeedsTeXFormat{LaTeX2e}[1995/12/01] @@ -9,6 +9,10 @@ \ProcessOptions\relax +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% ALIGNMENT +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % GEOMETRY %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -80,7 +84,7 @@ \RequirePackage{tocloft} % table of contents styling -\setcounter{tocdepth}{2} % subsections +\setcounter{tocdepth}{3} % subsections % Make the contents, figure, and table titles uppercase and centered \renewcommand\cfttoctitlefont{\noindent\hspace*{\fill}\bfseries\MakeUppercase} @@ -100,16 +104,20 @@ % Make TOC page numbers not bold \addtocontents{toc}{\protect\renewcommand{\protect\cftsecpagefont}{\mdseries}} +% New command for removing vertical space in lists. +\newcommand*{\noaddvspace}{\renewcommand*{\addvspace}[1]{}} + % Add "Figure" # prefix to list of figures \renewcommand{\cftfigpresnum}{Figure } % put Figure before the number -\renewcommand{\cftfigaftersnum}{.} % add colon after the number +\renewcommand{\cftfigaftersnum}{.} % add period after the number \addtolength{\cftfignumwidth}{1.25cm} % extra space for extended numbers +\addtocontents{lof}{\protect\noaddvspace} % Ensures list of figures uses no additional vspace (line 110) % Add "Table" # prefix to list of tables - -\renewcommand{\cfttabpresnum}{Table } % put Figure before the number +\renewcommand{\cfttabpresnum}{Table } % put Table before the number \renewcommand{\cfttabaftersnum}{.} % add period after the number \addtolength{\cfttabnumwidth}{1.25cm} % extra space for extended numbers +\addtocontents{lot}{\protect\noaddvspace} % Ensures list of tables uses no additional vspace (line 110) %%% EXTENSIONS FOR SPHINX MANUAL %%% @@ -129,10 +137,12 @@ \@ifpackageloaded{acro}{\acsetup{% list/heading = section*, % Set list heading to section but do not number list/name = {LIST OF ABBREVIATIONS}, % Ensure heading will print correct title -list/template = tabular, % Set list style as tabular for better spacing +format/short = \normalfont, format/replace=false, % Replaces bold letters (default) with normal font. +list/template = longtable, % Set list style as longtable for tabular spacing and spanning multiple pages list/preamble = { % Adding options to the preamble of the actual list. Any text or TeX can go here (almost). \phantomsection % Adding a phantom section so the ToC link will actually go there \addcontentsline{toc}{section}{LIST OF ABBREVIATIONS} % Adding line to ToC for the abbreviations + \setlength{\LTleft}{-\tabcolsep} % Setting tabular to the left }}} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -185,6 +195,7 @@ list/preamble = { % Adding options to the preamble of the actual list. Any text \centerline{\bf\appendixname~\thesection.\hspace{.5em}\MakeUppercase{#1}}% } +% Sets the prefix for all appendix section titles. \renewcommand\appendixname{APPENDIX} % Change format for appendices: 'appendix' in title, title takes entire page, @@ -193,25 +204,38 @@ list/preamble = { % Adding options to the preamble of the actual list. Any text \cleardoublepage % Reset page style \pagenumbering{arabic}% - \renewcommand\thepage{\thesection--\arabic{page}}% - % Reset section numbering - \gdef\thesection{\@Alph\c@section}% + \renewcommand\thepage{\thesection-\arabic{page}}% % Reset section formatting + \gdef\thesection{\@Alph\c@section}% + % Reset section numbering \setcounter{section}{0}% - % Change equation numbering + % Reset section, subsection, and subsubsection commands so ToC actually goes to the appendices + \renewcommand*{\theHsection}{\thesection} + \renewcommand*{\theHsubsection}{\thesubsection} + \renewcommand*{\theHsubsubsection}{\thesubsubsection} + % Change equation, figure, and table numbering \gdef\theequation{\@Alph\c@section.\arabic{equation}}% - % Reset page and equation numbers at the beginning of every section + \gdef\thefigure{\@Alph\c@section.\arabic{figure}}% + \gdef\thetable{\@Alph\c@section.\arabic{table}}% + % Reset page, figure, table, and equation numbers at the beginning of every section \@addtoreset{equation}{section}% + \@addtoreset{figure}{section}% + \@addtoreset{table}{section}% \@addtoreset{page}{section}% % Change the title format so that the ``header'' is a standalone title page. % This allows section and page numbering to be correct, and we can use the % macros it defines to insert a ``regular'' appendix label afterward. \titleformat{\section}[block]{\null\vfill\bf\filcenter}% - {\appendixname~\thesection.}{0.5em}{\bf\large\MakeUppercase}[\vfill\null] + {\appendixname~\thesection.}{0.5em}{\bf\MakeUppercase}[\vfill\null] % Save the command we just defined; we'll use it in a command we defined above % outside the ``appendix'' macro. \let\@oldappendixsection\section \let\section\@appendixsection + % Adds prefix and required space to appendix ToC entries. + \addtocontents{toc}{% + \protect\renewcommand\protect\cftsecpresnum{\appendixname~}% Prepend Appendix + \protect\setlength\protect\cftsecnumwidth{7em}% Adjust width of section number in ToC + } } %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% diff --git a/ornltm/ornltm.cls b/ornltm/ornltm.cls index 626507b1a45cd2a11a9f4b5ac9909182fa3c5074..a5f752790f97a52e45b69259c572b4e08ee21503 100644 --- a/ornltm/ornltm.cls +++ b/ornltm/ornltm.cls @@ -1,9 +1,9 @@ -% !TEX root = ../example/ornl-template-example.tex +% !TEX root = ornl-template-example.tex %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% File : ornltm.cls -% Author: Seth R Johnson, Sam Crawford,* and John Batson -% * Corresponding author -% Date : Fri Oct 27 16:19:46 2023 +% File: ornltm.cls +% Authors: Seth R Johnson, Sam Crawford,* and John Batson +% *Corresponding author, crawfordst.@ornl.gov +% Date: Tuesday March 18, 2025 @ 13:58 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \NeedsTeXFormat{LaTeX2e}[1995/12/01] @@ -12,24 +12,63 @@ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % OPTIONS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Define default option +\newif\if@tm +\newif\if@spr +\newif\if@ltr + +% Process options +\DeclareOption{tm}{\@tmtrue} +\DeclareOption{spr}{\@sprtrue} +\DeclareOption{ltr}{\@ltrtrue} + \ProcessOptions\relax + +% If no options were provided, set default to 'tm' +\if@tm + % Option 'tm' is selected +\else + \if@spr + % Option 'spr' is selected + \else + \if@ltr + % Option 'ltr' is selected + \else + % No options provided, default to 'tm' + \@tmtrue + \fi + \fi +\fi + + \LoadClass[11pt,letterpaper]{article} +% Set \today to just month and year. \date{} can also be specified in example. +\renewcommand{\today}{\ifcase \month \or January\or February\or March\or % +April\or May \or June\or July\or August\or September\or October\or November\or % +December\fi~\number \year} + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % STYLING %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\RequirePackage{wallpaper} % background on cover page -\RequirePackage{fancyhdr} % headers and footers -\RequirePackage{emptypage} % hide footers on blank pages +\RequirePackage{wallpaper} % Background on cover page +\RequirePackage{adjustbox} % Used to keep author block within front cover +\RequirePackage{fancyhdr} % Headers and footers +\RequirePackage{emptypage} % Hide footers on blank pages \RequirePackage[pdfusetitle]{hyperref} % url and links in PDF +\RequirePackage{longtable} % Allows tables to span multiple pages \RequirePackage{acro} % Add support for abbreviations \RequirePackage{array} % Add support for tabulars -\RequirePackage{tocloft} % table of contents styling -\RequirePackage{color} % colored fonts and boxes -\RequirePackage{framed} % framed notice boxes -\RequirePackage{seqsplit} % for splitting unruly character strings +\RequirePackage{tocloft} % Table of contents styling +\RequirePackage{color} % Colored fonts and boxes +\RequirePackage{framed} % Framed notice boxes +\FrameSep4pt % Sets padding for framed boxes. +\RequirePackage{seqsplit} % For splitting unruly character strings \RequirePackage{etoolbox} % Patch for all caps first- and second-order headings in TOC +\usepackage{pdfpages} % Enables you to add PDFs as if they were pages in your doc. +\usepackage{ifpdf} % Used to identify presence of a file. +\usepackage{wrapfig} % Enables wrapping figures in text. % Load document style \RequirePackage{ornltm-style} @@ -48,10 +87,17 @@ % Use the \reportnum command to define a report number. \newif\if@reportnumdefined \@reportnumdefinedfalse -\def\@reportnum{ORNL/TM-XXXX/XXX% -\PackageWarning{ornltm}{No TM report number has been defined.}} +\def\@reportnum{ORNL/XX-XXXX/XXX% +\PackageWarning{ornltm}{No report number has been defined.}} \newcommand{\reportnum}[1]{\def\@reportnum{#1}\@reportnumdefinedtrue} +% Use the \sponsornum command to define a sponsor number. +\newif\if@sponsornumdefined +\@sponsornumdefinedfalse +\def\@sponsornum{% +} +\newcommand{\sponsornum}[1]{\def\@sponsornum{#1}\@sponsornumdefinedtrue} + \newif\if@reportdraft \@reportdraftfalse \newcommand{\reportdraft}{\@reportdrafttrue} @@ -60,6 +106,15 @@ \newcommand{\affiliation}[1]{\def\@affiliation{#1}} \newcommand{\affilnum}[1]{\texorpdfstring{\textsuperscript{#1}}{}} +% Adding sponsor logo definitions. +\newif\if@SponsorLogoOnedefined +\@SponsorLogoOnedefinedfalse +\newcommand{\SponsorLogoOne}[1]{\def\@SponsorLogoOne{#1}\@SponsorLogoOnedefinedtrue} + +\newif\if@SponsorLogoTwodefined +\@SponsorLogoTwodefinedfalse +\newcommand{\SponsorLogoTwo}[1]{\def\@SponsorLogoTwo{#1}\@SponsorLogoTwodefinedtrue} + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % Added for CRADA (remains blank if CRADA is undefined) %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -68,6 +123,20 @@ \@cradadefinedfalse \newcommand{\crada}[1]{\def\@crada{#1}\@cradadefinedtrue} +% Uncomment the \cradaprotected{...} +%\newif\if@cradaprotecteddefined +%\@cradaprotecteddefinedfalse +%\newcommand{\cradaprotected}[1]{\def\@cradaprotected{#1}\@cradaprotecteddefinedtrue} + +\newif\if@cradaprotecteddefined +\@cradaprotecteddefinedfalse + +\newcommand{\cradaprotected}[2]{% + \def\@cradaprotectedfirst{#1}% + \def\@cradaprotectedsecond{#2}% + \@cradaprotecteddefinedtrue% +} + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % Added for CUI (remains blank if CUI is undefined) %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -76,12 +145,27 @@ \@cuidefinedfalse \newcommand{\cui}[1]{\def\@cui{#1}\@cuidefinedtrue} +\newif\if@cuiDAdefined +\@cuiDAdefinedfalse +\def\@cuiDA{CUI DA UNDEFINED% +\PackageWarning{ornltm}{No CUI designated authority has been defined.}} +\newcommand{\cuiDA}[1]{\def\@cuiDA{#1}\@cuiDAdefinedtrue} + +\newif\if@cuiPhdefined +\@cuiPhdefinedfalse +\def\@cuiPh{CUI DA PHONE UNDEFINED% +\PackageWarning{ornltm}{No CUI designated authority phone number has been defined.}} +\newcommand{\cuiPh}[1]{\def\@cuiPh{#1}\@cuiPhdefinedtrue} + % Creating \printcui command to simplify CUI implementation \newcommand{\printcui}{ -\if@cuidefined{\centering\large\textbsf{\@cui}\par} +\begin{center} +\if@cuidefined{\large\textbsf{\par\@cui}} \else\relax \fi% +\end{center} } +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % Use the \restrict command to add qualifications to the document's restriction. @@ -93,13 +177,13 @@ % Creating \printrestrict command to simplify restricted footer \newcommand{\printrestrict}{ -\if@cuidefined % CUI supersedes restrict, so do nothing if CUI. -\else% -\if@restrictdefined{\centering\large\textbsf{\@restrict}\par} -\else\relax% -\fi% -\fi -} + \if@cuidefined % CUI supersedes restrict, so do nothing if CUI. + \else% + \if@restrictdefined{\centering\large\textbsf{\@restrict}\par} + \else\relax% + \fi% + \fi + } %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % Define ORNL title photo with default @@ -107,12 +191,13 @@ \newcommand{\reportphoto}[1]{\def\@ornltmtitlephoto{#1}} % Define uppercase names +\newcommand\ornltmforewordname{FOREWORD} \newcommand\ornltmabstractname{ABSTRACT} \newcommand\ornltmlofname{LIST OF FIGURES} \newcommand\ornltmlotname{LIST OF TABLES} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% COVER +% COVER PAGE %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % Bold sans-serif @@ -174,7 +259,6 @@ \fi% } % Adding CUI or restricted to footer if defined. -\fancyfoot{} \cfoot{% \if@cuidefined% \@restrictfootwarning{\@cui}% @@ -186,6 +270,20 @@ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% BEGIN COVER OPTIONS FOR DIFFERENT REPORT TYPES +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\newcommand{\headlinecolor}{\normalcolor} +\RequirePackage{xcolor} +\definecolor{slcolor}{HTML}{882B21} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% TECHNICAL MEMO (TM) OPTION +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\if@tm % If the tm option is set in the report, we do the following: +% \def\makecoverpage{% \newgeometry{top=0.5in,bottom=0.5in,right=.5in,left=2in} @@ -201,8 +299,7 @@ \begin{minipage}{\textwidth} \raggedleft \large\textbsf{\@reportnum} -\end{minipage} - +\end{minipage}% \vspace*{0.5\baselineskip plus 0.5fill} %% TITLE %% @@ -225,85 +322,279 @@ \vspace*{0pt \@plus 1fill} %%% AUTHOR AND DATE %%% -\begin{minipage}[c]{3in}% +\begin{minipage}[c]{2in}% \def\and{\\}% Newline between authors \large\sffamily% \setlength\tabcolsep{0pt}% +\maxsizebox*{!}{2in}{% Restrict size of author box. \begin{tabular}[t]{l}% - \@author% +\@author% \end{tabular} - +} \vspace*{1\baselineskip \@plus 1\baselineskip \@minus 1\baselineskip} \large\textbsf{\@date} \end{minipage}% -\begin{minipage}[c]{3in}% +% +\begin{minipage}[c]{4in}% % Check if document is a draft to determine boxed notices. -\if@reportdraft{ -\begin{framed} -\centering% - \textbsf{\large Draft. Document has not been reviewed and approved for public release.}% -\end{framed} -} -\fi +\if@reportdraft{% +\if@cradaprotecteddefined{% +}\else% + \if@cradadefined{% Check for CRADA. It has a bespoke notice. + \begin{center} + \begin{framed} + \textbsf{\normalsize CRADA draft. Document has not been reviewed and approved for public release.}% + \end{framed} + \end{center} + \vspace{1em} + }% + \else{% +\begin{center} + \textbsf{\normalsize Draft. Document has not been reviewed and approved for public release.}% +\end{center} +\vspace{1em} + }% +\fi% +\fi% +}% +\fi% % Configure notices for front cover. \if@cuidefined% \relax % No CUI notice needed, so do nothing. \else % Otherwise, check for restrict. \if@restrictdefined{% If restrict is defined in document, then print box. -\begin{framed} - \centering% - \printrestrict% -\end{framed} +\begin{center} +\printrestrict% +\end{center} +\vspace{1em} }% \fi \fi -\if@cradadefined{% CRADA is independent. Print box if defined. +\if@cradadefined{% First check if CRADA is defined. +\if@cradaprotecteddefined{% Next check to see if it is PROTECTED CRADA +\begin{framed} % Begin PROTECTED CRADA BOX IF SO. +\begin{center} +\textbsf{\normalsize\par PROTECTED CRADA INFORMATION \\}% +\end{center} +\textsf{\small +\begin{sloppypar} +This product contains Protected CRADA Information that was produced in +\underline{\smash{\@date}} under \underline{\smash{\@crada}} and is not to be further disclosed for a +period of \underline{\smash{\@cradaprotectedfirst}} from the date it was produced except as expressly +provided for in the CRADA.% +\end{sloppypar} +} +\end{framed} +\vspace{1em} +}\else% Otherwise (not protected), print CRADA final report notice. +\if@reportdraft{% +}\else{% +\begin{center} \begin{framed} - \centering% -\textbsf{\large\par CRADA final report for \\ +\textbsf{\normalsize\par CRADA final report for \\ \@crada}% \end{framed} +\end{center} +\vspace{1em} +}\fi% +\fi% +} +\fi + +% Ensure restricted, CRADA protected, and CUI documents are *not* marked for public release +% if the document is *not* marked as draft. +\if@cuidefined{% +\begin{center} +\textbsf{\normalsize Controlled by: \@cuiDA, \@cuiPh}% +\end{center} +}\else% +\if@restrictdefined{% +}\else% +\if@cradaprotecteddefined{% +}\else% +\if@reportdraft{% +}\else% +\if@cradadefined{ + \begin{center} + \begin{framed} + \textbsf{\normalsize% If not draft, CUI, or otherwise restricted, then unlimited distro. + Approved for public release. \\ + Distribution is unlimited.}% + \end{framed} + \end{center} +}\else{% +\begin{center} +\textbsf{\normalsize% If not draft, CUI, or otherwise restricted, then unlimited distro. + Approved for public release. \\ + Distribution is unlimited.}% +\end{center} +}\fi% +\fi% +\fi% +\fi% +\fi + +\end{minipage} + +\vspace*{0pt \@plus 1fill} + +\noindent\includegraphics[width=2.08in]{ornltm-logo.jpg}\\[-.15in] +\noindent\textcolor{ornlgreen}{\rule{6in}{.5pt}}\\ +\noindent{\footnotesize\sffamily ORNL IS MANAGED BY UT-BATTELLE LLC FOR THE US~DEPARTMENT OF ENERGY} + +% Added for CUI (remains blank if \cui is undefined) +\printcui +% Added for restrict (remains blank if \restrict is undefined) +\printrestrict + +\end{titlepage} +\restoregeometry }% +\fi % End conditionals for tm option. +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% SPONSOR REPORT (SPR) OPTION +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\if@spr % If the spr option is set in the report, we do the following: + +\def\makecoverpage{% +\newgeometry{top=0.25in,bottom=0.25in,right=2in,left=.5in} + +\begin{titlepage} +\thispagestyle{coverpage} +\ThisURCornerWallPaper{1.0}{ornlspr-sidebar.jpg}% + +% Added for CUI (remains blank if CUI is undefined) +\printcui + +%% REPORT NUMBER %% +\vspace*{0.5\baselineskip plus 1\baselineskip} +\begin{minipage}{\textwidth} +\flushleft +\large\textbsf{\@reportnum} \\ +\large\textbsf{\@sponsornum} +\end{minipage}% +\vspace*{0.5\baselineskip plus 0.5fill} +% + +%% TITLE %% +\begin{minipage}{\textwidth}% + \Huge\textbsf{% + \@title + } +\end{minipage}% + +\vspace*{1\baselineskip plus 1\baselineskip minus 1\baselineskip} + +%%% PHOTO %%% +\includegraphics[width=6.0in, height=4.0in]{ornlspr-titlephoto.jpg} + +\vspace{\stretch{1}} + +%%% NOTICES %%% +% If restrict and draft, show restrict + draft +% If restrict and not draft, show restrict +% If not restrict and draft, show draft +% If not restrict and not draft, show ``approved for public release" + +\begin{minipage}[c]{3in}% +% Check if document is a draft to determine boxed notices. +\if@reportdraft{ +\begin{center} + \textbsf{\normalsize Draft. Document has not been reviewed and approved for public release.}% +\end{center} +\vspace{1em} +} +\fi + +% Configure notices for front cover. +\if@cuidefined% +\relax % No CUI notice needed, so do nothing. +\else % Otherwise, check for restrict. +\if@restrictdefined{% If restrict is defined in document, then print box. +\begin{center} +\printrestrict% +\end{center} +\vspace{1em} +}% +\fi +\fi + +\if@cradadefined{% +\PackageWarning{ornltm}{CRADA requires TM option.}} \fi % Ensure restricted and CUI documents are *not* marked for public release % if the document is *not* marked as draft. -\if@restrictdefined{% -}\else% \if@cuidefined{% +\begin{center} +\textbsf{\normalsize Controlled by: \@cuiDA, \@cuiPh}% +\end{center} +}\else% +\if@restrictdefined{% }\else% \if@reportdraft\relax\else{% -\begin{framed} -\centering -\textbsf{% If not draft, CUI, or otherwise restricted, then unlimited distro. +\begin{center} +\textbsf{\normalsize% If not draft, CUI, or otherwise restricted, then unlimited distro. Approved for public release. \\ Distribution is unlimited.}% -\end{framed} +\end{center} }\fi% \fi% \fi \end{minipage} +% +\hfill{}\hspace{0.05\textwidth} +%%% AUTHOR AND DATE %%% +\begin{minipage}[c]{3in}% +\def\and{\\}% Newline between authors +\large\sffamily% +\setlength\tabcolsep{0pt}% +\maxsizebox*{!}{1.85in}{% Restricting size of author box. +\begin{tabular}[t]{l}% +\@author% +\end{tabular} +} -\vspace*{0pt \@plus 1fill} +\vspace*{1\baselineskip \@plus 1\baselineskip \@minus 1\baselineskip} -\begin{minipage}[b]{3in}% -\raggedright% -\includegraphics[width=2.08in]{ornltm-logo.jpg}% -\end{minipage}% -\begin{minipage}[b]{3in}% -\footnotesize\@affiliation -\vspace{1ex}\par +\normalsize\textbsf{\@date} \end{minipage}% + + +\vspace*{0pt \@plus 1fill} + +%%% AFFILIATION BLOCK %%% +\begin{minipage}[c]{3in}% + \def\and{\\}% Newline between authors + \sffamily% + \setlength\tabcolsep{0pt}% + \maxsizebox*{!}{0.95in}{% Restricting size of affiliation box. + \begin{tabular}[t]{l}% + \@affiliation% + \end{tabular} + } +\end{minipage} + +\noindent\includegraphics[width=2.08in]{ornlspr-logo.jpg}\hspace{0.05\textwidth} +\if@SponsorLogoOnedefined{ +\noindent\includegraphics[width=1.45in]{\@SponsorLogoOne}\hspace{0.05\textwidth} +}\else\fi +\if@SponsorLogoTwodefined{ +\noindent\includegraphics[width=1.45in]{\@SponsorLogoTwo} +}\else\fi \\[-.15in] -\textcolor{ornlgreen}{\rule{6in}{.5pt}}\\ -{\footnotesize\sffamily ORNL IS MANAGED BY UT--BATTELLE LLC FOR THE US~DEPARTMENT OF ENERGY} +\noindent\textcolor{ornlgreen}{\rule{6in}{.5pt}}\\ +\noindent{\footnotesize\sffamily ORNL IS MANAGED BY UT--BATTELLE LLC FOR THE US~DEPARTMENT OF ENERGY} % Added for CUI (remains blank if \cui is undefined) \printcui @@ -312,10 +603,150 @@ \end{titlepage} \restoregeometry +}% +\fi % End conditionals for the spr option. +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% ORNL LETTER (LTR) OPTION +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\if@ltr % If the ltr option is set in the report, we do the following: + +\def\makecoverpage{% +\newgeometry{top=0.35in,bottom=0.35in,right=0.5in,left=1.25in} + +\begin{titlepage} +\thispagestyle{coverpage} +\ThisULCornerWallPaper{1.0}{ltr-background.png}% + +% Added for CUI (remains blank if CUI is undefined) +\printcui + +%% REPORT NUMBER %% +\vspace*{0.5\baselineskip plus 1\baselineskip} +\begin{minipage}{\textwidth} +\raggedleft +\large\textbsf{\@reportnum} +\end{minipage}% + +\vspace*{0.5\baselineskip plus 0.5fill} + +%% TITLE %% +\begin{minipage}{\textwidth}% + \Huge\textbsf{% + \@title + } +\end{minipage}% + +\vspace*{1\baselineskip plus 1\baselineskip minus 1\baselineskip} + +%%% GRADIENT LINE %%% +\hspace*{-1.25in}\includegraphics[width=8.5in, height=0.13in]{ltr-gradient-bar.png}% +\vspace*{3.25in} + +%%% NOTICES %%% +% If restrict and draft, show restrict + draft +% If restrict and not draft, show restrict +% If not restrict and draft, show draft +% If not restrict and not draft, show ``approved for public release" + +%%% AUTHOR AND DATE %%% +\begin{minipage}[c]{3in}% + \def\and{\\}% Newline between authors + \large\sffamily% + \setlength\tabcolsep{0pt}% + \maxsizebox*{!}{2.5in}{% + \begin{tabular}[t]{l}% + \@author% + \end{tabular} + } + +\vspace*{1\baselineskip \@plus 1\baselineskip \@minus 1\baselineskip} + +\normalsize\textbsf{\@date} +\end{minipage}% +% +\begin{minipage}[c]{3in}% + +% Check if document is a draft to determine boxed notices. +\if@reportdraft{ +\begin{center} + \textbsf{\normalsize Draft. Document has not been reviewed and approved for public release.}% +\end{center} +\vspace{1em} +} +\fi + +% Configure notices for front cover. +\if@cuidefined{% No CUI notice needed, so do nothing. +}\else % Otherwise, check for restrict. +\if@restrictdefined{% If restrict is defined in document, then print box. +\begin{center} +\printrestrict% +\end{center} +\vspace{1em} } +\fi +\fi + +\if@cradadefined{\PackageWarning{ornltm}{CRADA requires TM option.}} +\fi + +% Ensure restricted and CUI documents are *not* marked for public release +% if the document is *not* marked as draft. +\if@cuidefined{% +\begin{center} +\textbsf{\normalsize Controlled by: \@cuiDA, \@cuiPh}% +\end{center} +}\else% +\if@restrictdefined{% +}\else% +\if@reportdraft\relax\else{% +\begin{center} +\textbsf{\normalsize% If not draft, CUI, or otherwise restricted, then unlimited distro. + Approved for public release. \\ + Distribution is unlimited.}% +\end{center} +}\fi% +\fi% +\fi + +\end{minipage} +\vspace*{0pt \@plus 1fill} + +\begin{minipage}{\textwidth}% +\hspace*{-0.25in}\textcolor{white}{{\footnotesize\sffamily ORNL IS MANAGED BY UT-BATTELLE LLC FOR THE US~DEPARTMENT OF ENERGY}} +\vspace{3em} +% +\if@restrictdefined{ +\if@cuidefined{ % If CUI defined, then do nothing. CUI printed below. +}\else % Otherwise, use the following spacing. + \vspace{-1.5em} + \textcolor{white}{\printrestrict}% +\fi +}\else +\fi +% +\if@cuidefined{ + \vspace{-1.5em} + \textcolor{white}{\printcui} +}\else +% +\fi +\end{minipage}% +\end{titlepage} +\restoregeometry +}% +\fi % End conditionals for the ltr option. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% OSTI + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% END COVER OPTIONS FOR DIFFERENT REPORT TYPES +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% OSTI NOTICE PAGE %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % Email URL command @@ -337,26 +768,31 @@ \textbf{DOCUMENT AVAILABILITY} \end{center} -\textbf{\textit{Online Access:}} US Department of Energy (DOE) reports produced after 1991 and a growing number of pre-1991 documents are available free via \href{https://www.osti.gov/}{https://www.osti.gov/}. \\ +\textbf{\textit{Online Access:}} US Department of Energy (DOE) reports produced +after 1991 and a growing number of pre-1991 documents are available free via +\href{https://www.osti.gov/}{https://www.osti.gov/}. \\ -The public may also search the National Technical Information Service's \href{https://ntrl.ntis.gov/NTRL/}{National Technical Reports Library (NTRL)} for reports not available in digital format. \\ +The public may also search the National Technical Information Service's +\href{https://ntrl.ntis.gov/NTRL/}{National Technical Reports Library (NTRL)} +for reports not available in digital format. \\ -DOE and DOE contractors should contact DOE's Office of Scientific and Technical Information (OSTI) for reports not currently available in digital format: \\ +DOE and DOE contractors should contact DOE's Office of Scientific and Technical +Information (OSTI) for reports not currently available in digital format: \\ \begin{quote} - US Department of Energy \\ - Office of Scientific and Technical Information \\ - PO Box 62 \\ - Oak Ridge, TN 37831-0062 \\ - \textbf{\textit{Telephone:}} (865) 576-8401 \\ - \textbf{\textit{Fax:}} (865) 576-5728 \\ - \textbf{\textit{Email:}} \href{mailto:reports@osti.gov}{reports@osti.gov} \\ - \textbf{\textit{Website:}} \href{https://www.osti.gov/}{https://www.osti.gov/} \\ +US Department of Energy \\ +Office of Scientific and Technical Information \\ +PO Box 62 \\ +Oak Ridge, TN 37831-0062 \\ +\textbf{\textit{Telephone:}} (865) 576-8401 \\ +\textbf{\textit{Fax:}} (865) 576-5728 \\ +\textbf{\textit{Email:}} \href{mailto:reports@osti.gov}{reports@osti.gov} \\ +\textbf{\textit{Website:}} \href{https://www.osti.gov/}{https://www.osti.gov/} \\ \end{quote} }} -\vspace{\fill} +\vspace{0.5in} \fbox{\parbox{4in}{ This report was prepared as an account of work sponsored by an agency of the @@ -367,10 +803,10 @@ usefulness of any information, apparatus, product, or process disclosed, or represents that its use would not infringe privately owned rights. Reference herein to any specific commercial product, process, or service by trade name, trademark, manufacturer, or otherwise, does not necessarily constitute or imply -its endorsement, recommendation, or favoring by the United States Government -or any agency thereof. The views and opinions of authors expressed herein do -not necessarily state or reflect those of the United States Government or any -agency thereof.}} +its endorsement, recommendation, or favoring by the United States Government or +any agency thereof. The views and opinions of authors expressed herein do not +necessarily state or reflect those of the United States Government or any agency +thereof.}} \vspace*{.5in} @@ -382,6 +818,97 @@ agency thereof.}} \end{titlepage} } + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% CRADA INSTRUCTIONS PAGE +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\newcommand\makecradapage{% +\if@tm{% +\if@cradadefined{% + +\begin{titlepage} + \pagestyle{coverpage} + \ifpdf + % This part will only be included if using PDFTeX + \IfFileExists{ORNL-851-complete.jpg} + {% File exists + \begin{figure}[ht] + \centering + \includegraphics[width=\textwidth, height=\textheight, keepaspectratio]{ORNL-851-complete.jpg} + \end{figure} + } + {% File does not exist + \noindent + \section*{ORNL-851 Form} + + Once your CRADA document is final, please fill out the \texttt{ORNL-851.pdf} + form that resides in this repository. You can also download \texttt{ORNL-851.pdf} from the + \href{https://ornl.sharepoint.com/sites/forms/ornl/Forms/Forms\%20View.aspx}{ + ORNL forms webpage}. + + \subsection*{Instructions for Overleaf/ShareLaTeX} + \begin{enumerate} + \item Download \texttt{ORNL-851.pdf} from your project or from the + \href{https://ornl.sharepoint.com/sites/forms/ornl/Forms/Forms\%20View.aspx}{ORNL + forms webpage}. + \item Open the form in Adobe Acrobat and fill it out. + \item Once complete, in Acrobat select \textsf{File} $\rightarrow$ \textsf{Export + to...} $\rightarrow$ \textsf{Image} $\rightarrow$ \textsf{JPEG}. + \item Save the file as \texttt{ORNL-851-complete.jpg}. + \item Upload \texttt{ORNL-851-complete.jpg} to your Overleaf/ShareLaTeX + project's main path. + \item Recompile document. + \end{enumerate} + Your completed form should appear on the third page, thereby replacing + these instructions. + + \subsection*{Instructions for Local/Repository} + + \begin{enumerate} + \item Navigate to your project's main path. + \item Find and open \texttt{ORNL-851.pdf} or download + a copy from the + \href{https://ornl.sharepoint.com/sites/forms/ornl/Forms/Forms\%20View.aspx}{ORNL + forms webpage}. + \item Open the form in Adobe Acrobat and fill it out. + \item Once complete, in Acrobat select \textsf{File} $\rightarrow$ \textsf{Export + to...} $\rightarrow$ \textsf{Image} $\rightarrow$ \textsf{JPEG}. + \item Save the file as \texttt{ORNL-851-complete.jpg} in your project's + main path. + \item Recompile document. + \end{enumerate} + Your completed form should appear on the third page, thereby replacing + these instructions. + + \begin{figure}[ht] + \centering + \begin{minipage}{0.5\textwidth} + \centering + \includegraphics[width=8cm,height=5.5cm]{form-ORNL-851-instructions.png} + \caption*{Export JPEG from Acrobat.} + \end{minipage}% + \begin{minipage}{0.5\textwidth} + \centering + \includegraphics[width=8cm,height=5.5cm]{upload.png} + \caption*{Upload button in Overleaf/ShareLaTeX.} + \end{minipage} + \end{figure} + + } +\else + % This part will only be included if not using PDFTeX + \noindent + \textbf{This document requires PDFLaTeX.} +\fi +\end{titlepage} +\clearpage +} +\fi% +}% +\fi% +} % End \makecradapage command +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % TITLE %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -402,12 +929,14 @@ agency thereof.}} %%% TITLE %%% {\Large\textbf{\MakeUppercase{\@title}}} -\vspace{3\baselineskip}% +\vspace{\stretch{1}}% -%%% TITLE %%% +%%% AUTHOR %%% +\maxsizebox*{!}{3.75in}{% Restrict size of author box. \begin{tabular}[t]{c}% - \@author% + \@author% \end{tabular}% +} \vspace{\stretch{.5}} @@ -420,7 +949,7 @@ Prepared by \\ OAK RIDGE NATIONAL LABORATORY \\ Oak Ridge, TN 37831 \\ managed by \\ -UT--BATTELLE LLC \\ +UT-BATTELLE LLC \\ for the \\ US DEPARTMENT OF ENERGY \\ under contract DE-AC05-00OR22725 @@ -452,11 +981,19 @@ under contract DE-AC05-00OR22725 \pagenumbering{roman}% \setcounter{page}{1}% \makeostipage% + \makecradapage% NEW: Adds CRADA instructions to TM. \maketitlepage% \cleardoublepage \setcounter{page}{3}% } +% Adds foreword environment. +\newenvironment{foreword}{% + \addcontentsline{toc}{section}{\ornltmforewordname} + \phantomsection + \section*{\ornltmforewordname}% +} + % Abstract gets a new page if it's in the front matter; otherwise it's just at % the top of the page. \renewenvironment{abstract}{% @@ -519,12 +1056,12 @@ under contract DE-AC05-00OR22725 % CAPTION STYLES %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\RequirePackage[font=bf,labelsep=period]{caption} +\RequirePackage[font=bf,labelsep=period,justification=centering]{caption} % Caption with more than one sentence: the first sentence is the first argument, % the rest are the second. This allows table of contents to just show the first % sentence but display the whole thing in the text. It also clears the boldface -% from the second +% from the second part. \newcommand\longcaption[2]{\caption[#1]{#1 \normalfont #2}} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -546,7 +1083,7 @@ under contract DE-AC05-00OR22725 \vspace{\fill} \textcolor{ornlgreen}{\rule{\textwidth}{.5pt}} - + % Added for CUI (remains blank if CUI is undefined) \printcui % Added for restrict (remains blank if \restrict is undefined)