Latex-Template and information

Visual elements like images can significantly enhance the understanding of complex information at a glance. They add color and dynamics, offering a visual break from continuous, monotonous text, thus maintaining reader engagement. Therefore, do incorporate them effectively in your document to enrich the reader's experience and aid in the comprehension of your material.

Criteria for Figures

Your figures should adhere to specific criteria:

• Content: Select content that is most relevant and illustrative of your point.
• Resolution: Opt for scalable vector graphics (such as SVG) or high-resolution images (minimum 300dpi). For diagrams or charts, consider using LaTeX-native graphics like TikZ or PGF.
• Colors: The choice of color depends on your printing method:
  • Colored: Use colors with significant contrast in hue, saturation, and lightness. You can find various color palettes online that suggest harmonious combinations. Ideally, choose palettes that are accessible to those with color vision deficiencies [^1] [^2]. In your descriptions, opt for universally recognized color names like "dark red" or "light blue" rather than obscure ones.
  • Gray scale: If printing in gray scale, ensure adequate contrast between different shades. Avoid using very light grays as they might not print well. In diagrams, differentiate elements through distinct shapes or strokes, as you would with color.
• Dimensions: Figures do not necessarily have to span the entire page width. They should be appropriately scaled (e.g., to 60%) and centered.
• Scaling: Maintain consistent scale across similar types of figures, such as bar charts, ensuring uniform bar widths and font sizes.
• Labeling: Ensure that all diagrams are fully labeled, particularly the axes. Utilize legends or detailed captions to explain each component's significance. Captions appear in the lists of figures and should be informative yet concise; if needed, provide a shortened version for lengthy descriptions.

Layout

LaTeX's layout algorithms automatically place figures, tables, and listings in your text.

Unfortunately, these positions are not always ideal. Still, you should not waste time tweaking their positions throughout the writing process; it's more efficient to adjust their placement only towards the end, once your full text is finished.

If you need to reposition these elements manually, it is advisable to position them preferably only at the top or only at the bottom of the page. This approach prevents isolated lines of text from getting sandwiched between them.

When multiple graphics are related or shall be compared, you can place them together on a special page. This page will then contain only graphics, no text.

In the figure, table and listings environments, prefer the position arguments `t` for top of the page, or `p` for a special page.

Simple figures

If you have an existing image, including it in your document is straightforward, as demonstrated with Figure 1. Additionally, it's essential to accompany each image with a descriptive caption that explains the image's content, including relevant details like colors, shapes, and groups. This is also the appropriate place to cite the source of the image using the \cite command if it is not originally yours. For the List of Figures, you may provide a shortened version of the caption if necessary. Lastly, assigning a label to the figure is crucial, as it enables you to refer to the figure elsewhere in your text efficiently. This approach ensures that your figures are not only well-integrated but also informative and correctly referenced.

\begin{figure}[t]
\centering
\includegraphics[width=.3\textwidth]{imgs/latex}
\caption[Example figure]{An included image file showing the writing \LaTeX{}. Source: \cite{sample:wiki:latexlogo}}
\label{fig:sample-latex}
\end{figure}

Subfigures

If you provide related figures, use subfigures as shown in Figure 2. Assign individual captions and labels to each subfigure and an overall caption and label for the entire group.

\begin{figure}[t]
\centering
\subcaptionbox
[Black text on white background]
{Black text on white background. Source: [1]}
[.48\textwidth]
{\includegraphics{samples/imgs/latex}}
\hfill
\subcaptionbox
[White text on black background]
{White text on black background. Adopted from: [1]}
[.48\textwidth]
{\includegraphics{samples/imgs/latex_dark}}
\caption[Figure with two subfigures]
{An example figure that contains two related subfigures.}
\label{fig:subfigures}
\end{figure}

TikZ and PGF

For creating graphs consider using the TikZ and PGF packages. With these, similar to LaTeX, you simply supply the content and select a style; the layout is then generated automatically.

Many mathematics and statistics applications support direct export to TikZ and PGF formats.
In R you can use the `tikzDevice` library and in Python projects with `matplotlib` you can use the `tikzplotlib` library to transform your graph into TikZ.

Note, TikZ consists of various libraries tailored for specific functionalities, so you may need to incorporate additional ones depending on your needs. To do this, include the necessary libraries using the command `\usetikzlibrary` in your `main.tex` file.

Utilize tables to present structured data effectively, like comparisons or evaluation results.

Ensure all essential information is included and clearly label each column and/or row. Also, provide a descriptive caption to concisely explain the table's content.

However, avoid overcrowding tables. It's often more effective to split dense tables into smaller ones to enhance clarity and underscore their significance.

In terms of design, use lines sparingly as separators: typically, a table requires only three lines:

- `\toprule` above the header,
- `\midrule` below the header, and
- `\bottomrule` at the bottom.

This minimalist approach takes advantage of cell alignment and spacing to naturally delineate the data. For more complex structures, like in Table 2, only a few additional lines may be necessary.

Creating tables

Creating tables manually is a very tedious task. We recommend the [Tables Generator](https://www.tablesgenerator.com/), which provides you with a graphical user interface.

Table environments

LaTeX offers several table environments, including `tabular`, `tabular*`, and `tabularx`. These differ in layout, column styling, and compatibility. Choose the format that best fits your data. While `tabular*` is a good starting point, switch to `tabular` or `tabularx` as needed based on the specific requirements of your table.

Examples

\begin{table}[]
\centering
\begin{tabular}{l|rr} \toprule
\thead{Task} & \thead{Group 1} & \thead{Group 2} \\ \midrule
A & 15 & 4 \\
B & 22 & 23 \\
C & 3 & 4 \\
D & 15 & 13 \\ \bottomrule
\end{tabular}
\caption{A simple table (tabular)}
\label{tab:simple}
\end{table}

\RequirePackage{tabularx} // from template.sty
\begin{table}[t]
\centering
\begin{tabularx}{0.8\linewidth}{XX} \toprule
\thead{Pros} & \thead{Cons} \\ \midrule
\vspace{-\topsep}
\begin{itemize}[topsep=0pt, partopsep=0pt, nosep, before=\setstretch{1}]
\item structured
\item easy to read
\item not too verbose
\item compact
\end{itemize}
\vspace{-\topsep}
&
\vspace{-\topsep}
\begin{itemize}[topsep=0pt, partopsep=0pt, nosep, before=\setstretch{1}]
\item sometimes hard to layout 
\item need to be simplified 
\item might require further explanations in the text
\end{itemize}
\vspace{-\topsep} \\[-\topsep] \bottomrule
\end{tabularx}
\caption{A table with enumerations (tabularx)}
\label{table:sample-pros-cons}
\end{table}

\RequirePackage{multicol} // from template.sty
\begin{table}[t]
\centering
\begin{tabular*}{\linewidth}{@{\extracolsep{\fill}}llllr} \toprule
\thead{Category} 
& \multicolumn{2}{l}{\thead{Tool (long title over two columns)}}
& \thead{For} & \thead[l]{Random} \\
& \thead{Developer} & thead{Name} & & \thead[l]{Number} \\ \midrule
Version & GitHub & Git & Git & 456 \\
Control & GitLab & Git & Git & 75452 \\ \midrule
IDE & Jetbrains & CLion & C/C++ & 7856632 \\
& Jetbrains & IntelliJ IDEA & Java/Kotlin & 1566 \\
& Jetbrains & Webstorm & HTML, CSS, Javascript & 379194 \\
& Misrosoft & Visual Studio Code & C/C++ & 751 \\ \midrule
Editor & & Sublime Text & anything & 132 \\
& & Overleaf & \LaTeX{} & 1337 \\ \bottomrule
\end{tabular*}
\caption{A complex table (tabular*)}
\label{table:sample-tools}
\end{table}