summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/bgteubner/LIESMICH
blob: 2076f504da71fba5545df199a5c0fc3f433b011f (plain)
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220

Dokumentklasse zum Erstellen von Büchern für den Springer Vieweg Verlag
=======================================================================



1. Einleitung
-------------

Die Dokumentklasse »bgteubner.cls« habe ich im Auftrag des
Teubner-Verlags (der sich mittlerweile über Vieweg+Teubner in Springer
Vieweg umbenannt hat), Wiesbaden, programmiert, um den Büchern dieses
Verlags ein einheitliches Aussehen zu geben. Nach Absprache mit
dem Verlag darf ich die Dokumentklasse mit den zugehörigen
Dateien und Dokumentationen frei verfügbar machen.

Da es sich um eine Vorlage für Bücher handelt, die möglichst gut
zusammen passen sollen, sind sehr viele Dinge (Layout usw.) fest
vorgegeben und können normalerweise durch den Anwender nicht
geändert werden. Sollten Sie diese Dokumentklasse für einen 
anderen Zweck als einen Verlagsveröffentlichung beim Teubner-Verlag
verwenden, können dadurch ungewollte Einschränkungen entstehen 
(beispielsweise bietet die Dokumentklasse nur die Papierformate
DIN A-5 und 17cm x 24cm an; es stehen nur die Schriftfamilien Times
oder European Computer Modern zur Verfügung).
Falls Sie Dateien Ihren Bedürfnissen anpassen wollen, müssen sie diese
entsprechend der LPPL-Lizenz vorher umbenennen. Beachten Sie dabei
bitte zusätzlich die Bestimmungen der Dateien bgteucls.dtx und
bgteubner.cls, die dort angegeben sind.

Wenn Sie Dokumente mit Hilfe dieser Dokumentklasse erstellen, wird
in die PDF-Datei im Feld »Creator« ein Hinweis auf den Klassennamen
und den Teubner-Verlag abgelegt. Sollten Sie eine abgeleitete Klasse
entwickeln, müssen beide Einträge erhalten bleiben. Ich kann Ihnen
nach LPPL nicht verbieten, in Ihren Dokumenten den Eintrag zu
überschreiben, bitte Sie, auch im Namen des Verlags, aber darum,
dies zu unterlassen.

Die Dokumentklasse verlangt bei einigen hinzugeladenen Paketen relativ 
neue Versionen und lädt einige Pakete, die auf den meisten LaTeX-
Installationen wohl normalerweise nicht installiert sind. Eine Liste
aller benötigten Dateien ist in der Datei usefiles.txt enthalten.
Nicht alle Pakete werden, abhängig von den Klassenoptionen, immer
benötigt, auf eine genauere Aufschlüsselung verzichte ich jedoch.

Falls Sie zu viele Pakete mit alten Versionen besitzen, könnte es
sich lohnen, eine moderne TeX-Distribution zu installieren.

Die Dokumentationsdateien bgteubner-17x24-times.pdf und
bgteubner-17x24-cm.pdf (die sich nur in der verwendeten Brotschrift
unterscheiden) enthalten neben einer ausführlichen Anleitung
zur Verwendung der Dokumentklasse Installationsanweisungen für
TeXLive 8, wobei sich einige Dinge zur Herkunft bestimmter Dateien 
auf die CD beziehen, die der Teubner-Verlag besitzt. Wenn diese
Dateien nicht in der Distribution der bgteubner-Klasse befinden, 
sollten Sie sie auf einem CTAN-Server (z. B. ftp.dante.de) finden.



2. Aufbau der Distribution und Installation
-------------------------------------------

Der Aufbau der Distribution unterscheidet sich, je nachdem, ob Sie
eine CD vom Teubner-Verlag erhalten haben oder die Dokumentklasse von
CTAN (ftp-Server oder Abbild-CD) verwenden.


2.1 CTAN-Version
----------------

Das Bundle besitzt folgenden Aufbau:

doc/          Dokumentation:
              bgteubner-17x24-times.pdf  Autorenrichtlinien (Times),
              bgteucls.pdf               Dokumentation der Dokumentklasse
                                         (nur für Experten).
doc/src/      Quelltext der Dokumentation.
hhsubfigure/  Quelltext des hhsubfigure-Pakets.
source/       Quelltext der Dokumentklasse.


Zur Installation der Dokumentklasse und der Zusatzdateien müssen Sie in
das Verzeichnis source/ wechseln. Dort muss die Datei »bgteucls.ins« mit
LaTeX übersetzt werden. Dabei werden einige Dateien erzeugt, die in 
unterschiedliche Verzeichnisse kopiert werden müssen. Wenn die TeX-
Distribution TDS-konform ist und der Lokale TeXMF-Baum $TEXMFLOCAL
heißt, sind dies:

  $TEXMFLOCAL/tex/latex/bgteubner/bgteubner.cls 
  $TEXMFLOCAL/tex/latex/ptmxcomp/ptmxcomp.sty
  $TEXMFLOCAL/makeindex/bgteubner/bgteubner.ist 
  $TEXMFLOCAL/makeindex/bgteubner/bgteuglo.ist 
  $TEXMFLOCAL/makeindex/bgteubner/bgteuglochar.ist 
  $TEXMFLOCAL/bibtex/bst/bgteubner/bgteupln.bst 
  $TEXMFLOCAL/bibtex/bst/bgteubner/bgteupln2.bst
  $TEXMFLOCAL/bibtex/bst/bgteubner/bgteuabbr.bst     
  $TEXMFLOCAL/bibtex/bst/bgteubner/bgteuabbr2.bst

Wenn Sie unter Unix arbeiten, können Sie alle Schritte durch ein
einziges 
  make install
erledigen.

Zusätzlich muss das hhsubfigure-Paket installiert werden. Dazu verwenden
Sie LaTeX im Verzeichnis hhsubfigure/ auf die Datei hhsubfigure.ins und
kopieren Sie anschließend die Datei hhsubfigure.sty in das Verzeichnis

  $TEXMFLOCAL/tex/latex/hhsubfigure/

Da sich das hhsubfigure-Paket nur intern von subfigure.sty unterscheidet,
verwenden Sie bitte die zu diesem Paket gehörige Dokumentation.

Sicherlich werden Ihnen weitere Pakete fehlen, die von der Dokumentklasse
verwendet werden. Besorgen Sie sich diese bitte von eine CTAN-Server oder
der CTAN-CD. Einen Überblick über verwendete Pakete ist in usefiles.txt
enthalten.


2.2 Teubner-CD-Version
----------------------

Sollten Sie eine CD vom Teubner-Verlag erhalten haben, so hat sie
folgenden Aufbau:

doc/          Dokumentation:
              bgteubner-17x24-cm.pdf     Autorenrichtlinien (European
                                         Computer Modern),
              bgteubner-17x24-times.pdf  Autorenrichtlinien (Times),
              bgteubner-17x24-mathtime.pdf  Autorenrichtlinien (Times mit
                                         MathTime und MathTimePlus),
              bgteucls.pdf               Dokumentation der Dokumentklasse
                                         (nur für Experten).
doc/src/      Quelltext der Dokumentation.
pakete/       Klassen und Pakete, die in TeXLive 8 nicht oder nur veraltet
              enthalten sind.
hhsubfigure/  Quelltext des hhsubfigure-Pakets.
source/       Quelltext der Dokumentklasse (nur für Experten).
alt/          Alte Versionen der Dokumentklasse. Dieses Verzeichnis kann
              dann wichtig sein, wenn Sie ein Buch mit einer alten Version
              übersetzt haben und sich beispielsweise die Umbrüche durch die
              Verwendung einer neueren Version ändern, dies im speziellen
              Fall aber unerwünscht ist.

Konsultieren Sie bitte zur Installation die Dokumentation im PDF-Format.



3. Update
---------

Falls Sie von einer älteren Version updaten, können Sie in der Datei
ChangeLog im Verzeichnis source/ oder am Ende der Datei bgteucls.pdf
im Verzeichnis doc/ nachlesen, was sich seit Ihrer alten Version
verändert hat.

Von Version 1.07 auf 1.10 wurden einige Abstände verändert, so dass sich 
viele Zeilen- und Seitenumbrüche verändern. Sollten Sie im Endstadium
einer Dokumenterstellung sein, kann es sinnvoll sein, das Klassenupdate
zu verschieben.

Von Version 1.14 auf 1.21 wurden einige Randeinstellungen in den
important(*)- und lonimportant(*)-Umgebungen verändert, so dass es
zu Veränderungen des Umbruchs kommen kann.


Die folgenden Hinweise sind nur für Nutzer relevant, die schon eine 
Version <1.06 verwendet haben:

Wenn Sie bisher das Paket hfo.sty verwendet haben, so _ersetzen_ sie
dies bitte duch das hfoldsty-Paket. Dazu müssen Sie unterhalb des lokalen
TeXMF-Verzeichnisses (normalerweise »C:\Programme\TeXLive\texmf-local« 
oder »/usr/TeX/texmf-local«) alle Verzeichnisse des Namens »hfo« löschen.
Dies sind im einzelnen »doc/latex/hfo«, »tex/latex/hfo«, 
»fonts/vf/public/hfo« und »fonts/tfm/public/hfo«. Entpacken Sie
anschließend im lokalen TeXMF-Verzeichnis die Datei »hfoldsty-1_00.zip«
oder die entsprechende neuere Version. Abschließend muss noch die 
Dateidatenbank aktualisiert werden, entweder über das Startmenü oder
durch den Programmaufruf »texhash«.
  Aufgrund eines Namenskonflikts wurde der Befehl \tensor in der
Version 1.06 in \tens umbenannt. Bitte benennen Sie alle Aufrufe dieses
Befehls um.



4. Lizenzbestimmungen (im englischen Originaltext)
--------------------------------------------------

bgteubner class bundle

Copyright 2003--2012 Harald Harders

This program may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either version 1.3
of this license or (at your opinion) any later version.
The latest version of this license is in
 http://www.latex-project.org/lppl.txt
and version 1.3 or later is part of all distributions of LaTeX
version 1999/12/01 or later.
 
This program consists of all files listed in manifest.txt.

harald.harders@gmx.de


Für die Dateien bgteucls.dtx und bgteubner.cls gilt folgende
Zusatzbestimmung:

If you modify a renamed copy of the files `bgteubner.cls' or
`bgteucls.dtx', you have to preserve some information in the
PDF /Creator entry. The following data have to remain:
- The name `bgteubner.cls',
- a hint that this class has been developed for the `Teubner
  Verlag, Wiesbaden, Germany'.


--------------------------------------------------

Harald Harders
harald.harders@gmx.de
2012-04-07