nobody/cccb-formulare
0
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

mehr doku

Browse source
This commit is contained in:
nobody 2025-01-14 23:56:10 +01:00
parent 3aa389f680
commit 9c31d0df92
1 changed files with 120 additions and 49 deletions
Download patch file Download diff file Expand all files Collapse all files

169
doku.tex
View file

@ -54,6 +54,7 @@
BoldItalicFeatures={RawFeature={+axis={MONO=0.0,CASL=0.4,slnt=-15,CRSV=1,wght=800}}},
ItalicFeatures={RawFeature={+axis={MONO=0.0,CASL=0.4,slnt=-15,CRSV=1,wght=500}}}
]{Recursive}
\setkomafont{disposition}{\titlefont}
% >>>
\usepackage{microtype}
@ -291,15 +292,6 @@ end
\tableofcontents
% >>>
\chapter{TODO} % <<<
\begin{itemize}
\item Grundsätze des aktuellen Designs
\item \TeX-Intro zum Ende, +build info
\end{itemize}
% >>>
\chapter{Übersicht} % <<<
Die Grundstruktur für Formulare ist folgende:
@ -420,7 +412,8 @@ starten, mehrere temporäre Dateien zu schreiben, etc. etc. kann gut 3--10
Minuten fressen.) Danach erkennen \texttt{make} bzw. \texttt{latexmk}, dass
sich in den meisten Dateien nichts verändert hat und es geht bei zukünftigen
Durchläufen deutlich schneller (solange nicht die Klasse verändert wird -- was
wieder alles neu bauen würde -- wenige Sekunden bis ca. eine Minute.)
wieder alles neu bauen würde -- braucht das wenige Sekunden bis ca. eine
Minute.)
% >>>
@ -471,14 +464,16 @@ sinnvoll, da der Text sonst über das Logo bis zum Seitenrand laufen kann. (Das
Logo und ggf. die Adresse werden nachträglich platziert, \TeX\ "sieht" diese
also nicht beim verarbeiten des restlichen Inhalts.)
\subsection{\texcode{\LogoTitle{Titel}}}
\subsection{\texcode{\LogoTitle{Titel}}} % <<<
\begin{ShortExample}*[4.953cm]{logotitle}{Die einfache Variante -- Titel links, Logo rechts.}
\LogoTitle{Beispieltitel}
\Text{(...und hier geht's weiter.)}
\end{ShortExample}
\subsection{\texcode{\AddressTitle{Titel}}}
% >>>
\subsection{\texcode{\AddressTitle{Titel}}} % <<<
\begin{ShortExample}*[8.865cm]{addresstitle}{Titel und Adresse}
\AddressTitle{Beispieltitel}
@ -498,6 +493,8 @@ Es gibt auch die Variante mit \texttt{*}, welche zusätzlich das Logo einbettet.
% >>>
% >>>
\section{Inhalt} % <<<
Hier gibt es größtenteils Befehle für Formularfelder. Anders als in normalen
@ -543,41 +540,50 @@ werden.
Die vermutlich wichtigste Komponente, entsprechend viele Varianten gibt es.
\paragraph{\texcode{\TextField}} Im Zweifel ist die einfachste Variante die
richtige. Ein einzeiliges Freitextfeld mit Label und einer für die meisten
Zwecke angemessenen Breite (welche auch z.~B. in mehrspaltigen Bereichen von
allein angepasst wird).
\subsubsection{\texcode{\TextField}} % <<<
Im Zweifel ist die einfachste Variante die richtige: Ein einzeiliges
Freitextfeld mit Label und einer für die meisten Zwecke angemessenen Breite
(welche auch z.~B. in mehrspaltigen Bereichen von allein angepasst wird).
\begin{ShortExample}{textfield}{normales Textfeld}
\TextField{Bezeichnung}
\end{ShortExample}
Wird die volle Breite benötigt gibt es auch die Variante mit Stern:
\paragraph{\texcode{\TextField*}} Wird die volle Breite benötigt gibt es auch
die Variante mit Stern:
\begin{ShortExample}{textfieldstar}{maximale Breite}
\TextField*{Bezeichnung}
\end{ShortExample}
\paragraph{\texcode{\ShortTextField}} Wirkt die Breite hingegen zu hoch (z.~B.
für eine einzelne Zahl), so gibt es auch ein explizit kurzes Textfeld.
% >>>
\subsubsection{\texcode{\ShortTextField}} % <<<
Wirkt die Breite hingegen zu hoch (z.~B. für eine einzelne Zahl), so gibt es
auch ein explizit kurzes Textfeld.
\begin{ShortExample}{shorttextfield}{kurzes Textfeld}
\ShortTextField{Stromverbrauch (TWh)}
\end{ShortExample}
Optional kann die Länge auch explizit als Faktor relativ zur Textbreite
angegeben werden. Das Formular sieht aber einheitlicher aus, wenn das
\emph{nicht} gemacht wird, also bitte zweimal überlegen, ob es das
\emph{wirklich} braucht.
\paragraph{\texcode{\ShortTextField[width]}} Optional kann die Länge auch
explizit als Faktor relativ zur Textbreite angegeben werden. Das Formular
sieht aber einheitlicher aus, wenn das \emph{nicht} gemacht wird, also bitte
zweimal überlegen, ob es das \emph{wirklich} braucht.
\begin{ShortExample}{shorttextfieldopt}{besonders kurzes Textfeld}
\ShortTextField[0.15]{Verbrauch (TWh)}
\end{ShortExample}
\paragraph{\texcode{\MultilineTextField}} Für mehr Text gibt es auch
mehrzeilige Textfelder. Auch wenn die Höhe technisch gesehen optional ist,
sollte sie immer angegeben werden -- ansonsten hat das Feld die Standard-Höhe
von normalen Textfeldern.
% >>>
\subsubsection{\texcode{\MultilineTextField}} % <<<
Für mehr Text gibt es auch mehrzeilige Textfelder. Auch wenn die Höhe
technisch gesehen optional ist, sollte sie immer angegeben werden -- ansonsten
hat das Feld die Standard-Höhe von normalen Textfeldern.
\begin{ShortExample}{multilinetextfield}{mehrzeiliges Textfeld}
\MultilineTextField[2cm]{Kringel}
@ -587,15 +593,20 @@ von normalen Textfeldern.
\MultilineTextField{Kringel}
\end{ShortExample}
Auch hier gibt es wieder die Variante mit Stern für volle Breite:
\paragraph{\texcode{\MultilineTextField*}} Auch hier gibt es wieder die
Variante mit Stern für volle Breite:
\begin{ShortExample}{multilinetextfieldstar}{breites mehrzeiliges Textfeld}
\MultilineTextField*[2cm]{Kringel}
\end{ShortExample}
\paragraph{Spezialfälle} Unterschriften sollen üblicherweise händisch gesetzt
werden, hierfür gibt es daher ein Feld was nur ein "falsches" Formularfeld ist
und nicht digital ausgefüllt werden kann.
% >>>
\subsubsection{Spezialfälle} % <<<
Unterschriften sollen üblicherweise händisch gesetzt werden, hierfür gibt es
daher ein Feld was nur ein "falsches" Formularfeld ist und nicht digital
ausgefüllt werden kann.
(NB: Die Breite ist -- wie bei allem -- relativ zur Papierbreite definiert. Da
diese bei diesen Beispielen deutlich schmaler als A4 ist, sieht das Feld hier
@ -612,7 +623,8 @@ Das Label kann optional geändert werden.
\Signature[Unterschrift]
\end{ShortExample}
Ebenfalls gibt es ein etwas größeres Feld für Notizen oder Vermerke.
\paragraph{\texcode{\Notes}} Ebenfalls gibt es ein etwas größeres Feld für
Notizen oder Vermerke.
\begin{ShortExample}{notes}{großes Feld}
\Notes
@ -624,7 +636,8 @@ Auch hier kann optional das Label geändert werden.
\Notes[Stirnabdruck]
\end{ShortExample}
Letztlich gibt es für Sonderfälle noch Inline-Textfelder.
\paragraph{\texcode{\InlineTextField}} Letztlich gibt es für Sonderfälle noch
Inline-Textfelder.
\begin{ShortExample}{inlinetextfield}{Sonderfall -- Inline}
\Text{Zur Fehlersuche wurden etwa
@ -676,11 +689,14 @@ sowieso für ein einheitliches Aussehen sorgen.
% >>>
% >>>
\subsection{Checkboxen} % <<<
\paragraph{Normale Verwendung} Gibt es eigentlich nicht viel dazu zu sagen --
\texcode{\Checkbox{Label}} für eine Checkbox (und das Label kann auch ein
kompletter Absatz sein.)
\subsubsection{\texcode{\Checkbox} -- normale Verwendung} % <<<
Gibt es eigentlich nicht viel dazu zu sagen -- \texcode{\Checkbox{Label}} für
eine Checkbox (und das Label kann auch ein kompletter Absatz sein.)
\begin{ShortExample}{checkbox}{Checkboxen}
\Checkbox{Ich habe die AGB,
@ -695,6 +711,10 @@ kompletter Absatz sein.)
zum Lesen von Anleitungen gelesen.}
\end{ShortExample}
% >>>
\subsubsection{\texcode{\CheckboxOther}} % <<<
Für Freitextfelder als "Sonstige:" gibt es
\texcode{\CheckboxOther[Breite]{Label}}, wieder mit optionaler Breitenangabe
(relativ zur Textbreite) für das Freitextfeld.
@ -715,7 +735,9 @@ einheitlicher sieht das Formular am Ende aus. Bei dem Beispiel würde ein
einzelner Buchstabe auch in ein 0.05-er Feld passen, das wären dann aber 3
statt 2 verschiedener Breiten.
\paragraph{Spezielle Zwecke}
% >>>
\subsubsection{Spezielle Zwecke -- \texcode{\InlineCheckbox}} % <<<
In Sondersituationen könnten z.~B. in Aufzählungen innerhalb einer Zeile auch
Checkboxen benötigt sein. Dafür gibt es die -- nur in Ausnahmefällen zu
@ -745,18 +767,21 @@ angehängt werden.)
% >>>
% >>>
\section{Struktur} % <<<
Drei Kategorien -- formularspezifisch, "klassische" Abschnitte, und mehrere Spalten.
\subsection{formularspezifisch angepasste Formen} % <<<
\paragraph{\texttt{Indented}} Visuelle Gruppierung durch Einrücken von
zusammenhängenden bzw. untergeordneten Abschnitten ist eine sehr gute Option,
da ohne zusätzliche Tinte trotzdem klar die Struktur vermittelt wird. (Das
wurde auch schon bei den Checkboxen unmittelbar hier drüber verwendet.)
Optional kann ein Faktor (nicht zwingend ganzzahlig) für die Einrückungstiefe
angegeben werden.
\subsubsection{\texcode{\begin{Indented} ... \end{Indented}}} % <<<
Visuelle Gruppierung durch Einrücken von zusammenhängenden bzw. untergeordneten
Abschnitten ist eine sehr gute Option, da ohne zusätzliche Tinte trotzdem klar
die Struktur vermittelt wird. (Das wurde auch schon bei den Checkboxen
unmittelbar hier drüber verwendet.) Optional kann ein Faktor (nicht zwingend
ganzzahlig) für die Einrückungstiefe angegeben werden.
\begin{ShortExample}{indentation}{Einrückung, auch über mehrere Ebenen}
\Text{abc}
@ -771,12 +796,19 @@ angegeben werden.
\begin{Indented}[2]
\Text{pqr}
\end{Indented}
\begin{Indented}[1.4142]
\Text{stu}
\end{Indented}
\end{ShortExample}
\paragraph{\texcode{\RuleSection}} Dient zur Trennung von Formularabschnitten,
die durch verschiedene Personengruppen ausgefüllt werden. Die Linie geht immer
über die komplette Formularbreite und kann z.~B. nicht innerhalb von
mehrspaltigen Bereichen verwendet werden.
% >>>
\subsubsection{\texcode{\RuleSection}} % <<<
Dient zur Trennung von Formularabschnitten, die durch verschiedene
Personengruppen ausgefüllt werden. Die Linie geht immer über die komplette
Formularbreite und kann z.~B. nicht innerhalb von mehrspaltigen Bereichen
verwendet werden.
\begin{ShortExample}{rulesection}{Mehrere klar getrennte Abschnitte}
\TextField{Name}
@ -786,8 +818,12 @@ mehrspaltigen Bereichen verwendet werden.
\CheckboxOther[0.5]{Abgelehnt, weil:}
\end{ShortExample}
\paragraph{\texcode{\Rule}} Eine einfache Trennlinie, die an verschiedenen
Stellen zur grafischen Trennung eingesetzt werden kann.
% >>>
\subsubsection{\texcode{\Rule}} % <<<
Eine einfache Trennlinie, die an verschiedenen Stellen zur grafischen Trennung
eingesetzt werden kann.
\begin{ShortExample}{rule}{Mehr Trennlinien}
\RuleSection{Bearbeiter}
@ -804,6 +840,8 @@ Stellen zur grafischen Trennung eingesetzt werden kann.
% >>>
% >>>
\subsection{"klassische" Struktur} % <<<
In \TeX\ üblich sind \texcode{\section}, \texcode{\subsection}, etc.; in
@ -914,6 +952,39 @@ verwenden.}}
% >>>
\chapter{Hinweise zum Design} % <<<
Das aktuelle Design ist iterativ entstanden und vermutlich erstmal \emph{gut genug},
aber deutlich nicht komplett durchstrukturiert und -getestet.
\section{Schrift}
Die Schrift "Recursive" wird im Text mit \texttt{CASL=0.2} zwischen den
Extremen benutzt. Die anderen Achsen halten sich an die Standard-Werte
(\texttt{wght=400/700} für normal/fett, \texttt{slnt=0/-15} und
\texttt{CRSV=0/1} für normal/kursiv, und \texttt{MONO=0.0/1.0} für
normal/festbreite.) Für Titel wird sowohl das Gewicht leicht erhöht
(\texttt{wght=500/800}) als auch \texttt{CASL=0.4} verdoppelt. (Das ist schon
ziemlich kräftig, \texttt{CASL=1.0} ist zu extrem.)
\section{Formularfelder}
Textfeldhöhe plus Abstand zusammen sollten für Handschrift groß genug sein.
Die Grautöne wurden mit dem Drucker getestet und sollten sowohl bei direktem
Druck als auch bei einfacher Kopie lesbar bleiben. Mehr wurde da noch nicht
optimiert.
Die schrägen Label (um 1em rausgeschoben und um 4.20° rotiert) sind relativ gut
durchgetestet und sehen zusammen mit der Schrift chaotisch aus ohne tatsächlich
chaotisch zu sein. Solange das Label nicht zu lang wird, ist es auch beim
Ausfüllen des Formulars nicht zu sehr im Weg.
Abstände etc. sind eher so Bauchgefühl und nicht komplett durchdacht. Es gab
bisher noch keine offensichtlichen Probleme damit, aber müsste man mal nochmal
anschauen\dots
% >>>
\end{document}
% vim: set fdm=marker fmr=<<<,>>> :