diff --git a/README.md b/README.md index e69de29..07af7fb 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,47 @@ +# Initial Information +This is a LaTeX Template Repo to create other Documents. The contents include: +|Filename|Description| +|--|--| +|`main.tex`|Main LaTeX File where the contents of the document belong into| +|`bibliography.bib`|Bibliography list for citing with BibTeX| +|`titlepage.tex`|Title-Page of the Document as an own Folder. So that it can be designed independently.| + +Use this Template to create your own repo with the starter-documents and an integrated Action to build and publish your LaTeX-Projects on Push. +# Files +Here, the various contents and variables of the files get explained. This is especially important for the initial setup of your project. +## Titlepage.tex +The Titlepage-File defines (as the name implies) the layout and contents of the titlepage. It gets imported into the main.tex document, that you only get one PDF with all the contents in it. +### Placeholders +The File holds multiple placeholders, which should be replaced with the actual value. +|Placeholder|Meaning| +|--|--| +|``|Path to the image that is placed over the title/subtitle. Refer to the graphics-section for more information on graphic files.| +|``|Main title of the document| +|``|Subtitle of the document| + +# Use of Graphics +Using graphics in LaTeX is not difficult. It's best practice to create a new subfolder (e.g. `graphics`) in your project to store all the graphics. To embed a graphic into your document, two steps are required. First, you need to insert the graphic with all information associated with it into the document. Idealy you position this part near the position in the real document. +> ⚠️ Attention: +> If used correctly, the graphic is placed into the document by the compiler. You ***do not need to*** position the graphic yourself. + +## Importing graphics into LaTeX +```latex +\begin{figure} + \centering + \includegraphics[width=0.8\linewidth]{} + \caption{ (Quelle: \cite{})} + \label{fig:} +\end{figure} +``` +The example places the Figure in the middle ( `\centering`). +It's width is defined as 80% of the linewidth (linewidth equals the width of a text-line). The percentage-value can be changed as needed. If the width should be 100% of the line, you just use `\linewidth`. + +## Referencing graphics in the text +It's important that the graphics that you use are referenced in the text, so that LaTeX can determine where the graphic should be positioned in the document. To reference a graphic in the text, use the following syntax: +```latex +\cref{fig:} +``` +## Special graphic-options +> **⚠️USE THESE WITH EXTREME CAUTION⚠️** +- `\begin{figure} [h]` ➡️ the `[h]` means, that the figure should be placed exactly here in the document. You override the compiler with this setting, so you should only use it if really necessary. +- `\captionof{figure}{}` ➡️ Sometimes you need to use `\captionof` instead of `\caption` to get the caption below a figure working. \ No newline at end of file