Merge branch 'upstream-updates' into 'main'

*.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

# 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 `<USERNAME>` with your actual user name):

```console

$ make install

cp -rp ornltm /Users/s3j/Library/texmf/tex/latex/

cp -rp ornltm /Users/<USERNAME>/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 `<USERNAME>` with your actual user name).

```console

$ kpsewhich ornltm.cls

/Users/s3j/Library/texmf/tex/latex/ornltm/ornltm.cls

/Users/<USERNAME>/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                                 |

| ------------        | -----------------------------------------   |

| `\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. |

- 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.

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)

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% 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