Skip to content

Latest commit

 

History

History
91 lines (72 loc) · 2.42 KB

LaTeX_guidelines.md

File metadata and controls

91 lines (72 loc) · 2.42 KB
Raw

LaTeX Guidelines for the Final Report

Version on Dec 14, 2021.

This document is based on the guidelines proposed for the SOMAS2020 report.

Try to stick to these guidelines, and feel free to suggest other if needed. Following consistent rules will facilitate the reviewing and ensure homogeneity of the report.

  1. In the report, we need to label everything that we refer to: figures, equations, sections, subsections, subsubsections etc. Here are some important examples:

For figures:

\label{fig:XX}

For equations:

\label{eq:XX}

For sections:

\label{sec:XX}

For subsections:

\label{subsec:XX}

To refer to these labels, just use

 \Cref{your_label}

\Cref{} automatically refers to your your_label by adding the corresponding label type with a capital letter, e.g., Section, Figure, Table, etc. No need to manually add "Figure" or something like that in front.

  1. Always refer to an existing figure or table at least once in the text.

  2. Select the figure and table placement [htb] as often as possible. Avoid forcing the placement with [H] or [h!] .

  3. Write proper captions for your images. Finish your caption with a punctuation.

Example:

\begin{figure}[htb]\label{sim_res_case_1}
...
\caption{Simulation results for Case 1.}
\end{figure}
  1. Footnotes appear before the punctuation.

Example:

... at each turn\footnote{It is assumed that...}.
  1. \texttt{} style is only for referring to something related to code.

Example:

... \texttt{a.TakeFood(foodAmount)} allows the agent to ask for food.
  1. When referring to mathematical expression directly in the text (e.g., variables, simple equations), write them in the math mode using $ $.

Example:

... the agent $a_1$ has taken $x$ amount of food ...

  1. If you want to write mathematical expressions not directly in the text, use \begin{equation}\label{my_equation}... \end{equation}. Avoid using $$ ... $$, as the equation will not be numbered.

  2. Finish the itemizations/enumerations with a punctuation.

Example:

\begin{itemize}
\item The base parameters of an agent are:
    \begin{enumerate}
    \item HP
    \item Floor level.
    \end{enumerate}
\end{itemize}

  1. Write "i.e., and e.g.,, in italic and followed by a comma.

  2. Use comma appropriately. A common mistake is to forget using comma before "FANBOYS" which are:

  • for
  • and
  • nor
  • but
  • or
  • yet
  • so.