yosata/MICADO-document-template
1
0 Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Changed behavior of Change Record table, header title and acronyms.

Browse Source
This commit is contained in:
Joost van den Born committed 2021-03-09 13:56:33 +01:00
1 parent dcf2889aa1
commit 33296de618
8 files changed
+698 -444
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

main.tex
+51 -28
View File
@@ -1,35 +1,45 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% MICADO housestyle template %
% For technical notes, memos and reviews %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% CHANGES %
% -Adapted from gitlab.astro-wise.org %
% -Updated to use Helvetica font %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% MICADO housestyle template %
% For technical notes, memos and reviews %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% CHANGES %
% -Adapted from gitlab.astro-wise.org %
% -Updated to use Helvetica font %
% -Took inspiration from SRON document %
% template (https://personal.sron.nl/~pault/) %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Document preamble, adds useful packages and sets up the document.
% The micado-housestyle, based on the dmd-doc.sty file, accepts several arguments:
% The micado document housestyle, based on the dmd-doc.sty file, accepts several
% arguments:
% technote - removes title page, change record page and table of contents page.
% review - Version ready for review
% draft - Adds warning to title page that the document concerns a draft version.
% draft - Adds warning to title page and header that the document is a draft
% version.
\documentclass[twoside,11pt,a4paper]{article}
\input{template_files/layout}
\usepackage[technote]{template_files/housestyle-micado} % Place argument within brackets
\usepackage[draft]{micado} % micado.sty defines the layout of the document. Place
% argument within brackets
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% General Document information
\dmdTitle{Document title} % Document title
\dmdDocId{XXX-XXX-XXX-XXXXX-XXXX} % Document number
\dmdIssue{0.2} % Version number
\dmdDate{\today} % Date
\dmdPreparedBy{Author Name} % Author(s)
\dmdPreparedOn{\today} % Date to appear on the document?
% Change record
\dmdChangeRecord{ % Change record table. Fill as a four column table.
1.0 & 09/03/2021 & All & Initial document \\
}
% Only for (draft)review
\dmdPreparedSig{} % Who is submitting the document?
\dmdApprovedBy{} % Who approved the document?
\dmdApprovedOn{} % When is the document approved?
@@ -47,10 +57,13 @@
% Title page
\dmdmaketitle % Generates a title page (if necessary) with the provided info
% For a full document, the table of contents and change record is printed.
% For a technical note, this is omitted
% For a technical note, only the change record table is printed.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% The MICADO documentation typically contain the following sections:
% - Scope
@@ -71,7 +84,9 @@
% (ApplicableDocuments.bib) will be printed automatically.
% For reference documents, only those documents that are cited in the text are printed.
\subsection{Applicable Documents}\label{sec:AD}
The following \ac{AD} of the exact issue contain provisions (statements, instructions, recommendations or requirements) that are ruling over - and implicate provisions in the present document.
The following \ac{AD} of the exact issue contain provisions (statements, instructions,
recommendations or requirements) that are ruling over - and implicate provisions in the
present document.
\nocite{*} % This nocite is necessary for printing all applicable documents!
\begin{refcontext}[labelprefix=AD]
@@ -79,20 +94,22 @@ The following \ac{AD} of the exact issue contain provisions (statements, instruc
\end{refcontext}
\subsection{Reference Documents}\label{sec:RD}
The following \ac{RD} contains useful information relevant to the subject of the present document.
The following \ac{RD} contains useful information relevant to the subject of the present
document.
\begin{refcontext}[labelprefix=RD]
\printbibliography[heading=none, keyword={RD}]
\end{refcontext}
\subsection*{Acronyms}
\newpage
\subsection{Acronyms}
% A list of Acronyms is often useful to go back to the meaning of an acronym.
% Acronyms used in the text with \ac{}, \acs{}, \acl{} or anything similar
% will be printed automatically in the following list. If you want all
% acronyms to be printed, check under OTHER in template_files/layout.tex and
% set \usepackage[printonlyused]{acronym} to \usepackage[]{acronym}
\input{template_files/acronyms.tex}
\pagebreak
% set \usepackage[printonlyused]{acronym} to \usepackage[]{acronym}. Note
% that this might raise a lot of warnings, but does work (on overleaf).
\input{acronyms}
\newpage
% Start of document contents
@@ -100,11 +117,14 @@ The following \ac{RD} contains useful information relevant to the subject of the
\blindtext
\subsection{A subsection with references}
There is no reference to AD1, but there is a reference to \cite{old-stuff}. Nonetheless, both get printed in Section~\ref{sec:AD}!
There is no reference to AD1, but there is a reference to \cite{old-stuff}. Nonetheless,
both get printed in Section~\ref{sec:AD}!
This is a reference to a Reference Document: \cite{MICADO-operational_concept}. Only reference documents that are cited in the text are printed in Section~\ref{sec:RD}.
This is a reference to a Reference Document: \cite{MICADO-operational_concept}. Only
reference documents that are cited in the text are printed in Section~\ref{sec:RD}.
\acs{PSF} is shorthand for \acl{PSF}. A quick way to say the same, would have been to write: \ac{PSF}.
The \ac{MICADO} is an upcoming instrument for the \ac{ELT}. \acs{PSF} is shorthand for
\acl{PSF}. A quick way to say the same, would have been to write: \ac{PSF}.
\section{A section with a table, figures and an equation}
\begin{figure}
@@ -116,7 +136,8 @@ This is a reference to a Reference Document: \cite{MICADO-operational_concept}.
\begin{table}
\centering
\caption{The system model constants as used in the analyses. Since the three smaller wheels are identical, these generally have the same values for the constants.}
\caption{The system model constants as used in the analyses. Since the three smaller
wheels are identical, these generally have the same values for the constants.}
\begin{tabular}{llSll}
\toprule
Type & Constant & \multicolumn{1}{c}{Value} & Unit & Note \\ \midrule
@@ -137,7 +158,9 @@ Spring constant & $K$ & 0.924 & Nm deg$^{-1}$ & Torsional stiffness of axial cou
\end{tabular}
\label{table:constants}
\end{table}
Table~\ref{table:constants} shows the constants and values used in a model. Figure~\ref{fig:paraxial} is interesting, but Figs.~\ref{fig:small_fig1} and \ref{fig:small_fig2} are the same!
Table~\ref{table:constants} shows the constants and values used in a model.
Figure~\ref{fig:paraxial} is interesting, but Figs.~\ref{fig:small_fig1} and
\ref{fig:small_fig2} are the same!
We could also discuss some equations. Look at eq.~\eqref{eq:einstein}, for example.
\begin{equation}
@@ -151,7 +174,7 @@ We could also discuss some equations. Look at eq.~\eqref{eq:einstein}, for examp
\begin{minipage}[t]{.47\textwidth}
\centering
\captionsetup{width=0.95\linewidth}
\includegraphics[width=0.6\linewidth]{template_files/Micado_logo.png}
\includegraphics[width=0.6\linewidth]{micado_logo.png}
\captionof{figure}{Here's one image of the MICADO logo}
\label{fig:small_fig1}
\end{minipage}%
@@ -159,7 +182,7 @@ We could also discuss some equations. Look at eq.~\eqref{eq:einstein}, for examp
\begin{minipage}[t]{.47\textwidth}
\centering
\captionsetup{width=0.95\linewidth}
\includegraphics[width=0.6\linewidth]{template_files/Micado_logo.png}
\includegraphics[width=0.6\linewidth]{micado_logo.png}
\captionof{figure}{Here's another copy of the MICADO logo}
\label{fig:small_fig2}
\end{minipage}%