-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathFOBOS_Template.tex
173 lines (132 loc) · 5.13 KB
/
FOBOS_Template.tex
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
\documentclass[11pt,a4paper,twoside,onecolumn,openany,final,oldfontcommands]{memoir}
\usepackage{sty/FOBOS} % FOBOS SDN style file
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Things you need to edit:
% - Document name, numbering, and date; edit the newcommands below.
% - Authors list; see authors.tex
% - The contact information for the corresponding author; see corresponding.tex
% - Any (additional) tex aliases you would like to include; see aliases.tex
% - BibTex references are included using ref.bib
% - Main body of the document
% - Add a line to the revision history
\newcommand{\doclongname}{Long Document Name}
\newcommand{\docshortname}{Document abbreviation; e.g., LDN}
\newcommand{\project}{FOBOS}
\newcommand{\wbs}{WBS}
\newcommand{\doctype}{DOC}
\newcommand{\docnumber}{001}
% Pre-release versions are 0A - ZZ; Release versions should be 01-99
\newcommand{\docversion}{0A}
\newcommand{\docreleaseDate}{\today}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Document Designation Number
\newcommand{\docsysnum}{{\project}.{\wbs}.{\doctype}.{\docnumber}.V{\docversion}}
%% Set footers to use document info
%% ================================
\makeoddfoot{Ruled}{\docsysnum}{}{\thepage\ / \thelastpage}
\makeevenfoot{Ruled}{\thepage\ / \thelastpage}{}{\docsysnum}
%%% Packages for TESTING
\usepackage{lipsum}
\listfiles
%% ALIASES
\input{aliases}
%%%% BEGIN DOCUMENT
\begin{document}
\bibliographystyle{sty/aasjournal}
%%% FRONTMATTER
\frontmatter
\input{title}
\thispagestyle{empty} % Title page has no page number shown.
\clearpage
\setupmaintoc
\tableofcontents
\clearpage
\listoffigures
\clearpage
\listoftables
%: PREFACE
\chapter{Corresponding Author}
%
\input{corresponding}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% The rest of the document editing begins here
%-----------------------------------------------------------------------
% Executive Summary
\chapter{Executive Summary}
This is the template for FOBOS design documents.
%-----------------------------------------------------------------------
%-----------------------------------------------------------------------
% Main document body
\mainmatter
% Introduction
\chapter{Introduction}
Here is a reference: \citet{2019BAAS...51g.198B}.
% Chapter
\chapter{Examples}
Because many of the documents are versioned using git, we need to adopt some practices that ease/enable the git merging. Generally, try to keep paragraphs on a single line, like this one. Also try to keep other text-editor-specific changes to the format of the text to a minimum (e.g., keep items in a list on a single line, figure captions, table captions, etc). Regardless, when editing off Overleaf, make sure that you check the merging from/to the main repository to ensure your edits are correctly integrated.
The main document style is set to {\ttfamily memoir}, which has a few
modifications for lists. Two examples are shown below. Particularly
note the use of the comment character and how this affects the spacing
between the list and the adjoining paragraph.
\tightlists
\begin{enumerate}
%
\item Enumerated item in {\ttfamily memoir}, with
%
\item tight lists.
%
\end{enumerate}
%
Please also consider using {\ttfamily paralist} (already in package listing above). The following {\ttfamily paralist} enumerated environments are useful:
\begin{inparaenum}[(a)]
%
\item asparaenum
%
\item inparaenum, and
%
\item compactenum.
%
\end{inparaenum}
%
The itemized versions are also useful:
%
\begin{asparaitem}
%
\item asparaitem
%
\item inparaitem
%
\item compactitem
%
\end{asparaitem}
%
Note that the fonts for the equations are different than the text. These font changes are handled in the {\ttfamily FOBOS.sty} file. Here is an inline equation --- $E=mc^2$ --- and here is the same one but isolated and numbered:
%
\begin{equation}
E = m c^2
\end{equation}
\section{Section}
Here is a section of this chapter. Note how it is enumerated here and in the table of contents.
\subsection{Sub-section}
Subsections also appear in the table of contents.
\paragraph{Test}
There is no {\ttfamily subsubsection}; use {\ttfamily paragraph} instead (if necessary). The paragraphs just have bold text that provides the paragraph title and then the rest of the paragraph is normal, including the indentation.
\newpage
%% Chapter
\chapter*{Revision History}
\addcontentsline{toc}{chapter}{Revision History}
\begin{table}[hp]{%
\begin{tabular}{l | l | l | p{22pc}} \toprule
{\bf Version} & {\bf Date} & {\bf Editor} & {\bf Comments} \\ \midrule
% Insert your own version number with the date, your name, and a short
% description of this version of the document.
0A & 2020-07-08 & Kyle Westfall & Initial version \\ \bottomrule
\end{tabular}}
\end{table}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\bibliography{ref}
\end{document}