1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
\def\exposedate{2011/09/04}
\ProvidesFile{expose.tex}[\exposedate]
\documentclass[a4paper,11pt]{article}
\usepackage{german}
\newcommand*{\DQ}[1]{"`#1"'}
\usepackage{parskip}
\parskip=.84\parskip
\usepackage[atari]{umlaute}
\input{makedoc.cfg}
\providecommand{\pkg}{\pkgnamefmt}
\providecommand{\code}{\texttt}
\title{Paketdokumentation und Webseitenpflege\\
mit (\pkg{niceverb.sty} und) \pkg{fifinddo.sty}}
\author{\acro{DANTE}-Herbsttagung 2011\\Uwe Lck}
\date{Entwurf \exposedate}
\begin{document}
\maketitle
\thispagestyle{empty}
Das 'nicetext'-Bndel\urlpkgfoot{nicetext}
versucht sich an
\wikideref{Syntaktischer Zucker}{\strong{%
\DQ{syntaktischem Zucker}}:}
Schriftsatz in \TeX-Qualitt
bei mglichst wenig \TeX-artiger Auszeichnung.
% Grundstzlich sehe ich dafr zwei Methoden:
Das kann durch
(MS)~Zeichenkettenersetzung %%%,
oder (auch) durch
(MA)~aktive Zeichen
(die einige Fallunterscheidungen ausfhren) %%%.
% Sie schlieen sich keineswegs gegenseitig aus.
% Die praktische Bedeutung des Bndels liegt fr mich zur Zeit
% ganz in der Paketdokumentation.
erreicht werden.
Die \DQ{herrschende Lehre} fr die \strong{Dokumentation} von \LaTeX-Paketen
ist die \DQ{\file{.dtx}}-Methode, die z.\,B. eine spezielle
Markierung des Paketcodes erfordert.
'makedoc.sty' aus dem 'nicetext'-Bndel dagegen
setzt die gute alte Idee um, dass man Kommentarzeilen schon
% dadurch dadurch von Codezeilen unterscheiden kann,
% dass erstere mit einem Kommentarzeichen (\lq\code{\%}\rq) beginnen!
am Kommentarzeichen (\lq`%'\rq) erkennt!
Mit derselben Absicht verwendete Stephan Bttcher die
\strong{Skriptsprache} \meta{\Wikideref{awk}}
% fr die Dokumentation von
zur Kommentierung von 'lineno.sty'.\urlpkgfoot{lineno}
'makedoc.sty' bietet % dem gegenber
stattdessen eine Skriptsprache, % deren Interpretationsengine
die wie bei 'docstrip.tex'\urlpkgfoot{docstrip}
durch die \TeX-Engine selbst verarbeitet wird,
zusammen mit besonderen Makros.
'makedoc' wandelt die Paketdatei in eine Dokumentationsdatei um,
indem Kommentarzeichen entfernt und Codezeilen in Listing-Umgebungen
eingebettet werden. Bei dieser Gelegenheit kann auch gem Methode (MS)
\TeX-Code fr typografische Feinheiten eingefgt und die
\Wikideref{MediaWiki}-\wikideref{Hilfe:Inhaltsverzeichnis}{Gliederung}
umgesetzt werden.
'niceverb.sty' (ebenfalls in 'nicetext') % bietet weitere Feinheiten
ermglicht weiter
nach der Methode (MA)
% fr
eine geradezu \acro{WYS\-I\-WYG}-artige \strong{Syntaxbeschreibung}
fr Paketmakros. \linebreak
% Sogar Pakete anderer Autoren (z.\,B. Donald Arseneau)
% knnen in \TeX-Qualitt aus der reinen ASCII-Dokumentation
% in der Paketdatei gesetzt werden, ohne nderungen an dieser Datei
% vorzunehmen.
% Bei eigenen Paketen erfordert die Kommentierung
% wenig mehr Aufwand als Kommentarzeichen, und der Kommentarcode
% ist so leserlich wie berhaupt nur mglich.
Makros kn\-nen \DQ{im Handumdrehen} kommentiert werden.
% (oder man schreibt zuerst den Kommentar als Plan)~\dots
Vorhandene \linebreak
\acro{ASCII}-Dokumentation kann \DQ{automatisch}
in \TeX-Qualitt gesetzt werden.
% \enlargethispage{1\baselineskip}
'makedoc.sty' erweitert die \TeX-Skriptsprache aus 'fifinddo.sty'
zum Verarbeiten von Text-Dateien zu Text-Dateien.
'blog.sty' aus dem \ctanpkgref{morehype}-Bndel
setzt ebenfalls auf 'fifinddo' auf.
Im Gegensatz zu 'makedoc' werden dabei die Makros der Quelldateien
\emph{expandiert} -- in \strong{\acro{HTML}}-Tags und -Zeichen.
Der Vortrag vergleicht diese Anstze mit denen
\httpref{www.webdesign-bu.de/uwe\string_lueck/heyctan.htm\#mine-related}
{\strong{anderer}} Autoren.
\end{document}
|