Add documentation and update makefile

*.synctex.gz

*.temp

*.toc

*.fdb_latexmk

#

fileinfo	:= LaTeX Makefile

author		:= Chris Monson

version		:= 2.2.1-alpha9

version		:= 2.2.1

#

.DEFAULT_GOAL	:= all

# Note that the user-global version is imported *after* the source directory,

#

#

# CHANGES:

# Chris Monson (2020-12-11):

# * Fix bcf datasource collection, add some tests, thanks to k4rtik on issue 126

# Chris Monson (2018-11-28):

# * Add bcf datasource collection for biber - thanks to llbit on issue 126

# Chris Monson (2014-09-04):

# * Allow graphic dependencies in texmf directories (anything .fls knows about).

# Chris Monson (2014-02-14):

# Escape dots and forward slashes.

# $(call escape-fname-regex,str)

escape-fname-regex	= $(subst /,\\/,$(subst .,\\.,$1))

escape-fname-regex	= $(subst /,\/,$(subst .,\.,$1))

# Test that a file exists

# $(call test-exists,file)

test-exists		= [ -e '$1' ]

# $(call test-not-exists,file)

test-not-exists   = [ ! -e '$1' ]

# $(call test-non-empty,file)

test-non-empty    = [ -s '$1' ]

# $(call move-files,source,destination)

move-if-exists		= $(call test-exists,$1) && $(MV) '$1' '$2'

# Extensions generated by LaTeX invocation that can be removed when complete

rm_ext		:= \

	log *.log aux $(pre_pdf_extensions) pdf blg bbl out nav snm toc lof lot lol pfg \

	acn acr alg fls vrb idx ind ilg glg glo gls lox nls nlo nlg brf mtc* mlf* mlt* maf brf ist fmt

	fls vrb idx ind ilg glg glo gls lox nls nlo nlg brf mtc* mlf* mlt* maf brf ist fmt

backup_patterns	:= *~ *.bak *.backup body.tmp head.tmp

graph_stem	:= _graph

$(SED) \

-e 's/^No file \(.*\.ind\)\.$$/TARGETS=\1/' \

-e 's/^No file \(.*\.[gn]ls\)\.$$/TARGETS=\1/' \

-e 's/^No file \(.*\.acr\)\.$$/TARGETS=\1/' \

-e 's/[[:space:]]/\\&/g' \

-e '/^TARGETS=/{' \

-e '  h' \

$(SORT) | $(UNIQ)

endef

# Outputs bcf bibs to stdout. Arg 1 is the bcf file stem, arg 2 is the

# list of targets for each dependency found.

define get-bcf-bibs

if $(call test-non-empty,$1); then \

  $(SED) \

-e '/datasource/!d' \

-e 's/^[^>]*>//g' \

-e 's/<.*$$//g' \

-e '/\.bib$$/!s/$$/.bib/' \

-e 's!^!$2: !' \

'$1' | $(SORT) | $(UNIQ); \

fi

endef

# Makes a an aux file that only has stuff relevant to the target in it

# $(call make-auxtarget-file,<flattened-aux>,<new-aux>)

define make-auxtarget-file

# $(call colorize-latex-errors,<log file>)

define colorize-latex-errors

$(SED) \

-e 's/^)$$//' \

-e '$${' \

-e '  /^$$/!{' \

-e '    H' \

-e '  s//\1 --- Are you trying to build an include file?/' \

-e '  b error' \

-e '}' \

-e '/^Runaway argument?/{' \

-e '  s/I'"'"'ll try to recover.*//' \

-e '  b error' \

-e '}' \

-e '/.*\(!!! .*Undefined control sequence\)[^[:cntrl:]]*\(.*\)/{' \

-e '  s//\1: \2/' \

-e '  s/\nl\.[[:digit:]][^[:cntrl:]]*\(\\[^\\[:cntrl:]]*\).*/\1/' \

# $(call make-ps,<dvi file>,<ps file>,<log file>,[<paper size>],[<beamer info>])

make-ps		= \

	$(DVIPS) -z -o '$2' $(if $(strip $4),-t$(strip $4),) '$1' \

		$(if $5,| $(enlarge_beamer)) > $3 2>&1

		$(if $(strip $5),| $(enlarge_beamer)) > $3 2>&1

# Convert Postscript to PDF

# $(call make-pdf,<ps file>,<pdf file>,<log file>,<embed file>)

	$(QUIET)$(call echo-build,$<,$@)

	$(QUIET)$(call run-makeindex,$<,$@,$*.glg,$*.ist)

# Create an acronym file from a .ist file

%.acr:	%.acn %.tex %.ist

	$(QUIET)$(call echo-build,$<,$@)

	$(QUIET)$(call run-makeindex,$<,$@,$*.alg,$*.ist)

# Create a glossary file from a glossary input formatted for xindy

%.gls:	%.glo %.tex %.xdy

	$(QUIET)$(call echo-build,$<,$@)

	$(call get-graphics,$*) >> $*.d; \

	$(call get-log-index,$*,$(addprefix $*.,aux aux.make)) >> $*.d; \

	$(call get-bibs,$*.aux.make,$(addprefix $*.,bbl aux aux.make)) >> $*.d; \

	$(call get-bcf-bibs,$*.bcf,$(addprefix $*.,bbl aux aux.make)) >> $*.d; \

	$(EGREP) -q "# MISSING stem" $*.d && $(SLEEP) 1 && $(RM) $*.pdf; \

	$(EGREP) -q "# MISSING format" $*.d && $(RM) $*.pdf; \

	$(call move-if-exists,$*.$(build_target_extension),$*.$(build_target_extension).1st.make); \

clean-nographics: clean-tex clean-deps clean-backups clean-auxiliary ;

.PHONY: clean-extra

	$(QUIET)$(call clean-files,$(clean-extra))

clean-extra:

	$(QUIET)$(call clean-files,$(cleanextra))

.PHONY: clean

clean: clean-generated clean-tex clean-graphics clean-deps clean-backups clean-auxiliary clean-extra ;

#     log -> dot [label="Graphic file"]

#     log -> idx [label="No file *.ind"]

#     log -> glo [label="No file *.gls"]

#     log -> acn [label="No file *.acr"]

#     log -> nlo [label="No file *.nls"]

#     gpi -> gpi_data [label="plot '...'"]

#     gpi -> gpi_includes [label="load '...'"]

onlysources.tex	?= ornl-template-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)

export TEXINPUTS := .:$(CURDIR)/../ornltm:$(_saved_TEXINPUTS)

\date{\today}

% Define report number.

% Note: Defining the report number causes the 'draft' notices to be removed.

% Remove comment "%" below if that is desired.

%\reportnum{ORNL/TM-2016/XXX}

% Define division/directorate name. Replace "Division Name" with your

% Add a restriction notice to the cover page. Remove comment "%" below if that

% is desired.

\restrict\draft

\restrict{Not for public release.}

% \restrict{Official use only}

% \restrict{Official use only}

% \restrict{Business Sensitive}

%\restrict{Not for public release.}

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

% ACRONYMS

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

% DOCUMENT CONTENT

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

\section{First-Order Heading}

\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

final output.

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

\subsection{Second-Order Heading}

\subsection{SECOND-ORDER HEADING}

Begin text here.

\section{Figure Placement}

\label{sec:figures}

\subsection{Figures}

\subsection{FIGURES}

Insert figures after the text callout but as close to the call out as possible.

(They always have a caption describing them and they are always numbered. LaTeX

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

\section{Table Placement}

\section{TABLE PLACEMENT}

\label{sec:tables}

\subsection{Tables}

\subsection{TABLES}

As with figures, tables are numbered consecutively, or consecutively by section,

and should follow their call out (see Table \ref{tab:1}) in the text as closely

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

\section{Citations}

\section{CITATIONS}

\label{sec:citations}

\subsection{Using In-Text 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.

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

\section{Lists}

\section{LISTS}

\label{sec:lists}

Flanges used in ultra-high vacuum service are commonly closed with metallic

    sealed.

\end{itemize}

\subsection{Second-Order Heading}

\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

% APPENDICES

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

\appendix

\section{First Appendix}

\section{FIRST APPENDIX}

\label{sec:firstapp}

If each appendix contains similarly formatted text as the body of the document

\end{equation}

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

\section{Second Appendix}

\section{SECOND APPENDIX}

\label{sec:secondapp}

If each appendix contains similarly formatted text as the body of the document

\PackageWarning{ornltm}{No division name has been defined.}}

\newcommand{\division}[1]{\def\@division{#1}\@divisiondefinedtrue}

% Use the \reportnum command to define a report number. If undefined, the

% document is a draft.

% Use the \reportnum command to define a report number.

\newif\if@reportnumdefined

\@reportnumdefinedfalse

\def\@reportnum{ORNL/TM-XXXX/XXX%