Technische Dokumentation

Technische Dokumentation
Sommersemester
2015
9. April 2015
Bachelorstudiengang
Fach¨
ubergreifendes Wahlfach
Prof. Dr. Dieter Kilsch
Fachbereich 2
Informatik, Technik und Wirtschaft
Technische Dokumentation
mit LATEX
Inhaltsverzeichnis
Einleitung
§1
iii
Warum LATEX
Kapitel I
§2
.
.
.
.
.
.
.
.
.
.
LATEX
Editoren
iii
1
.
.
.
2.A
2.B
2.C
2.D
2.E
§3
§4
.
WinEdt
TEXnicCenter
TEXWorks
.
TEXMaker
.
TEXStudio
.
Distributionen
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
1
1
1
2
2
2
.
.
.
.
.
.
.
.
.
.
2
LAT
.
.
Klassendateien, Stildatein
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
2
Kapitel II
Technisches Schreiben
§5
pdfLAT
EXund
.
EX
.
.
.
.
.
7
.
Literaturverzeichnis
.
.
.
.
.
.
.
7
12
ii
Einleitung
§ 1 Warum LATEX
Vorteile von LATEX
(a) Formeleditor (Mathematik, Chemie)
(b) gute Organisation
• Verzeichnisse:
Inhaltsverzeichnis
Literaturverzeichnis
Stichwortverzeichnis (Index)
Abk¨
urzungsverzeichnis (Symbolverzeichnis)
Glossar
Abbildungsverzeichnis
Tabellenverzeichnis
Algorithmenverzeichnis
Autorenverzeichnis
• Wechsel zwischen Sprachen
• Trennung, Blocksatz
• Kleine Quelldateien
• Serienbrief, auch in Pr¨
asentation
• Makros vereinfachen Eingabe
• programmierbar
(c) Einbinden von Grafiken
• LATEX: eps, (bmp)
• pdfLATEX: pdf, png, jpg
(d) Quelldateien:
• Mehrere Dateien als Quelle m¨oglich
• Unicode
(e) Zieldateien:
• ps, pdf mit Lesezeichen aus Gliederung
• Pr¨
asentation mit Beamer-Paket
(f) kostet nichts
(g) Open source: Es entstehen neue Pakete zu aktuellen Themen
iii
iv
Nachteile von LATEX
(a) Nicht Wysiwyg
Einleitung
Kapitel I
LATEX
§ 2 Editoren
Alle genannten Editoren sind f¨
ur LATEX und pdfLATEX vorkonfiguriert und inzwischen utf8-f¨
ahig.
2.A
WinEdt
WinEdt (http://www.winedt.com/) ist ein kommerzieller Editor, den ich seit Mitte der 90er Jahre
benutze und der seit dieser Zeit deutlich weiterentwickelt wurde und wird. Yap ist ein previewer
auf der .dvi-Basis, der das Hin- und Herspringen zwischen Quelle und Druckbild erlaubt.
Die Zielsuche f¨
ur pdf-Dateien, die mit dem Programm SumatraPDF betrachtet werden, wurde
in http://robjhyndman.com/hyndsight/synchronizing-winedt-and-pdf-files/ von Rob J Hyndman
beschrieben:
(a) SumatraPDF herunterladen und im (Standard-)Verzeichnis c:\Program files\SumatraPDF
installieren.
(b) WinEdt 6.0 (und neuere Versionen?): Unter WinEdt im Options/Execution - Mode: Auf
PDF Viewer“ und dann auf Sumatra PDF“ klicken. Der Kasten Sync Tex“ muss aktiviert
”
”
”
sein. Anschließend OK“ klicken.
”
(c) F¨
ur ¨
altere Versionen findet man dort auch eine aufw¨andigere Anleitung.
(d) F¨
ur die Quellsuche muss in SumatraPDF unter Einstellungen/Optionen im Feld Befehlszeile
”
f¨
ur Inverssuche“ eingetragen werden:
"C:\ProgInst\WinEdt5\WinEdt.exe" "[Open(|%f|);SelPar(%l,8);]"
Zielsuche und Quellsuche werden als Synchronisierung bezeichnet. Die beschriebene Methode
funktioniert mit Unterdateien nicht. Diesen Punkt habe ich den folgenden Editoren nicht getestet.
2.B
TEXnicCenter
TEXnicCenter (http://www.texniccenter.org/) ist ein kostenfreier Editor, den man am besten auch
mit SumatraPDF synchronisiert:
Die Zielsuche ist voreingestellt. F¨
ur die Quellsuche in die Quelldatei muss in SumatraPDF unter
Einstellungen/Optionen im Feld Befehlszeile f¨
ur Inverssuche“ eingetragen werden:
”
"C:\ProgInst\TeXnicCenter\TEXCNTR.EXE" /ddecmd "[goto(’%f’, ’%l’)]", s. William Blum:
Synchronisierung pdf-Editor http://william.famille-blum.org/blog/static.php?page=static081010000413
1
I LATEX
2
2.C
TEXWorks
TEXWorks (https://www.tug.org/texworks/) ist ein kostenfreier Editor mit eingebautem pdf-Be¨
trachter mit Synchronisierung. Zu beachten ist, dass das Anderungen
in den Einstellungen erst
beim n¨achsten Start wirksam werden.
2.D
TEXMaker
TEXMaker (http://www.xm1math.net/texmaker/) ist ein kostenfreier Editor mit eingebautem pdfBetrachter mit Synchronisierung.
2.E
TEXStudio
TEXStudio (http://texstudio.sourceforge.net/) ist ein kostenfreier Editor mit eingebautem pdf-Betrachter mit Synchronisierung. Dieses Programm gilt als Nachfolger von TEXmaker.
TEXstudio spaltete sich 2009 von TEXmaker ab und wurde mit h¨oherem Benutzerkomfort weiter
entwickelt. Aber auch TEXmaker hat sich weiter entwickelt.
§ 3 Distributionen
Eine LATEX-Distribution besteht aus dem TEX-Kern, der dar¨
uberliegenden H¨
ulle LATEX und vielen
Stil-Dateien (Paketen).
Ich benutze MikTEX(www.miktex.org), sie kann unter Unix und Windows benutzt werden.
Die LATEX-Distribution
§ 4 LATEXund pdf LATEX
Klassendateien, Stildatein
Kapitel II
Technisches Schreiben
§5
7
Literaturverzeichnis
[1] Goossens, M., S. Rahtz, F. Mittelbach, D. Roegel, and P. Voß: The LATEX Graphics
Companion. Addison-Wesley, Boston, 2nd ed., 2007. ISBN 978-0-3215-0892-8, e53.14.
[2] Juhl, D.: Technische Dokumentation. Springer, Berlin, 2. Aufl., 2005. ISBN 978-3-540-238133, e44.95.
[3] Knappen, J.: Schnell ans Ziel mit LATEX2. Oldenbourg, M¨
unchen, 1997. ISBN 3-486-24199-0.
[4] Kohm, M. und J.-U. Marowski: KOMA-Script: Eine Sammlung von Klassen und Paketen
f¨
ur LATEX2. Lehmanns Media, Berlin, 2008. ISBN 978-3-86541-291-1, e19.95.
[5] Kopka, H.: LATEX, Band 1 - Einf¨
uhrung. Addision Wesley, Bonn, 2. Aufl., 1996. ISBN
3-8273-1025-3, FHBib: 980143/271510, e39.95.
[6] Kopka, H.: LATEX, Band 2 - Erg¨
anzungen. Addision Wesley, Bonn, 2. Aufl., 1997. ISBN
3-8271-1229-9, FHBib: 980144/271510, e39.95.
[7] Kopka, H.: LATEX, Band 3 - Erweiterungen. Addision Wesley, Bonn, Ndr. 1. Aufl., 2002.
ISBN 3-8273-7043-4, FHBib: 980145/271510, e39.95.
[8] Lanze, W.: Das technische Manuskript. Vulkan, Essen, 1983. ISBN 3-8027-8122-8, FHBib:
832375/102022/K.
[9] Rechenberg, P.: Technisches Schreiben. Hanser, M¨
unchen, 3., erw. Aufl., 2006. ISBN 9783-446-40695-7, e19.90.
[10] Schlager, P. und M. Thibud: Wissenschaftlich mit LATEX arbeiten. Pearson, M¨
unchen,
2007. ISBN 978-3-8273-7239-0, e19.95.
[11] schlosser, J.: Wissenschaftliche Arbeiten schreiben mit LATEX: Leitfaden f¨
ur Einsteiger . Verlagsgruppe H¨
uthig-Jehle-Rehm, Heidelberg, 3. Aufl., 2009. ISBN 978-3-8266-5892-1, e19.95.
[12] Schmidt, W., J. Knappen, H. Partl und I. Hyna: LATEX2-Kurzbeschreibung, 2003. http:
//www.ctan.org/tex-archive/info/lshort/german/l2kurz.pdf, 1.4.2009.
[13] SG MB und WI: Leitfaden zur Anfertigung von Berichten.
FH Bingen, April
2014. http://static.fh-bingen.de/fileadmin/user upload/Studiengaenge/Dateien fuer News/
FB2-MWi/2014-04-03 Leitfaden Ausarbeitungen.pdf.
[14] Sturm, T. F.: LATEX . RRZN-Handbuch. Regionales Rechenzentrum f¨
ur Niedersachsen, Hannover, 8. Aufl., September 2011.
[15] Voß, H.: PSTricks - Grafik mit Postscript f¨
ur TEX und LATEX . Lehmanns Media, Berlin, 5.
Aufl., 2008. ISBN 978-3-86541-280-5, http://PSTricks.tug.org, e29.95.
F¨
ur die Preise u
urlich keine Gew¨ahr.
¨bernehme ich nat¨
12

Download Report