Umfassendes Tutorial/Handbuch für LaTeX/Pakete mit expliziten Beispielen und angezeigten Ergebnissen anstelle von reinem Code wie im Dokumentcenter von Mathematica

Umfassendes Tutorial/Handbuch für LaTeX/Pakete mit expliziten Beispielen und angezeigten Ergebnissen anstelle von reinem Code wie im Dokumentcenter von Mathematica

Ich möchte einige Pakete in Latex verwenden und suche dann das Handbuch für dieses Paket. Allerdings finde ich, dass all diese Handbücher nur Codes und Erklärungen ohne explizite Beispiele und gezeigte Ergebnisse sind. Ich bin kein Informatiker. Es ist ziemlich langweilig und ineffizient für mich, alle einfachen Texte zu lesen, um zu verstehen, wie man dieses Paket verwendet. Gibt es einen Ort, an dem ich für Amateure wie mich das Handbuch für jedes Paket finden kann? Ich möchte, dass dieses Handbuch/diese Anmerkung (sicherlich nicht unbedingt von den Paketautoren geschrieben) folgende Eigenschaften hat:

  1. Nicht zu skizzenhaft, sondern einfach ein paar einfache Beispiele zur Einführung des Frameworks auswählen. Ich möchte, dass es umfassend ist und mir alle Details zu jeder Funktion, Methode oder jedem Parameter in diesem Paket mitgeteilt werden.

  2. Das Wichtigste für mich ist, dass jede Funktion/Methode/jeder Parameter explizite Beispiele und angezeigte Ergebnisse haben sollte. So kann ich die angezeigten Ergebnisse schnell untersuchen und aha, so soll es aussehen.

PS: Ich verstehe natürlich, dass LaTeX keine kostenpflichtige Software ist. Die Autoren von Paketen haben trotzdem das Recht, zu schreiben, was sie wollen. Ich frage mich, ob es gute Lehrer gibt, die das ursprüngliche trockene Handbuch aufarbeiten und Amateure, die nicht nur an der Oberfläche kratzen wollen, auf freundliche Weise füttern. Ein gutes Beispiel für das, was ich will, ist wieDokumentenzentrum von Wolfram Mathematica.

Antwort1

Nein, eine solche Site gibt es nicht und niemand wird sie für Sie erstellen, nur weil Sie das Handbuch langweilig finden.

Mathematica ist eine proprietäre Anwendung und sie können kontrollieren, wie ihre Pakete dokumentiert werden. Python ist Open Source, hat aber eine starke Gemeinschaftsethik, in der sich so ziemlich alle einig sind, dass „es einen – und vorzugsweise nur einen – Weg geben sollte, es zu tun“. Gute Dokumentation ist also Teil der Kultur. LaTeX ist keines von beidem.

Ich stimme den Kommentatoren zu, dass einige Paketdokumentationen recht gut sind tikzund pgfplotszu meinen Favoriten gehören. Und die meisten Dokumentationen sind nichtschlecht; es wird möglicherweise nur nicht alles erklärt, was Sie damit tun möchten.

Wenn Sie jedoch nach einer umfangreichen Quelle beantworteter Fragen zu verschiedenen Anwendungsfällen von LaTeX (und ConTeXt und Core TeX) suchen, haben Sie sie möglicherweise bereits gefunden. Fragen auf TeX.SE sind nach verwendeten Paketen gekennzeichnet, sodass Sie viele Beispiele durchsuchen und suchen können. Seiten auf TeX.SE sind sehr gut auffindbar. Normalerweise google ich einfach „Latex (was ich tun möchte)“ und das oberste Ergebnis ist normalerweise eine Seite von dieser Site. Und wenn Sie nicht finden, was Sie suchen – fragen Sie!

Antwort2

Es tut mir leid, aber ich finde, dass Sie mit Ihrer Forderung zu ehrgeizig sind. Die Autoren derLaTeX-BegleiterSerie (LaTeX-Begleiter,LaTeX-GrafikbegleiterUndLaTeX Web Companion, alle veröffentlicht von Addison Wesley) sind Ihrem Wunsch schon sehr nahe gekommen. Was einzelne Pakete/Klassen betrifft, ist es Sache der Entwickler/Autoren, die Dokumentation bereitzustellen, die sie für wichtig halten. Ich schätze, dass sie, und sicherlich auch ich, in den meisten Fällen davon ausgegangen sind, dass die Leser über ein gewisses Wissen über LaTeX verfügen und keine grundlegenden Elemente wiederholen müssen.

Ich war der ursprüngliche Entwickler der memoirKlasse ( > texdoc memoir), der das Handbuch gelesen hat, das aus etwa 540 Seiten besteht. Darin enthalten ist ein 40-seitiger Index aller Makros innerhalb der Klasse, die alle mehr oder weniger ausführlich im Hauptteil des Handbuchs beschrieben werden. Es werden Beispiele für die Ergebnisse der Verwendung der wichtigsten Makros gegeben. Beispiele für jede Verwendung jedes Makros in der Klasse würden, schätze ich, den Umfang des Handbuchs verdreifachen. Wer würde das lesen? Und ich würde es ganz sicher nicht schreiben.

Da Sie eine Vorstellung davon haben, was Sie sehen möchten, wären Sie bereit, eine Dokumentation auf Amateurniveau zu den Paketen zu schreiben, die Sie kennengelernt haben, und diese zur allgemeinen Verteilung an CTAN zu senden?

GOM

verwandte Informationen