diff options
author | Karl Berry <karl@freefriends.org> | 2011-12-07 23:04:48 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2011-12-07 23:04:48 +0000 |
commit | 57454c1063f05cf70a05fd9454ace7468aebae49 (patch) | |
tree | 9237b792c4a39171a6d2cbec52a674d4ec1f981e /Master/texmf-dist/doc/latex/iwhdp/iwhdp_Manual.tex | |
parent | 4085bbffdfcdcc8b62641a7168623a9246816c9e (diff) |
iwhdp (7dec11)
git-svn-id: svn://tug.org/texlive/trunk@24790 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/iwhdp/iwhdp_Manual.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/iwhdp/iwhdp_Manual.tex | 369 |
1 files changed, 369 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/iwhdp/iwhdp_Manual.tex b/Master/texmf-dist/doc/latex/iwhdp/iwhdp_Manual.tex new file mode 100644 index 00000000000..a09c52d7b81 --- /dev/null +++ b/Master/texmf-dist/doc/latex/iwhdp/iwhdp_Manual.tex @@ -0,0 +1,369 @@ +%=====================================================% +% IWH DISKUSSIONSPAPIER README % +% Wilfried Ehrenfeld % +%=====================================================% +\documentclass[german, biber]{iwhdp} +\bibliography{iwhdp_Manual} +\begin{document} +%-----------------------------------------------------% +\title{IWH-Diskussionspapiere - Benutzeranweisung für die \LaTeX-Dokumentenklasse \texttt{iwhdp}} +\titlealt{IWH Discussion Papers - The \texttt{iwhdp} User Guide} +% +\author{Wilfried Ehrenfeld} +\department{Abteilung Strukturökonomik} +\tel{+49\,(0)\,345 7753-832} +\email{wilfried.ehrenfeld@iwh-halle.de} +% +\dpnumber{\TeX{} \iwhdpversion} +% +\dpabstract{Dieses Manual beschreibt die \LaTeX-Vorlage für IWH-Diskussionspapiere.} +\dpabstractalt{This manual outlines the \LaTeX{} template for IWH discussion papers.} +% +\keywords{IWH, \LaTeX, Vorlage, iwhdp} +\keywordsalt{IWH, \LaTeX, template, iwhdp} +% +\jel{Z0} +%-----------------------------------------------------% +\makeiwhtitle +%-----------------------------------------------------% +\section{Benutzung der Vorlage} +% +\subsection{Grundsätzliches} +Für Diskussionspapiere des IWH wurde die Dokumentenklasse \texttt{iwhdp} geschaffen, +die jedem Mitarbeiter am IWH frei zur Verfügung steht. +Die aktuelle Version kann von \url{http://www.iwh-halle.de/e/Abteil/STWA/wed/pers.htm} bezogen werden.% +\footnote{Die jeweils letzte "`größere"' Release steht auf dem CTAN zur Verfügung:\\ + \url{http://www.ctan.org/tex-archive/macros/latex/contrib/iwhdp}.} +Von der Verwendung alter Versionen wird ausdrücklich abgeraten. + +Die Klasse wird mit +\verb+\documentclass[+\emph{optionale Parameter}\verb+]{iwhdp}+ +aufgerufen. +Dazu muss die Datei \texttt{iwhdp.cls} im Arbeitsverzeichnis liegen. +Die Dokumentenklasse besitzt optionale Parameter für +die Sprache des Papiers sowie für den Umgang mit dem Literaturverzeichnis. + + +\subsection{Optionale Parameter} +% +Optionale Parameter für die \textit{Sprache} des Papiers sind: +% +\begin{itemize} +\item \emph{german} für deutsche Diskussionspapiere +\item \emph{english} für englische Diskussionspapiere +\end{itemize} +Die Standardeinstellung (keine optionalen Parameter) ist \emph{german}. + + +Optionale Parameter für die \textit{Literaturverwaltung} sind: +% +\begin{itemize} +\item \emph{harvard} stellt Zitierbefehle zur Verfügung, welche zum \texttt{harvard}-Paket kompatibel sind (\emph{Beta-Version}). +\item \emph{nobib} schaltet die automatische Literaturverwaltung ganz aus. +Statt dessen wird die Hilfs-Umgebung \texttt{iwh\_ref} zur Verfügung gestellt.\\ +Diese kann wie folgt benutzt werden:\\ +\verb+\makebib% 'Literatur' bzw. 'References' ausgeben+\\ +\verb+\begin{iwh_ref}% Umgebung für Literatur initialisieren+\\ +\verb+\item+ \emph{...eine Quellenangabe}\\ +\verb+\end{iwh_ref}% Umgebung beenden+\\ +\end{itemize} + +Weiter gibt es die Option \textit{biber} welche das intern verwendete Backend für die Literaturverwaltung von BibTeX bzw. BibTeX8 auf biber umschaltet. + +Für die Vorbereitung von Diskussionspapieren zu Konferenz-Einreichungen wurde die \emph{conference} Option implementiert. +% requested by Phillip - 2011-05-19 + 2011-12-06 +Wird diese gesetzt, so werden die IWH-typischen Bestandteile des Diskussionspapiers nicht ausgegeben. +Diese sind: Datum und Nummer auf der Titelseite, Disclaimer auf der zweiten Seite, die dritte Seite in Alternativsprache sowie die IWH-spezifischen Kopf- und Fußzeile im Text. + +Schließlich gibt es die Option \textit{issn} die dafür sorgt, dass auf der zweiten Seite die ISSN-Nummer für IWH-Diskussionspapiere ausgibt. +Diese wird für die Druckfassung des Papiers benötigt, nicht aber für die im Internet veröffentlichte pdf-Version. +Um der Abteilung Öffentlichkeitsarbeit einen Gefallen zu tun wäre es wünschenswert zwei Versionen des Papiers abzugeben: +Eine Version mit ISSN, eine ohne. + + + + +\section{Typischer Aufbau eines Dokumentes} +% +Die folgenden Erläuterungen erfolgen anhand der Vorlagedatei \texttt{iwhdp\_paper.tex}. +Die Benutzung dieser Vorlage als Grundlage für eigene Diskussionspapier wird empfohlen.\\ +Das Dokument beginnt mit der Deklarartion der Klasse: + +\verb+\documentclass[german]{iwhdp}+ + +Dies wird also ein deutsches Diskussionspapier. +Danach folgt die Angabe der Literaturdatenbank: + +\verb+\bibliography{iwhdp_paper.bib}+ + +Die Literaturdatenbank hat also den Namen \texttt{iwhdp\_paper.bib} und steht im Projektverzeichnis, also im selben Verzeichnis wie \texttt{iwhdp\_paper.tex}. + +Das Dokument wird nun mit +\verb+\begin{document}+ +initialisiert. + +Nun folgen die bibliographischen Angaben für den/die Autoren: + +\verb|\author{Wilfried Ehrenfeld}|\\ +\verb|\department{Abteilung Strukturökonomik}|\\ +\verb|\tel{+49\,(0)\,345 7753-832}|\\ +\verb|\email{wilfried.ehrenfeld@iwh-halle.de}| + +Die Öffentlichkeitsarbeit bittet, auf das Format der Telefonnummer zu achten. + +Die Parameter für den (ersten) Koautor heißen analog:\\% +\texttt{cauthor, cdepartment, ctel und cemail}.\\ +Für den zweiten Koautor:\\% +\texttt{ccauthor, ccdepartment, cctel und ccemail}.\\ +Und schließlich für den dritten Koautor:\\% +\texttt{cccauthor, cccdepartment, ccctel und cccemail}.\\ +Insgesamt können also vier Autoren erfasst werden. + +Sämtliche Angaben für die Autoren sind bis auf den Namen des ersten Autoren \emph{optional}. +Falls sie nicht benötigt werden, können Sie aus dem Papier-Quelltext entfernt werden. +Alternativ dazu besteht die Möglichkeit, die Angaben für einen Koautor blockweise komplett stillzulegen. +Dazu trägt man für den Namen des Koautors (\texttt{cauthor, ccauthor, cccauthor}) einfach \texttt{NN} ein. + +Als nächstes besteht die Möglichkeit den Publikationsmonat des Papiers anzugeben. +Dies ist aber nur dann nötig, falls dieser vom aktuellen Monat abweicht. +Dazu trägt man das gewünschte Datum im Zahlenformat +\verb|\dpdate{|\emph{Monat}\verb|}{|\emph{Jahr}\verb|}| ein. +\verb|\dpdate{03}{2010}| bezeichnet also den März 2010. + +Die Nummer des Diskussionspapier wird mit \verb|\dpnumber{|\emph{Nummer}\verb|}| angegeben. +Diese Nummer wird nach erfolgter Zuteilung durch Fr. Dede hier eingetragen. + +IWH-Diskussionspapiere werden prinzipiell entweder in Deutsch oder in Englisch geschrieben. +Ein Merkmal der Diskussionspapiere ist die Existenz einer doppelten dritten Seite. +Dies führt dazu, dass Angaben wie Zusammenfassungen, Stichwörter und Titelfußnoten jeweils +in der Sprache des Papiers (hier: deutsch) angegeben werden müssen und zusätzlich in der +\emph{Alternativsprache} (hier also englisch). + +Deshalb folgen nun die Zusammenfassung und der Abstract des Papiers +zuerst in der Sprache des Papiers: +\verb|\dpabstract{|\emph{Text der Zusammenfassung}\verb|}|, +danach in der Alternativsprache: +\verb|\dpabstractalt{|\emph{Text des Abstracts}\verb|}|. +Bei einem deutschen Text ist also \texttt{dpabstract} in Deutsch zu verfassen +und \texttt{dpabstractalt} in Englisch - und umgekehrt. + +Analog hierzu werden die Schlagwörter mit \verb|\keywords{|\emph{Schlagwörter}\verb|}| in der Sprache des Papers angegeben. +Die einzelnen Schlagwörter sind mit je einem Komma zu trennen. +In der Alternativsprache werden diese mit \verb|\keywordsalt{|\emph{Keywords}\verb|}| angegeben. + +Die JEL-Klassifikation wird mit \verb|\jel{|\emph{Klasse}\verb|}| eingetragen. +Mehrere Klassen sollten mit je einem Komma getrennt werden. + +Als letzte bibliographische Daten können nun noch die Titelfußnoten angelegt werden. +Anwendungsbeispiele sind Hinweise (Drittmittelförderung) oder Danksagungen. +In der Sprache des Papiers werden diese mit \verb|\thanks{|\emph{Dankeschön!}\verb|}| verfasst, +in der Alternativsprache mit \verb|\thanksalt{|\emph{Thanks!}\verb|}|. + +Der IWH-spezifische Vorspann wird nun mit +\verb+\makeiwhtitle+ +ausgegeben. +Zum Entwickeln der Papiere kann man diesen Befehl gut mit einem "`\texttt{\%}"' vor diesem Befehl auskommentieren. + +Nun folgt der Text des Diskussionspapiers, beispielsweise beginnend mit\\ +\verb+\section{Einführung}+. + +Das Papier endet mit dem Literaturverzeichnis. +Dazu kann mit +\verb+\clearpage+ +eine neue Seite begonnen werden. +Das Literaturverzeichnis wird mit +\verb+\makebib+ +ausgegeben. +Das Dokument endet mit +\verb+\end{document}+. + +Der Aufbau eines typisches Diskussionspapiers sieht dann ungefähr so aus: + +% +%% +%%% +\newpage +{\small \setstretch{1.05} +\begin{verbatim} +%=====================================================% +% IWH DISKUSSIONSPAPIER % +% Vorlage: Wilfried Ehrenfeld (2011-07) % +%=====================================================% +\documentclass[german, biber]{iwhdp} +\bibliography{iwhdp_paper.bib} +\begin{document} +%-----------------------------------------------------% +\title{Die \LaTeX-Vorlage für IWH-Diskussionspapiere} +\titlealt{The \LaTeX{} template for IWH discussion papers} +% +\author{Wilfried Ehrenfeld} +\department{Abteilung Strukturökonomik} +\tel{+49\,(0)\,345 7753-832} +\email{wilfried.ehrenfeld@iwh-halle.de} +% +%\cauthor{} +%\cdepartment{} +%\ctel{} +%\cemail{} +% +%\dpdate{05}{1984}% {Monat}{Jahr} - Nur nötig, wenn abeichend. +%\dpnumber{1}% Nach Zuteilung aktivieren und eintragen. +% +\dpabstract{Dies ist die \LaTeX-Vorlage für IWH-Diskussionspapiere.} +\dpabstractalt{This is the \LaTeX{} template for IWH discussion papers.} +% +\keywords{IWH, \LaTeX, Vorlage, iwhdp} +\keywordsalt{IWH, \LaTeX, template, iwhdp} +% +\jel{Z0} +% +%\thanks{Danke.} +%\thanksalt{Thanks.} +%-----------------------------------------------------% +\makeiwhtitle +%-----------------------------------------------------% +\section{Einführung} +Im Anfang schuf Gott Himmel und Erde. +%-----------------------------------------------------% +\clearpage \makebib +\end{document} +% EOF iwhdp_paper.tex +\end{verbatim} +}%Gruppe +\newpage +%%% +%% +% + +\section{Zitierstil} +% +Die Vorlage benutzt für die Erstellung von Zitaten das \texttt{biblatex}-Paket% +\footnote{\url{http://www.ctan.org/tex-archive/macros/latex/exptl/biblatex/}.} +Die Zitierbefehle richten sich folglich nach diesem. + +Für die beiden häufigsten Zitierweisen wurden Kurzformen geschaffen:\\ +\verb|\zit{demmig2004}{13ff.}| $\rightarrow$ \zit{demmig2004}{13ff.}\\ +und\\ +\verb|\tzit{demmig2004}{13ff.}| $\rightarrow$ \tzit{demmig2004}{13ff.} + +Die danach gebräuchlichsten Zitierbefehle sind \texttt{parencite} und \texttt{textcite}, +bzw. deren Kurzformen \texttt{pcite} und \texttt{tcite}:\\ +\verb+\parencite{demmig2004}+ $\rightarrow$ \parencite{demmig2004}\\ +\verb+\parencite[13ff.]{demmig2004}+ $\rightarrow$ \parencite[13ff.]{demmig2004}\\ +\verb+\parencite[siehe][]{demmig2004}+ $\rightarrow$ \parencite[siehe][]{demmig2004}\\ +\verb+\parencite[siehe][13ff.]{demmig2004}+ $\rightarrow$ \parencite[siehe][13ff.]{demmig2004}\\ +und\\ +\verb+\textcite{demmig2004}+ $\rightarrow$ \textcite{demmig2004}.\\ +\verb+\textcite[13ff.]{demmig2004}+ $\rightarrow$ \textcite[13ff.]{demmig2004}.\\ +\verb+\textcite[siehe][]{demmig2004}+ $\rightarrow$ \textcite[siehe][]{demmig2004}.\\ +\verb+\textcite[siehe][13ff.]{demmig2004}+ $\rightarrow$ \textcite[siehe][13ff.]{demmig2004}. + +Daneben existieren eine Reihe weiterer Zitierbefehle:\\ +\verb+\cite{demmig2004}+ $\rightarrow$ \cite{demmig2004}\\ +\verb+\cite[13ff.]{demmig2004}+ $\rightarrow$ \cite[13ff.]{demmig2004}\\ +\verb+\cite[siehe][13ff.]{demmig2004}+ $\rightarrow$ \cite[siehe][13ff.]{demmig2004} + +\verb+\cite*{demmig2004}+ $\rightarrow$ \cite*{demmig2004}\\ +\verb+\cite*[13ff.]{demmig2004}+ $\rightarrow$ \cite*[13ff.]{demmig2004} + +\verb+\parencite*[13ff.]{demmig2004}+ $\rightarrow$ \parencite*[13ff.]{demmig2004} + +\verb+\parencites[13ff.]{demmig2004}[sowie][123]{schlager2005}+ $\rightarrow$\\ \parencites[13ff.]{demmig2004}[sowie][123]{schlager2005} + +\verb+\footcite[siehe][13ff.]{demmig2004}+ $\rightarrow$ \footcite[siehe][13ff.]{demmig2004} + +Auch einzelne Felder können angesprochen werden:\\ +\verb+\citeauthor{demmig2004}+ $\rightarrow$ \citeauthor{demmig2004}\\ +\verb+\citetitle{demmig2004}+ $\rightarrow$ \citetitle{demmig2004}\\ +\verb+\citeyear{demmig2004}+ $\rightarrow$ \citeyear{demmig2004}\\ +\verb+\citeurl{demmig2004}+ $\rightarrow$ \citeurl{demmig2004}\\ +\verb+\citetype{demmig2004}+ $\rightarrow$ Das \texttt{type}-Feld des Eintrages. + + +\section{Tips für die Literaturdatenbank} +% +Die Datenbank sollte im Encoding \emph{ISO8859-15} vorliegen. +Diese Kodierung entspricht in etwa \texttt{latin9} bzw. \texttt{ansinew} unter \LaTeX. +Unter \texttt{JabRef} stellt man dies unter \texttt{Optionen / Einstellungen / Standard-Zeichenkodierung} ein. +Mit der Kodierung \texttt{CP1252} gab es bereits Probleme. +Bei dieser Gelegenheit sollte man auch bei "`Neue Einträge mit Datum versehen. Datumsformat:"' +\texttt{yyyy-MM-dd} eintragen. +So kann man später diesen "`timestamp"' in andere Datumsfelder (z.\,B. \texttt{urldate}) übernehmen. +Datumsangaben müssen in der sog. ISO-8602-Notierung (JJJJ-MM-TT) vorliegen. +Ein Beispiel: Das Datum, an dem eine Internetquelle abgerufen wurde (\texttt{urldate}) ist: +2010-02-16 für den 16. Februar 2010. + +Das Eingabeformat für Autoren ist: "`\emph{Vorname Nachname}"'. +Verschiedene Autoren werden mit \texttt{and} getrennt. +Für weitere Autoren z.\,B. "`u.a."' schreibt man \texttt{and others}. +den Namen von Institutionen schreibt man am besten in geschweifte Klammern, +so wird die automatische Erkennung von Vornamen und Nachnamen ausgeschaltet und der Name nicht getrennt. +Nicht nötig ist es, den ersten Buchstaben von Autoren oder Titeln in geschweifte Klammern zu schreiben. + +Artikel, Bücher, und Beiträge aus Sammelbänden werden (wie gewohnt) als +\texttt{article}, \texttt{book} und \texttt{inbook} eingetragen. +Die Felder \texttt{url} und \texttt{urldate} können verwendet werden. +Der Ort des Verlages heisst "`\texttt{location}"'. + +Diskussionspapiere und ähnliche Dokumente sollten als \texttt{report} eingetragen werden. +Die Felder \texttt{author}, \texttt{title} und \texttt{year} sind obligatorisch. +Vermerke wie "`IWH Diskussionspapier 04/2010"' werden als \texttt{type} eingetragen. +Die Felder \texttt{url} und \texttt{urldate} können verwendet werden. + +Quellen aus dem Internet, welche keiner anderen Dokumentenklasse zugeordnet werden können, +werden als \texttt{electronic} eingetragen. +Die Felder \texttt{url} und \texttt{urldate} gelten hierbei als Mindestanforderungen. + +\texttt{JabRef} bietet die Möglichkeit, zu jeder Quelle in der Datenbank einen \emph{Review} anzulegen. +Die können Textstellen und Bemerkungen eingetragen werden. +Später kann die Datenbank mit der Volltextsuche nach Begriffen durchsucht werden. +Den \texttt{abstract} einer Quelle sollte man nicht hier, sondern in das Feld \texttt{Abstract} eingeben bzw. kopieren. + + + +%\section{Hinweis zur "`doppelten zweiten Seite"'} +%% +%Die zweite Seite des IWH-Vorspanns wird zwei Mal ausgegeben - einmal mit ISSN und einmal ohne ISSN. +%Beide Male trägt sie auch die Seitennummer \emph{2}. +%Dies ist eine Vorgabe von Frau Dede, die anschließend hieraus zum einen +%die Online-Version und zum anderen eine Kopiervorlage erstellt. +% +%Hiermit hängt auch die Warnung\\ +%\verb+pdfTeX warning (ext4):+\newline \verb+destination with the same identifier (name{page.2})+\\ +%zusammen. Diese kann ignoriert werden. + + + +\section{Literaturhinweise für Anfänger} +% +Wer kein Geld für Bücher ausgeben will, dem seien die einführenden Skripte "`\citetitle{Hagen1}"' und "`\citetitle{Hagen2}"' der FernUni Hagen ans Herz gelegt \parencites{Hagen1}{Hagen2}. + +Gute einführende Bücher zum Thema \LaTeX{} sind z.\,B. "`\citetitle{schlager2005}"' \parencite{schlager2005} und "`\citetitle{demmig2004}"' \parencite{demmig2004}. + +Weitere (\TeX nische) Informationen über die hier verwendete vorgestellte Dokumentenklasse \texttt{iwhdp} finden sich in +\tcite{Ehrenfeld2010LaTeX} und \tcite{Ehrenfeld2011iwhdp}. + + +\section{\TeX nische Hinweise - häufige Nachfragen} +% +\emph{Wie kann die (einzeilige) Tabellen- bzw. Abbildungsüberschrift zentriert werden?}\\ +Dazu dient der Befehl:\\ +\verb+\KOMAoption{captions}{nooneline}% oneline: zentriert. nooneline: links+\\ +\verb+oneline+ zentriert die einzeilige Überschrift. +\verb+nooneline+ setzt sie wie mehrzeilige - also linksbündig. +Der Parameter sollte vor \verb+\begin{document}+ gesetzt werden. + +\emph{Wie können die Absatzzwischenräume geändert werden?}\\ +Erste Antwort: \textit{Die Absatzzwischenräume sollten gar nicht verändert werden!}\\ +Zweite Antwort: Dazu dient der Befehl: +\verb+\setlength{\parskip}+, beispielsweise\\ +\verb+\setlength{\parskip}{8pt plus0pt minus2pt}+. +\verb+parkip+ ist ein sog. elastisches Maß: +Das \verb+plus+ gibt an, um wieviel der Parameter notfalls gedehnt werden kann - +\verb+minus+ gibt an, um wieviel der Parameter gestaucht werden darf. +Der Parameter sollte nach \verb+\makeiwhtitle+ gesetzt werden.\\ +\emph{\textbf{!} Es wird ausdrücklich davor gewarnt, diesen Parameter zu verändern \textbf{!}} + +\makebib +\end{document} +% EOF Anleitung.tex
\ No newline at end of file |