Datei "liesmich.txt" (v2.0, 15.08.2005) ==================== Sie finden hier eine Kurzbeschreibung des UBTlettr-Pakets, sowie eine kurze Installationsanweisung. Bitte lesen Sie diesen Text komplett durch! Fehlermeldungen, sowie Kritik, Anregungen, Verbesserungsvorschläge und insbesondere Lob, Autogrammwünsche und Spenden bitte an wolfgang.schoepf@uni-bayreuth.de Eine Version dieses Pakets trägt üblicherweise das Distributionsdatum, und Sie finden die jeweils aktuelle Version unter http://www.uni-bayreuth.de/corporate_design/briefvorlagen/LaTeX.html Ich habe mir größte Mühe gegeben, das Paket fehlerfrei und funktionsfähig zu bekommen, außerdem wurde es von zwei Personen unabhängig getestet. Fehlerfreiheit und Funktion kann aber natürlich nicht garantiert werden. Das UBTlettr-Paket ================== Sinn dieses Pakets ist es, LaTeX-Benutzern das Schreiben von Briefen unter Wahrung der Form des neuen UBT-Briefkopfes (Stand August 2001) zu erleichtern. Der Benutzer muss sich also nicht um irgendwelche Formatierungen kümmern, die persönlichen Anpassungen werden durch Optionen und Schalter vorgenommen. Ziel war es, ein komfortables und leicht bedienbares Paket zu entwerfen. Das Paket ist für den Gebrauch mit LaTeX2e konzipiert. Kompatibilität zu LaTeX209 wurde weder getestet, noch in irgendeiner Weise implementiert oder gar gewünscht. Falls Sie tatsächlich noch LaTeX209 verwenden, sollten Sie auch aus anderen, sehr sinnvollen Gründen auf eine moderne LaTeX-Version wechseln! Die Dateien ----------- Folgende Dateien gehören zum UBTlettr-Paket: liesmich.txt - Das lesen Sie gerade. Kurzbeschreibung und Installationsanleitung. UBTlettr.cls - Die UBTlettr-Klasse; hier werden Optionen, Befehle und Layout festgelegt. Diese Datei darf NICHT geändert werden!!! UBTlettr.cfg - Konfigurationsdatei zur Sprachanpassung. Diese Datei können Sie, insbesondere auch für weitere Sprachen, anpassen. UBTlogo.eps - Das UBT-Logo in eps-Format. UBTlogo.pdf - Das UBT-Logo in pdf-Format. lettexpl.tex - Beispiel eines Briefes mit Erklärung aller Optionen und Befehle. addrexpl.from - Beispiel einer input-Datei für die eigene Adresse mit Erklärung aller Befehle. mylogo.eps - Dummy-Logo in eps-Format zur Demonstration eines eigenen, optionalen Logos. mylogo.pdf - Dummy-Logo in pdf-Format zur Demonstration eines eigenen, optionalen Logos. Bemerkungen ----------- Sie müssen für Briefe das hier bereitgestellte UBT-Logo verwenden, also entweder "UBTlogo.eps" oder "UBTlogo.pdf"! Falls Sie zusätzlich zum UBT-Logo noch ein eigenes Logo verwenden, ersetzen Sie bitte die Datei "mylogo.eps" oder "mylogo.pdf" durch dieses Logo. Installation ============ Vorbemerkungen -------------- Sie müssen die Dateien "UBTlettr.cls", "UBTlettr.cfg", "UBTlogo.eps", "UBTlogo.pdf" und "liesmich.txt" in ein Verzeichnis kopieren, wo LaTeX sie findet. Das aktuelle Verzeichnis ist in der Regel nicht so ein Ort! Diese Anleitung geht davon aus, dass Sie eine TDS-konforme TeX-Installation verwenden. TDS-konform sind beispielsweise die Installationen von teTeX und MikTeX. Unter Windows sollte es ein oder mehrere Verzeichnisse des Namens "texmf", "miktex" und/oder "localtexmf" geben. Unter Unix gibt es häufig ein "/usr/texmf" (oder "/usr/share/texmf"), "/usr/local/texmf" (oder "/usr/local/share/texmf") und bei mehreren Usern ein "~/texmf" (also ein Verzeichnis "texmf" im Homeverzeichnis des Anwenders). Eines dieser Verzeichnisse ist der sogenannte primäre texmf-Baum ("/usr/texmf" bzw. "/usr/local/texmf" unter Unix, "texmf" oder "programme\miktex" unter Windows). Dieser wird bei der Installation der TeX-Distribution erzeugt und ausschließlich für die Pakete der TeX-Distribution verwendet. Installieren Sie das UBTlettr-Paket NICHT im primären texmf-Baum!! Eines der Verzeichnisse ist der systemweite texmf-Baum ("/usr/local/texmf" bzw. "/usr/local/share/texmf" unter Unix, "localtexmf" unter Windows, falls Sie es bei der LaTeX-Installation nicht anders genannt hatten). Wenn Sie das UBTlettr-Paket als Administrator (das sind Sie z.B. unter Windows95/98) installieren, ist dies der texmf-Baum, den Sie verwenden sollten. Wenn Sie das UBTlettr-Paket als (Unix-)Anwender installieren, fragen Sie Ihren Administrator, in welchem texmf-Baum dies möglich ist. Sie können auch die Datei texmf.cfg nach der Fragestellung untersuchen, ob Sie als Anwender einen texmf-Baum in Ihrem HOME-Verzeichnis verwenden können. Im folgenden ersetzen Sie bitte ".../localtexmf" durch den von Ihnen verwendeten texmf-Baum. Installation ------------ 1. Kopieren Sie die Dateien "UBTlettr.cls", "UBTlettr.cfg", "UBTlogo.eps" "UBTlogo.pdf" und "liesmich.txt" in das Verzeichnis ".../localtexmf/tex/latex/UBTlettr". Falls das Verzeichnis nicht existiert, legen Sie es bitte an. Beachten Sie unbedingt die Großschreibung von "UBT..."!! 2. Kopieren Sie die restlichen Dateien "lettexpl.tex", "addrexpl.from", "mylogo.eps" und "mylogo.pdf" in das Verzeichnis, in dem Sie arbeiten, also Ihre Briefe schreiben möchten. 3. Je nach LaTeX-Distribution ist es nun noch notwendig, die Distribution über die neu installierten Dateien zu informieren. Unter Unix rufen Sie hierzu "texhash" auf. Bei neueren MikTex-Versionen unter Windows rufen Sie im Startmenü "Programme -> MiKTeX -> MiKTeX Options" auf. Hier klicken Sie unter "General" beim Punkt "File name database" auf "Refresh Now". Bei anderen Systemen konsultieren Sie bitte die Anleitung zum jeweiligen TeX-System oder fragen Sie Ihren Administrator. 4. Wechseln Sie nun in Ihr Arbeitsverzeichnis, und wenden Sie LaTeX auf die Beispieldatei "lettexpl.tex" an. Diese sollte nun problemlos übersetzt werden. Falls Probleme auftauchen, studieren Sie bitte die Fehlermeldungen genau. Sollten Sie die Probleme auch nach längeren Bemühungen und mit Hilfe Ihres System-Administrators nicht lösen können, und bitte erst dann, wenden Sie sich an mich. Wichtig für Unix-Benutzer: Beachten Sie die Großschreibung bei Dateien, die mit "UBT..." beginnen!! 5. Lesen Sie die Erklärungen weiter unten und in den Beispieldateien "lettexpl.tex", "addrexpl.from" genau durch. Sie sollten nun keine Problem haben, den Briefkopf für Ihre Bedürfnisse anzupassen. Benutzung ========= Die Dokumentenklasse und ihre Optionen -------------------------------------- Die erste Zeile in Ihrem Briefdokument muss \documentclass[,,...]{UBTlettr} lauten. Damit benutzen Sie die Klasse "UBTlettr.cls". Ihnen stehen folgende Optionen zur Verfügung (siehe auch Beispieldatei "lettexpl.tex"): 1. chair - fügt den Namen des Lehrstuhl-Leiters zum Absender-Block 2. logo - fügt eine Lehrstuhl-Logo über dem Absender-Block ein 3. street - fügt die Straßen-Adresse zum Absender-Block 4. secr - fügt die Sekretariats-Telefonnummer zum Absender-Block 5. www - fügt die URL zum Absender-Block 6. wwwname - fügt die Wörter `Internet: ' und `email: ' vor der Internet- und email-Adresse ein; bei Zeilenumbruch wird die URL auf der zweiten Zeile gegen "Internet: " eingerückt 7. http - fügt das Wort `http://' vor der Internet-Adresse ein 8. foot - fügt eine Fußzeile auf der ersten Seite ein; wird "wwwname" nicht angegeben, so wird bei Zeilenumbruch die URL auf der zweiten Zeile gegen "http://" eingerückt 9. - liest die Adress-Details aus einer Datei ".from". Prinzipiell können die Adress-Details auch im Briefdokument selbst zwischen `\usepackage' und `\begin{document}' eingegeben werden, dies ist aber nicht unbedingt sinnvoll. Mit dieser Option können Sie sich z.B. mehrere Adress-Dateien definieren, die Sie wahlweise für deutsche und ausländische Empfänger benutzen können. Folgende Namen MÜSSEN Sie angeben (entweder im Briefdokument, oder besser, in der Adress-Datei; siehe auch Beispieldatei "addrexpl.from"): \inst{LEHRSTUHL} - Name des Lehrstuhls (Großbuchstaben) \myname{Name} - Name des Absenders \mail{Anschrift} - Postadresse des Absenders \phone{Telefonnr.} - Telefonnummer des Absenders \fax{Faxnr.} - Faxnummer des Absenders \email{email} - email-Adresse des Absenders Wenn Sie eine dieser Angaben vergessen, erhalten Sie eine entsprechende LaTeX-Fehlermeldung! Folgende Namen SOLLTEN, aber müssen Sie nicht angeben (siehe auch Beispieldatei "addrexpl.from"): \logo{mylogo} - Name der eps/pdf-Datei Ihres Lehrstuhl-Logos \chair{Lehrstuhlleiter} - Name des Lehrstuhl-Leiters \street{Anschrift} - Gebäude-Adresse des Absenders \secr{Telefonnr.} - Telefonnummer des Sekretariats \www{URL} - URL vdes Absenders; `http://' muss hier nicht angegeben werden \foot{Text} - Freitext für die Fußzeile der ersten Seite; der Text wird zentriert ausgegeben Wenn Sie eine dieser Angaben vergessen, erhalten Sie eine entsprechende LaTeX-Fehlermeldung immer dann, wenn Sie in der "\documentclass[..]{UBTlettr}"-Zeile die entsprechende Option benutzen! Die folgenden Namen sind optional. Wenn Sie sie weglassen, bleiben die entsprechenden Felder einfach leer (siehe auch Beispieldatei "addrexpl.from"): \backaddress{Adresse} - Rückadresse des Absenders; DARF nur eine Zeile sein! \place{Stadt,} - diese Angabe wird direkt vors Datum gesetzt Zur besseren Internationalisierung sollten Sie folgendes Paket verwenden: \usepackage{ngerman} Dadurch können Sie mithilfe des Befehls \selectlanguage{english} eine andere Sprache auswählen. Dies setzt dann die Beschriftung bestimmter sprachabhängiger Felder, wie z.B. "Telefon" oder "phone" usw. Die Namen sind in "UBTlettr.cls" vordefiniert, und können in "UBTlettr.cfg" angepasst werden. Momentan sind sie dort nur für Englisch und Deutsch angepasst, Sie können diese Datei aber jederzeit ändern. Formatierungsangaben -------------------- Prinzipiell sollten im Briefdokument keine Formatierungsangaben auftauchen. Manchmal müssen Sie jedoch den linken und oberen Rand an Ihren Drucker anpassen: \oddsidemargin -6mm \evensidemargin -6mm \topmargin -22mm Der Absenderblock lässt sehr viele Einträge zu, von denen Sie wahrscheinlich nicht alle benutzen werden. Bei sehr langen und sehr kurzen Blöcken kann der Abstand zwischen diesem Block und dem eigentlichen Inhalt des Briefes sehr befremdlich wirken. Sie können den Abstand zum Brief-Körper einschließlich des Datums an Ihren Absenderblock anpassen: \refvskip 20.0mm Benutzen Sie diese Formatierungsmöglichkeiten nur wenn UNBEDINGT nötig!! Der eigentliche Brief --------------------- Nach dem \begin{document} beginnt Ihr Brief mit einem \beginn{letter}{Empfängeradresse} Hierbei können Sie die Zeilenumbrüche der Empfänger-Adresse durch "\\" selbst bestimmen (siehe auch Beispieldatei "addrexpl.from"). Die Empfänger-Adresse wird dann ins Empfänger-Adressfeld unter die Rückantwort-Adresse gesetzt. Deshalb sollte die Empfänger-Adresse nicht länger als 7 Zeilen sein. Durch \subject{Freier Subject-Text} können Sie eine Betreff-Zeile definieren. Das Wort "Betr.: " oder "Subject: " wird normalerweise nicht geschrieben. Möchten Sie es dennoch setzen, so erreichen Sie das durch´den Befehl \subjecton Ihr Brieftext wird durch \opening{Anrede} eröffnet. Hier stehen Ihnen folgende Abkürzungen zur Verfügung: \sgdh - Sehr geehrte Damen und Herren \sgf - Sehr geehrte Frau \sgh - Sehr geehrter Herr \twimc - To Whom it May Concern Nun folgt Ihr Brieftext, in dem Sie ganz normal alle LaTeX-Befehle nutzen können. Ihr Brieftext wird durch \closing{Grüße} geschlossen. Hier stehen Ihnen folgende Abkürzungen zur Verfügung: \mfg - Mit freundlichen Grüßen \ys - Yours sincerely \sy - Sincerely yours \yf - Yours faithfully Ihnen stehen nun noch die Befehle \encl{Anlagenliste, durch "\\" getrennt} \cc{cc-Empfänger, durch "\\" getrennt} zur Verfügung. Ihr Brief wird durch \end{letter} beendet. Im Prinzip können Sie nun anschließend mit \begin{letter}{..} etc., wie oben beschrieben gleich einen weiteren Brief beginnen. Dieser wird dann auf einer ungeraden Seite beginnend gedruckt. Das Dokument wird ganz normal durch \end{document} beendet. Ich wünsche Ihnen viel Spaß und Erfolg