From 69d9baa79c940171088b1b8051757538ed27d364 Mon Sep 17 00:00:00 2001 From: Felix Prillwitz <36958734+photovoltex@users.noreply.github.com> Date: Mon, 16 May 2022 13:14:06 +0200 Subject: [PATCH] adjust docs + tests --- README.md | 9 ++++++--- build/tests/anlagen.tex | 3 ++- build/tests/main.tex | 4 ++-- 3 files changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9b42213..3b11073 100644 --- a/README.md +++ b/README.md @@ -264,14 +264,14 @@ welches einen Überblick über Bilder und ihre Optionen wie z.B. Positionierung ## dhge-latex Abbildungen ```latex -\dhgefigure[1]{2}{3}{4}{5}[6][7] +\dhgefigure[1]{2}[3]{4}{5}[6][7] ``` kann mit bis zu sechs Argumenten aufgerufen werden: 1. **Optional** Float Position, standardmäßig `tbp` 2. Relativer Bild-Pfad mit oder ohne Dateiendung (relativ zum `./assets/img` Ordner, kann in `template.tex` angepasst werden) -3. `\includegraphics` Optionen (leer lassen für Standard) +3. `\includegraphics` Optionen (weglassen für Standard (Breite = Textbreite)) 4. Bildunterschrift 5. Label für die Figure/Grafik 6. **Optional:** ID @@ -280,7 +280,10 @@ kann mit bis zu sechs Argumenten aufgerufen werden: Beispiel: ```latex -\dhgefigure[h]{mapi_outgoing_illustration}{scale=0.75}{Absenden einer MAPI Nachricht}{fig:mapi}[mapi][S. 17ff] +% allen Optionen (optionale Optionen können sowohl `[]` als auch `{}` sein (hier `[]`), required müssen `{}` sein) +\dhgefigure[h]{mapi_outgoing_illustration}[scale=0.75]{Absenden einer MAPI Nachricht}{fig:mapi}[mapi][S. 17ff] +% nur notwendige Optionen +\dhgefigure{mapi_outgoing_illustration}{Absenden einer MAPI Nachricht}{fig:mapi} ``` *** diff --git a/build/tests/anlagen.tex b/build/tests/anlagen.tex index 06a3f16..117523f 100644 --- a/build/tests/anlagen.tex +++ b/build/tests/anlagen.tex @@ -6,7 +6,8 @@ \end{tabular} \end{table} -\dhgefigure[h]{img}{scale=0.25}{Ein Testbild}{fig:anlagentest}[Xmisc][S. 17ff] +\dhgefigure[h]{img}[scale=0.25]{Ein Testbild}{fig:anlagentest}[Xmisc][S. 17ff] +\dhgefigure{img}{Ein Testbild}{fig:anlagentest}[Xmisc] \begin{figure}[H] \centering diff --git a/build/tests/main.tex b/build/tests/main.tex index fe01453..7cf9e76 100644 --- a/build/tests/main.tex +++ b/build/tests/main.tex @@ -12,5 +12,5 @@ \subsection{Command Test Subsection} \subsection{Bilder Test Subsection} -\dhgefigure[h]{img}{scale=0.25}{Ein Testbild}{fig:test}[Xmisc][S. 17ff] -\dhgefigure[h]{img}{scale=.6}{Ein Testbild}{fig:test2} +\dhgefigure[h]{img}[scale=0.25]{Ein Testbild}{fig:test}[Xmisc][S. 17ff] +\dhgefigure{img}{Ein Testbild}{fig:test2}