summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/pauldoc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2009-11-13 15:49:03 +0000
committerKarl Berry <karl@freefriends.org>2009-11-13 15:49:03 +0000
commit4cac76f6c09cc9b5d8cf8e35140dda1fe96d1c34 (patch)
tree9aa65aedb96ee2a96341a8099044e042c75d6719 /Master/texmf-dist/source/latex/pauldoc
parent4fa51ebdd5131be8194a0b3b73aa7d347bfdc73c (diff)
pauldoc update (10nov09)
git-svn-id: svn://tug.org/texlive/trunk@16005 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/pauldoc')
-rw-r--r--Master/texmf-dist/source/latex/pauldoc/pauldoc.dtx147
1 files changed, 99 insertions, 48 deletions
diff --git a/Master/texmf-dist/source/latex/pauldoc/pauldoc.dtx b/Master/texmf-dist/source/latex/pauldoc/pauldoc.dtx
index b7fb595cc47..a0b3bb6f6c2 100644
--- a/Master/texmf-dist/source/latex/pauldoc/pauldoc.dtx
+++ b/Master/texmf-dist/source/latex/pauldoc/pauldoc.dtx
@@ -1,6 +1,6 @@
% \iffalse meta-comment
%
-%% (C) 2006 Paul Ebermann
+%% (C) 2006-2009 Paul Ebermann
%%
%% Package pauldoc - Anpassungen für doc für Pauls Package-Dokus.
%% Die Datei pauldoc.dtx sowie die dazugehörige
@@ -23,7 +23,7 @@
% \iffalse
%<package>\NeedsTeXFormat{LaTeX2e}[2003/12/01]
%<package>\ProvidesPackage{pauldoc}
-%<package> [2006/04/05 v0.4a Pauls Anpassungen fuer doc (PE)]
+%<package> [2009/11/06 v0.5 Pauls Anpassungen fuer doc (PE)]
%
% \changes{v0.2a}{2006/02/23}{'ue' statt 'ü' im Identifikations-String - gibt schönere
% Ausgabe bei \cs{listfiles}.}
@@ -32,6 +32,9 @@
\nonstopmode
\documentclass[draft,ngerman]{ltxdoc}
\usepackage{pauldoc}
+\usepackage{dox}
+\doxitem{Option}{option}{Optionen}
+
\setlength{\IndexMin}{2\IndexMin}
\begin{document}
\DocInput{pauldoc.dtx}
@@ -39,11 +42,12 @@
%</driver>
% \fi
%
-% \CheckSum{127}
+% \CheckSum{139}
%
%
% \changes{v0.0}{2006/01/31}{Erste Fassung}
% \changes{v0.1}{2006/02/12}{Erste veröffentlichte Fassung}
+% \changes{v0.5}{2009/11/06}{README jetzt in UTF-8}
%
% \GetFileInfo{pauldoc.sty}
%
@@ -71,31 +75,44 @@
%
% \subsection{Package-Optionen}
%
-% \DescribeMacro{chapter}
-% Diese Option legt fest, dass Index und Liste der Änderungen
+% \DescribeOption{chapter}
+% Die Option 'chapter' legt fest, dass Index und Liste der Änderungen
% in einem eigenen Kapitel (anstatt in einem Abschnitt) beginnen.
% Dies ist nur in einer Dokumentenklasse sinnvoll, welche
% überhaupt '\chapter' definiert, etwa den 'book'-artigen Klassen.
%
-% \DescribeMacro{section}
-% Legt fest, dass Index und Änderungsliste in einem Abschnitt beginnen.
-% Dies ist der Vorgabewert.
+% \DescribeOption{section}
+% Die Option 'section' legt fest, dass Index und Änderungsliste in
+% einem Abschnitt beginnen. Dies ist der Vorgabewert.
+%
+% \DescribeOption{latin1}
+% Die Option 'latin1' legt fest, dass das Dokument im ISO-8859-1-Format
+% kodiert ist. Dies ist der Vorgabewert.
+% (Die Option wird an das \pack{inputenc}-Paket weitergegeben.)
+%
+% \DescribeOption{utf8}
+% Die Option 'utf8' legt fest, dass das Dokument als UTF-8
+% kodiert ist. (Die Option wird an das \pack{inputenc}-Paket weitergegeben.)
%
% \subsection{Neue Makros}
%
% \DescribeMacro{\ifReferenceExists}\marg{refName}\marg{then}\marg{else}
%
-% Mit diesem Makro kann man, abhängig davon, ob eine bestimmte Referenz mit
-% '\label{}' gesetzt wurde, bestimmten Text ausgeben.
+% Mit diesem Makro kann man, abhängig davon, ob eine bestimmte Referenz
+% mit '\label{}' gesetzt wurde, bestimmten Text ausgeben.
%
-% Falls ein '\ref'\marg{refName} Erfolg hätte, wird \meta{then} ausgewertet,
-% ansonsten \meta{else}.
-% Dies ist nützlich, wenn man im Beschreibungsteil verschiedenen Text aufnehmen
-% will, abhängig davon, ob auch der Implementationsteil mitgesetzt wird -- man
-% kann dann etwa auf einen bestimmten Abschnitt darin verweisen, und andernfalls
-% den Text im Konjunktiv formulieren ("`Wenn der Implementationsteil mit enthalten
+% Falls ein '\ref'\marg{refName} Erfolg hätte, wird \meta{then}
+% ausgewertet, ansonsten \meta{else}.
+% Dies ist nützlich, wenn man im Beschreibungsteil verschiedenen Text
+% aufnehmen will, abhängig davon, ob auch der Implementationsteil
+% mitgesetzt wird -- man kann dann etwa auf einen bestimmten Abschnitt
+% darin verweisen, und andernfalls den Text im Konjunktiv formulieren
+% ("`Wenn der Implementationsteil mit enthalten
% wäre, könnte man dort jetzt \dots finden."').
%
+% Gegebenenfalls wird erst beim zweiten \LaTeX-Durchlauf der richtige
+% Zweig ausgewertet.
+%
% \noindent\DescribeMacro{\pack}\marg{name}
%
% In Paketbeschreibungen werden häufiger Paketnamen (der des eigenen
@@ -108,9 +125,9 @@
%
% \DescribeMacro{\includeLicense}
% '\includeLicense' bindet die eventuell im \TeX-Suchpfad zu findende
-% Lizenz ein. Dies ergibt -- je nach dem, ob 'section' oder 'chapter'
-% als Option gegeben wurde -- ein neues Kapitel oder einen neuen
-% Abschnitt. Durch Neudefinition von\DescribeMacro{\lpplfilename}
+% Lizenz (LPPL) ein. Dies ergibt -- je nach dem, ob 'section' oder
+% 'chapter' als Option gegeben wurde -- ein neues Kapitel oder einen
+% neuen Abschnitt. Durch Neudefinition von\DescribeMacro{\lpplfilename}
% '\lpplfilename' kann festgelegt werden, welche Datei zu verwenden
% ist -- als Vorbgabewert ist die bei \LaTeX{} mitgelieferte Datei
% \texttt{\lpplfilename} im Package festgelegt.
@@ -133,7 +150,7 @@
% '\marg{text}' gibt \marg{text} aus. Die Abkürzung steht für
% "`mandatory argument"'.
% '\oarg{text}' ergibt \oarg{text} ("`optional argument"').
-% '\parg{te,xt}' ergibt \parg{te,xt} ("`picture mode argument"').
+% '\parg{text}' ergibt \parg{text} ("`picture mode argument"').
%
%
% \StopEventually{\appendix\PrintChanges\PrintIndex}
@@ -162,23 +179,48 @@
%
% \subsection{Package-Optionen}
%
-% \begin{macro}{chapter}
-% '\chapter' als Trenner.
+% \begin{option}{utf8}
+% \changes{v0.5}{2009/11/03}{Parameter für die Kodierung, wird an
+% \pack{inputenc} weitergegeben.}
+% \begin{option}{latin1}
+% \changes{v0.5}{2009/11/03}{Parameter für die Kodierung, wird an
+% \pack{inputenc} weitergegeben.}
+% \begin{macro}{\pauldoc@ienc}
+% Mi der Option 'utf8' bzw. 'latin1' wähle ich die Kodierung der
+% Dokumentation aus. 'latin1' ist der Default.
+% Die Optionen selbst merken sich ihren Wert einfach in der Variable
+% '\pauldoc@ienc'.
+% \begin{macrocode}
+\newcommand*\pauldoc@ienc{}
+\DeclareOption{utf8}{
+ \def\pauldoc@ienc{utf8}
+}
+\DeclareOption{latin1}{
+ \def\pauldoc@ienc{latin1}
+}
+\ExecuteOptions{latin1}
+% \end{macrocode}
+% \end{macro}
+% \end{option}
+% \end{option}
+%
+% \begin{option}{chapter}
+% '\chapter' für die Index-Überschrift.
% \begin{macrocode}
\DeclareOption{chapter}{
\let\pauldoc@indexsec=\chapter
}
% \end{macrocode}
-% \end{macro}
+% \end{option}
%
-% \begin{macro}{section}
-% '\section' als Trenner.
+% \begin{option}{section}
+% '\section' für die Index-Überschrift.
% \begin{macrocode}
\DeclareOption{section}{
\let\pauldoc@indexsec=\section
}
% \end{macrocode}
-% \end{macro}
+% \end{option}
%
% \begin{macro}{\pauldoc@indexsec}
% Wir definieren noch '\pauldoc@indexsec', rufen dann
@@ -193,19 +235,20 @@
%
% \subsection{geladene Pakete}
%
-% Wir laden das Paket \pack{inputenc} mit Option 'latin1', um
-% Sonderzeichen auch so eingeben zu können. \pack{babel} sorgt
-% für vernünftige deutsche Bezeichnungen.
+% Wir laden das Paket \pack{inputenc} mit Option 'latin1' oder 'utf8' (je
+% nach Paketoption), um Sonderzeichen auch direkt eingeben zu können.
+%
+% \pack{babel} sorgt für vernünftige deutsche Bezeichnungen.
% \begin{macrocode}
-\RequirePackage[latin1]{inputenc}
+\RequirePackage[\pauldoc@ienc]{inputenc}
\RequirePackage[ngerman]{babel}
% \end{macrocode}
%
% \changes{v0.3}{2006/03/23}{Jetzt mit \cs{usepackage}\protect\linebreak[0]'[T1]{fontenc}'}
% \pack{fontenc} mit Option 'T1' lädt das T1-Fontencoding, in dem
% etwa Umlaute direkt aus der Schriftart genommen werden können,
-% anstatt sie mit \"{ } und den Vokalen a, o und u zusammenzusetzen. Dies führt
-% auch zu einer verbesserten Silbentrennung.
+% anstatt sie mit \"{ } und den Vokalen a, o und u zusammenzusetzen.
+% Dies führt auch zu einer verbesserten Silbentrennung.
% \begin{macrocode}
\RequirePackage[T1]{fontenc}
% \end{macrocode}
@@ -214,7 +257,7 @@
%
% Wir wollen natürlich in der Doku Querverweise haben,
% die Änderungen registrieren (für eine entsprechende Liste)
-% und im Index mit Zeilennummern arbeiten. Codestellen
+% und im Index mit Zeilennummern arbeiten. Quelltext in der Doku
% wollen wir mit \verb|'| markieren.
% \begin{macrocode}
\EnableCrossrefs
@@ -222,21 +265,29 @@
\CodelineIndex
\AtBeginDocument{\MakeShortVerb{\'}\selectlanguage{ngerman}}
% \end{macrocode}
-% Außerdem sollten Index und Änderungsliste auf deutsch beschriftet werden.
-% Wie benutzen hier '\@pauldoc@indexsec', was entweder '\section'
-% oder '\chapter' ist.
+% Außerdem sollten Index und Änderungsliste auf deutsch beschriftet
+% werden. Wie benutzen hier für die Überschrift '\@pauldoc@indexsec', was
+% entweder '\section' oder '\chapter' ist.
+% \changes{v0.5}{2009/11/01}{Ä $\Rightarrow$ '\"A' in
+% "`Liste der Änderungen"', und entsprechend für "`Schräggedruckte"'}
% \begin{macrocode}
\renewcommand{\generalname}{Allgemein}
-\GlossaryPrologue{\pauldoc@indexsec{Liste der Änderungen}}
-\IndexPrologue{\pauldoc@indexsec{Index}
+
+\GlossaryPrologue{\pauldoc@indexsec{Liste der \"Anderungen}}
+
+\IndexPrologue{
+
+ \pauldoc@indexsec{Index}
- Schräggedruckte Nummern verweisen auf die Seite, auf der der
+ Schr\"aggedruckte Nummern verweisen auf die Seite, auf der der
Eintrag beschrieben ist, unterstrichene Nummern zeigen auf die
Zeilennummer der Definition, sonstige Zahlen auf die Zeilennummer
- einer Verwendung.}
+ einer Verwendung.
+
+ }
% \end{macrocode}
-% Der Index bekommt nur zwei Spalten (wir haben einige ziemlich lange
-% Makronamen).
+% Der Index bekommt nur zwei statt sonst drei Spalten (wir haben einige
+% ziemlich lange Makronamen).
% \begin{macrocode}
\setcounter{IndexColumns}{2}
% \end{macrocode}
@@ -298,10 +349,10 @@
% vom 13. Januar 2006 einige Verrenkungen notwendig -- siehe unten.
%
% Am 10. Februar habe ich einen Vorschlag zur Verbesserung
-% an die LaTeX-Bug-Liste geschickt, das wurde positiv aufgenommen.
+% an die LaTeX-Bug-Liste geschickt, das wurde positiv aufgenommen.%
% \footnote{Siehe \texttt{http://www.latex-project.org/cgi-bin/ltxbugs2html?pr=latex/3839}.}
-% Ich habe jetzt von eine verbesserte Version von Frank Mittelbach bekommen,
-% die hoffentlich demnächst auch veröffentlicht wird.
+% Ich habe dann von eine verbesserte Version von Frank Mittelbach bekommen,
+% die inzwischen auch veröffentlicht wurde.
%
% Wir wollen die Abschnitte der Lizenz auch nummeriert
% (und im Inhaltsverzeichnis) haben, deswegen die Versionen
@@ -412,8 +463,8 @@
% das die unter dem Namen \texttt{\lpplfilename}
% verbreitete LPPL.
% \begin{macrocode}
-\AtBeginDocument{
- \providecommand{\lpplfilename}{lppl.tex}
+\AtBeginDocument{%
+ \providecommand{\lpplfilename}{lppl.tex}%
}
% \end{macrocode}
% \end{macro}
@@ -469,7 +520,7 @@
% \end{macro}
%
% \begin{macro}{\parg}
-% |\parg{te,xt}| ergibt \parg{te,xt} ("`picture mode argument"').
+% |\parg{text}| ergibt \parg{text} ("`picture mode argument"').
% \begin{macrocode}
\providecommand\parg[1]{%
{\ttfamily(}\meta{#1}{\ttfamily)}}