\documentclass[a4paper,add-index]{cnltx-doc}

\usepackage{utfsym}
\usepackage{prettyref}
\usepackage{hyperref}

\setcnltx{
    name     = utfsym ,
    title    = utfsym ,
    version  = 0.9.0 ,
    date     = 2022-03-17 ,
    subtitle = {\LaTeX-Paket für verschiedne Unicode-Symbole},
    info     = Paketdokumentation ,
    authors  =  {Daniel Spittank, Johannes Pieper} ,
    email    = schulepaket@johpie.de ,
    url     = https://gitlab.com/gi-fg-ibnw/utfsym ,
    abstract = {%
        Dieses Paket stellt verschiedene Symbole aus dem Unicode zur Verfügung, um sie ursprünglich im schulischen Kontext wie z.\,B. auf Arbeitsblättern nutzen zu können. Dieses ließen sich sonst unter \LaTeX nicht so einfach nutzen. Auch die Nutzung in anderen Kontexten ist möglich.
    } ,
    index-setup = { othercode=\footnotesize,level=\section},
    add-listings-options= {
        morekeywords={
        }
    },
}

\begin{document}

\section{Unicode-Symbole}
\label{paket:utfsym}

Im Schulkontext benötigt man häufig verschiedene Symbole, sei es
für die Kennzeichnung von Partner- und Gruppenarbeit, für die
Auflistung von Materialien oder einfach für die Verschönerung
von Arbeitsblättern.

Im Unicode sind einige tausend Symbole bereits definiert, von
denen sich viele für den Einsatz in der Schule aufdrängen.
Leider ist der Einsatz in Latex nicht ohne weiteres möglich.

Deswegen wurde für das Schule-Paket das Zusatzpaket \pkg{utfsym}
entwickelt. Dieses ermöglicht die Verwendung von Zeichen aus
den folgenden Unicode-Blöcken:

\begin{itemize}
	\item Miscellaneous Symbols and Arrows (2600-26FF),
		siehe S.~\pageref{utab:02600-026FF}
	\item Dingbats (2700-27BF),
		siehe S.~\pageref{utab:02700-027BF}
	\item Mahjong Tiles (1F000-1F02F),
		siehe S.~\pageref{utab:1F000-1F02F}
	\item Domino Tiles (1F030-1F09F),
		siehe S.~\pageref{utab:1F030-1F09F}
	\item Playing Cards (1F0A0-1F0FF),
		siehe S.~\pageref{utab:1F0A0-1F0FF}
	\item Miscellaneous Symbols and Pictographs (1F300-1F5FF),
		siehe S.~\pageref{utab:1F300-1F5FF}
	\item Emoticons / Emoji (1F600-1F64F),
		siehe S.~\pageref{utab:1F600-1F64F}
	\item Transport and Map Symbols (1F680-1F6FF),
		siehe S.~\pageref{utab:1F680-1F6FF}
\end{itemize}

Die vollständigen Symboltabellen, mit
allen über 1600 unterstützten Symbolen, finden sich im Anhang, siehe
\prettyref{sec:unicodesymbole}.

Die entsprechenden Symbole können direkt in den LaTeX-Quelltext
eingefügt oder per Befehl eingebunden werden.

Die Symbole stammen dabei aus der Public-Domain-Schrift
\textbf{Symbola.ttf} von \textsc{George Douros}. Sie werden mit
TikZ gesetzt und passen sich jeweils an die Schriftgröße und
Farbe der Umgebung an, können aber auch als Bild mit
benutzerdefinierter Skalierung eingebunden werden.

\subsection{Befehle}
\begin{commands}
	\command{usym}[\marg{Code}]
	Bindet das Symbol mit dem gegebenen Code in das Dokument ein.
	Die Darstellung erfolgt im Fließtext. Größe und Farbe werden an
	den umgebenden Text angepasst.
\begin{sidebyside}
  \usym{1F642}
  \usym{1F609}
  \Huge\color{yellow}\usym{1F60A}
\end{sidebyside}
	\command{usymH}[\marg{Code}\marg{Höhe}]
	Bindet das Symbol mit dem gegebenen Code in das Dokument ein.
	Die Größe wird an die angegebene Höhe angepasst.
\begin{sidebyside}
  \usymH{1F0A1}{2cm}
\end{sidebyside}
	\command{usymW}[\marg{Code}\marg{Breite}]
	Bindet das Symbol mit dem gegebenen Code in das Dokument ein.
	Die Größe wird an die angegebene Breite angepasst.
\begin{sidebyside}
  \usymW{1F68C}{3cm}
\end{sidebyside}
\end{commands}

\include{symbole}

\section{Lizenzen}
Das Paket \pkg{utfsym} fällt unter die Public Domain im Sinne der CC0 (Creative Commons Zero).


\section{Changelog}
Die folgende Liste bietet eine Übersicht über die letzten Änderungen. Diese beginnt mit der Version 0.8.2, da zu diesem Zeitpunkt das Paket ausgekoppelt wurde und erst seit dem als eigenständiges Paket geführt wird.
\begin{itemize}
    \item \textbf{0.9.0} -- 2022-04-17
        \begin{itemize}
            \item Nutzung für LuaLaTeX und XeLaTex ermöglicht (Dank an Marei Peischl)
        \end{itemize}
    \item \textbf{0.8.3} -- 2020-10-22
        \begin{itemize}
            \item Fehlerbehebung bzgl. Pfade
            \item Erweiterung der Dokumentation
        \end{itemize}
    \item \textbf{0.8.2} -- 2020-10-16
        \begin{itemize}
            \item Auskopplung aus dem Paket \pkg{schule}
        \end{itemize}
\end{itemize}


\end{document}
