[meta] Optimale Code-Arbeit in Beispielen und Handbüchern (Vermeidung unguter Angewohnheiten in der LaTeX-Welt)

Angaben zur Kompilierung

Gelegentlich müssen Dokumente in spezieller Weise übersetzt werden.

Beispiele sind bekanntlich: biblatex/biber (oder auch noch bibtex), makeindex, Dokumente mit pstricks, Dokumente für lualatex u.v.m.

Manchmal kopiert man rasch ein Dokument raus, möchte dieses übersetzen und bekommt erstmal Fehlermeldungen.... Also zurück zur Seite, nochmal lesen, lesen, lesen und kommt dann irgendwann dahinter, dass es ein pstricks-Dokument war. Also, sofern man nicht ständig pstrickst, nochmal rausfinden, wie das ging mit dem Kompilieren bei solchen Dokumenten usw. Das kann einen immer mal wieder "10min." kosten.

Ich meine, es sollte zum guten Brauchtum gehören, hier die Kompilierungsreihenfolge im Dokumentkopf anzugeben. Am besten durch einen arara-Kopf, der auch für Autoren und Nutzer, die kein arara verwenden, selbsterklärend sein sollte.

Beispiel 1 (lualatex)

% arara: lualatex

\documentclass{article}
\usepackage{fontspec}
\setmainfont{DejaVu Sans}
\begin{document}
\Huge\char"2654   ^^^^2655
\end{document}

Beispiel 2 (pstricks)

% arara: latex
% arara: dvips
% arara: ps2pdf

% Alternativ:
% #arara: xelatex

\documentclass[margin=5pt]{standalone}
\usepackage{pst-poker}
\begin{document}
\crdQh
\end{document}

Nicht-Lauffähigkeit von Minimalbeispielen bei Beinhalten von externen Texten, Bildern oder PDF-Dateien als Input

Zu Minimalbeispielen ist viel gesagt worden; daher nur zu einem bestimmten Teilaspekt

Gelegentlich braucht man in einem Minimalbeispiel a) Dummy-Text, b) Dummy-Bilder oder sogar eine c) Dummy-PDF Datei.

• Die ersten beiden Dummy-Inputs können unter anderem mit dem Paket mwe ("Minimal woking example") erledigt werden.

• Bei Dummy-PDF Dateien verhält es sich etwas schwieriger: Man findet solche dort wo das Handbuch pdfpages.pdf liegt. Das Paket pdfpages.sty sucht dort nicht nach Dateien, also muss der Dateipfad angeben werden:
  \includepdf[<...>]{C:/texlive/<Version>/texmf-dist/doc/latex/pdfpages/dummy.pdf}

MWE (wie gesagt, Dateipfad angeben!):

\documentclass{article}
\usepackage{mwe} % Dummy Texte und Bilder

\usepackage{pdfpages} % Dummy PDF-Dateien
\def\Pfad{C:/texlive/<Version>/texmf-dist/doc/latex/pdfpages/dummy.pdf}
\def\PfadLS{C:/texlive/<Version>/texmf-dist/doc/latex/pdfpages/dummy-l.pdf}

\begin{document}
\section{Dummy Text}
\lipsum[1-3]

\section{Dummy Bild graphicx}
\includegraphics[]{example-image}

\section{Dummy Bild rule}
\rule{12cm}{7cm}

\includepdf[pagecommand={\section{Dummy PDF}}, scale=0.75
]{\Pfad}
\includepdf[pagecommand={\section{Dummy PDF Landscape}},fitpaper]{\PfadLS}
\end{document}