Teckids-Dokumentenklasse „teckids2pubmat“

Wofür?

Diese Dokumentenklasse ist als Ablösung für die alte Dokumentenklasse teckidspubmat gedacht, sollte aber zunächst für alle Dokumente, die keine darüberhinausgehenden Anforderungen haben, als Standardvorlage dienen.

Aufbau eines Dokumentes

Das Arbeitsblatt Zahlenraten in Python soll uns hier als funktionierendes Beispiel dienen. Wenn man das Beispiel baut (ein PDF-Dokument draus erzeugt) sieht das ganze so aus.

Dokumentenkopf

Ganz oben ist der TECKIDSMETA-Kommentarblock, der zur Erfassung im Unterrichtsmaterialverwaltungssystem dient. Dies ist nur in public/material/ nötig, nicht, wenn die Vorlage für andere Dokumente verwendet wird.

Dann wird als allererstes die teckids2pubmat-Vorlage eingebunden:

\documentclass{teckids2pubmat}%

Sofort hinterher folgt…

Dokumenteninformationen

… die Information über die Lizenz des Dokumentes, die Autoren und Jahreszahlen.

Zunächst einmal muß der richtige Befehl für die Lizenz angegeben werden. Für das meiste Material nimmst Du am besten eine der beiden mit einem Sternchen ☆ markierten Lizenzen; wenn Du Dir nicht sicher bist, frag bitte jemanden, damit es Dir nochmals erklärt wird. Aktuell1 gibt es folgende Lizenzen:

Befehl

Lizenz

Beschreibung

\dokumentLizenzMirOS

MirOS

Die einfachste Lizenz. Sie besagt im wesentlichen „mach’ damit, was Du willst, aber laß meinen Namen dran stehen und verklage mich nicht“. Andere können Werke unter MirOS-Lizenz auch in nichtfreie Werke einbinden (das Original bleibt aber immer frei). Im Gegensatz zu den CC-Lizenzen für Programme und Daten nutzbar.

\dokumentLizenzCCBYfour

CC-BY 4.0

Eine Creative Commons-Lizenz, die bei abgeleiteten Werken nur fordert, daß der Autor des Ursprungswerkes genannt wird; auch diese Werke dürfen in nichtfreie Werke eingebunden werden.

\dokumentLizenzMirOSorCCBYfour



Dual-Lizenz MirOS/CC-BY

Der Empfänger darf sich aussuchen, ob er das Werk unter der MirOS-Lizenz oder der CC-BY (beide siehe oben) verwenden möchte.

Dies ist die empfohlene Lizenz aus dem Satzungsanhang C für neue „einfache“ Werke, oder wo keine „Copyleft“-Lizenz nötig oder gewollt ist, oder wo die Weiterbenutzung durch andere möglichst einfach gestaltet werden soll und von die Autoren kein über die Namensnennung hinausgehender besonderer Schutz gewünscht wird.

\dokumentLizenzCCBYSAfour

CC-BY-SA 4.0

Die Copyleft-Lizenz von Creative Commons in der aktuellen Version. Sie ist eine freie Lizenz, aber abgeleitete Werke müssen auch immer unter dieser Lizenz (oder einer kompatiblen/neueren Version) weitergegeben werden.

\dokumentLizenzLGPLorCCBYSAfour



Dual-Lizenz LGPL/CC-BY-SA

Der Empfänger darf sich aussuchen, ob er das Werk unter der GNU LGPL Version 2 oder später (einer Copyleft-Lizenz der Free Software Foundation, hauptsächlich für Programme) oer der CC-BY-SA (siehe oben) verwenden möchte.

Dies ist die empfohlene Lizenz aus dem Satzungsanhang C für neue Werke, bei denen gewünscht ist, daß andere sie auch immer nur unter diesen Lizenzen weiterbenutzen dürfen.

\dokumentLizenzCCBYSAthreeDE

CC-BY-SA 3.0 (DE)

Die vorherige Version der CC-BY-SA; nur bei alten Arbeitsblättern, die unverändert noch unter dieser Lizenz stehen, zu verwenden.

Danach kommen in einem Befehl \teckidshdr zunächst, in eckigen Klammern,

dann, in geschweiften Klammern,

Das kann zum Beispiel so aussehen:

\dokumentLizenzLGPLorCCBYSAfour%
\teckidshdr[2014 Dominik George,]{Python \dash Ein erstes Spiel}%

Wenn man mehrere Autoren hat kann man auch einen manuellen Zeilenumbruch \\ an geeigneter Stelle (nach einem Komma) einfügen:

\dokumentLizenzMirOSorCCBYfour%
\teckidshdr[2017, 2018 Thorsten Glaser, Enrico Rottsieper,\\
 Johannes Tobisch,]{Roboter-Bauanleitung}%

andere Pakete und Einstellungen

Jetzt kann man, in einem neuen Absatz, andere Pakete einbinden oder Einstellungen umsetzen, zum Beispiel:

\usepackage{tabularx}%
\usepackage{multirow}%
\renewcommand{\multirowsetup}{}%

bereits vorhandene Pakete

Hauptdokument

Der Inhalt des Dokumentes folgt. Idealerweise benutzt man \section{…}, um Abschnitte zu machen (mit \section*{} werden sie nicht nummeriert); Graphiken kann man auch zwischendurch einbinden. Einrücken hilft bei der Lesbarkeit. Beispiel:

\begin{document}
 \section{erster Abschnitt}

 Blah blah …

 \subsection{Unterabschnitt}

 Blah blah…

 \section{zweiter Abschnitt}

 usw.

\end{document}

Wie mache ich…?

Listings

Listings bindet man wie folgt ein:

\begin{lstdump}[language=python]{Zahlenraten}
import random

zahl = random.randint(1, 100)
eingabe = 0

while eingabe != zahl:
    eingabe = input("Gib eine Zahl ein: ")

    if eingabe < zahl:
        print("Deine Zahl ist zu klein!")
    elif eingabe > zahl:
        print("Deine Zahl ist zu gross!")

print("Richtig!")
\end{lstdump}

Hierbei gibt es die folgenden environments:

Wichtig: Das \end{lstdump}, \end{lstdumpx} oder \end{lstdump*} darf nicht eingerückt sein sondern beginnt in der ersten Spalte!

zentrierte Bilder, fast seitenbreit

 \begin{center}
  \includegraphics[width=0.80\linewidth]{images/standup}
 \end{center}

 \vspace{-1cm}%

Das bindet das Bild images/standup.* mit 80% (0.80) Zeilenbreite ein.

Dateinamen und Formate für Bilder

Wenn man keine Dateierweiterung eingibt, werden Bilder mit den Erweiterungen .pdf, .eps, .png oder .jpg gesucht.

Die ersten beiden Formate sind Vektorformate. Am besten malt ihr eure Graphiken in Inkscape und speichert sie als SVG (*.svg); diese werden von unserem System automatisch in *.pdf umgewandelt und so eingebunden.

Die anderen beiden Formate sind Bitmapformate; hier werden die Bilder schnell pixelig, das sieht nicht gut aus. Dabei behält das Format png immerhin jeden Pixel des Originalbildes bei (Benutzung z.B. für Screenshots), während bei jpg Qualitätsverluste durch Kompression entstehen und das daher nur für Bilder von Kameras o.ä. geeignet ist.

Bilder neben dem Text

 \begin{wrapfigure}{r!}{0.25\linewidth}
  \vspace{-\intextsep}
  \centering
  \includegraphics[width=0.95\linewidth]{images/dice_icon_by_netalloy}
  \vspace{-\intextsep}
 \end{wrapfigure}

Dies bindet das Bild images/dice_icon_by_netalloy.* rechts ({r!}) neben dem Text ein und reserviert dafür 25% Breite (0.25). Die \vspace{-\intextsep} sind dafür da, den Extra-Abstand über und unter dem Bild zu reduzieren; ggfs. weglassen.


  1. Wenn die passende Lizenz nicht dabei ist, bitte an tglaser wenden, damit er sie hinzufügt. (1)

TeckidsWiki: TeX/PubMat2 (last edited 2018-03-11 00:17:34 by tglaser)