Commit b135edc3 authored by Johnson, Seth R.'s avatar Johnson, Seth R.
Browse files

Add documentation

parent b1b1a5d9
Loading
Loading
Loading
Loading
+19 −1
Original line number Diff line number Diff line
@@ -46,8 +46,26 @@ $ kpsewhich ornltm.cls
## Documentation

The documentation essentially consists of the
[example](./example/ornl-template-example.tex). To build the example,
[example](./example/ornl-template-example.tex). Commands that should be defined
in the document header are:

| Command      | Description                               |
| ------------ | ----------------------------------------- |
| `\author`    | Author names, joined by `\and`.           |
| `\title`     | The tech memo's title.                    |
| `\date`      | The publication date.                     |
| `\division`  | Your ORNL division name.                  |
| `\reportnum` | Report number; omit if still a draft.     |


The following commands belong in the document. They create the title pages and
set up document styling for the three main sections of the document.

| Command           | Description                               |
| ------------      | ----------------------------------------- |
| `\frontmatter`    | Create title page and set up TOC styles.  |
| `\mainmatter`     | Begin the main content of the document.   |
| `\appendix`       | Begin appendices.                         |

## Limitations