Sie sind hier

[Erledigt] Anleitung für das Paket tocstyle

Bild von Markus Kohm

Das Paket tocstyle gilt inzwischen als Experiment, das nicht weiter geführt wird. Stattdessen wird die Funktionalität auf andere Weise in anderen Paketen, beispielsweise tocbasic bereit gestellt. Damit ist die hier beschriebene Aufgabe überholt und kann als erledigt betrachtet werden.

Für das Paket tocstyle gibt es bisher nur eine sehr rudimentäre Anleitung in schlechtem Englisch. Diverse Möglichkeiten des Pakets sind darin überhaupt nicht dokumentiert. Unabhängig von der Tatsache, dass die Benutzerschnittstelle vermutlich noch geändert werden wird, werden die existierenden Möglichkeiten höchst wahrscheinlich in irgend einer Form erhalten bleiben. Daher wäre es sicher gut, wenn jemand für die restlichen Möglichkeiten eine Anleitung schreiben und ggf. auch die existierende sprachlich verbessern würde.

Nicht dokumentiert sind bisher (ohne Anspruch auf Vollständigkeit):

\showtoc
Informationen nur in Form von Quellcode und Verwendung innerhalb von tocstyle.dtx vorhanden
\aliastoc
Informationen nur in Form von Quellcode und Verwendung innerhalb von tocstyle.dtx vorhanden
\tocstyleTOC
im Quellcode dokumentiert
\tocstyleAliasTOC
Informationen nur in Form von Quellcode vorhanden
\tocstyledepth
im Quellcode dokumentiert
\deactivatetocstyle
ungetestet aber dokumentiert
\reactivatetocstyle
ungetestet aber dokumentiert
\iftochasdepth
im Quellcode dokumentiert

Ich bin mir absolut im Klaren darüber, dass es nicht einfach ist, die Funktion aus dem Quellcode und der dort vorhandenen spärlichen Doku herauszufinden. Selbst ich muss mich jedes Mal in den Quellcode einlesen, wenn ich das eine oder andere Feature nutzen will. Natürlich müsste ich ein paar mehr Stichworte liefern als das, was oben steht. Meine Aufgabe dabei wäre in erster Linie die Implementierungsdoku zu vervollständigen, ggf. ein paar zusätzliche Stichworte und ggf. Antworten zu liefern. Dafür würde ich das Paket auch mal wieder in die Hand nehmen und ggf. die Benutzerschnittstelle abschließend entwerfen und implementieren. Teil der Aufgabenstellung für Helfer wäre dann, die Anleitung entsprechend anzupassen.

Davon getrennt und doch damit verwoben besteht die Aufgabe, die Anleitung ins Deutsche zu übersetzen. Die Wichtigkeit dieser Aufgabe hängt jedoch in erster Linie von der Qualität der Erledigung der ersten Aufgabe, also der englischen Anleitung ab.

Bild von Markus Kohm

Den ersten Schritt habe ich gerade eben erledigt. Jetzt sind sämtliche Anweisungen, die tocstyle derzeit bietet, dokumentiert. Wer mag, kann diese Doku (siehe dazu die Datei tocstyle.dtx im SVN auf BerliOS) nehmen und sprachlich verbessern.

Hallo,

ich würde mich bereit erklären, eine deutsche Fassung anzufertigen. Doch ich kann die dtx nicht finden?

Gruß
Marco

Bild von Markus Kohm

Normalerweise kann man im Projekt auf BerliOS das SVN durchblättern, bis trunk/tocstyle.dtx durchhangeln und das runterladen. Leider ist BerliOS alle paar Wochen für Stunden bis Tage unbenutzbar (meist funktioniert der direkte svn-Zugang noch, während http und ftp komplett oder teilweise ausgefallen sind). Einmal hat sich dadurch die Release um einen Monat verzögert. BerliOS wird eben nur von sehr wenigen Menschen verwaltet. Da darf man sich nicht zu viel erwarten. Wenn BerliOS einen sehr weitgehenden Ausfall hat, merkt man das übrigens auch hier. Dann sind nämlich die BerliOS-Logos (beispielsweise im Menü oben rechts) nicht verfügbar.

Falls Du bereits die aktuelle Release 3.04a von KOMA-Script heruntergeladen/installiert hast, kannst Du vorerst auch das dort enthaltende source/latex/koma-script/tocstyle.dtx verwenden.

Achso: Du musst Dir im Klaren sein, dass ich die Anleitung ggf. auch irgendwann im KOMA-Script-Buch verwenden werde, also von Deiner Arbeit profitiere. Wenn Du das nicht willst, dann solltest Du es lassen.

Hallo,

ich habe die aktuelle Version. Ich werde mir das also mal zur Gemüte ziehen. Und wir profitieren von deinen Erfahrungen.

Gruß
Marco

Hallo Markus,

bei der Optionen toctextentriesindented gibt es noch Herausforderungen.

Das folgende Beispiel zeigt, dass addsec nicht die richtige Einrückung besitzt.

\documentclass{scrreprt}
\usepackage[toctextentriesindented]{tocstyle}
\usetocstyle{KOMAlike}
\begin{document}
\tableofcontents
\chapter{chapter}
\addchap{addchap}
\chapter{chapter}
\section{section}
\addsec{addsec}
\end{document}

Ich konnte eruieren, dass die Ursache in der Zeile 240 der tocstyle.sty liegt. Hier steht:

      \iftocstyle@indentnotnumbered\else
        \hskip -\leftskip
      \fi

vor der \else Anweisung müsste wohl Optional von der Gliederungsebene die Einrückung angegeben werden.

Gruß
Marco

Bild von Markus Kohm

Bild von Markus Kohm

Die Aufgabe wurde zwischenzeitlich zumindest teilweise erledigt. Das Ergebnis wurde aber nicht mehr veröffentlicht, da das Experiment tocstyle eingestellt wurde und das Paket nicht mehr verwendet werden soll.

Comments for "[Erledigt] Anleitung für das Paket tocstyle" abonnieren