diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/classicthesis/Chapters/Chapter01.tex')
| -rw-r--r-- | Master/texmf-dist/doc/latex/classicthesis/Chapters/Chapter01.tex | 294 |
1 files changed, 146 insertions, 148 deletions
diff --git a/Master/texmf-dist/doc/latex/classicthesis/Chapters/Chapter01.tex b/Master/texmf-dist/doc/latex/classicthesis/Chapters/Chapter01.tex index 1b1765ed6b6..a473fdb330f 100644 --- a/Master/texmf-dist/doc/latex/classicthesis/Chapters/Chapter01.tex +++ b/Master/texmf-dist/doc/latex/classicthesis/Chapters/Chapter01.tex @@ -27,7 +27,7 @@ This works now also with ``plain'' \LaTeX. As of version 3.0, \texttt{classicthesis} can also be easily used with \mLyX\footnote{\url{http://www.lyx.org}} thanks to Nicholas Mariette -and Ivo Pletikosi\'c. The \mLyX\ version of this manual will contain +and Ivo Pletikosić. The \mLyX\ version of this manual will contain more information on the details. This should enable anyone with a basic knowledge of \LaTeXe\ or \mLyX\ to @@ -36,12 +36,12 @@ is my overall goal: more beautiful documents, especially theses, as I am tired of seeing so many ugly ones. The whole template and the used style is released under the -\textsmaller{GNU} General Public License. +\acsfont{GNU} General Public License. If you like the style then I would appreciate a postcard: \begin{center} - André Miede \\ - Detmolder Straße 32 \\ + André Miede \\ + Detmolder Straße 32 \\ 31737 Rinteln \\ Germany \end{center} @@ -68,8 +68,8 @@ especially these: information to be on a page. And, no: the lines are not too short. \item The tables intentionally do not use vertical or double rules. See the documentation for the \texttt{booktabs} package for - a nice discussion of this topic.\footnote{To be found online at \\ - \url{http://www.ctan.org/tex-archive/macros/latex/contrib/booktabs/}.} + a nice discussion of this topic.\footnote{To be found online at + \url{http://mirror.ctan.org/macros/latex/contrib/booktabs/}.} \item And last but not least, to provide the reader with a way easier access to page numbers in the table of contents, the page numbers are right behind the titles. Yes, they are \emph{not} @@ -82,6 +82,28 @@ especially these: Therefore, please do not break the beauty of the style by changing these things unless you really know what you are doing! Please. +\paragraph{Yet Another Important Note:} Since \texttt{classicthesis}' +first release in 2006, many things have changed in the \LaTeX\ world. +Trying to keep up-to-date, \texttt{classicthesis} grew and evolved +into many directions, trying to stay (some kind of) stable and be +compatible with its port to \mLyX. However, there are still many +remains from older times in the code, many dirty workarounds here and +there, and several other things I am absolutely not proud of (for +example my unwise combination of \acsfont{KOMA} and +\texttt{titlesec} etc.). +\graffito{An outlook into the future of \texttt{classicthesis}.} + +Currently, I am looking into how to completely re-design and +re-implement \texttt{classicthesis} making it easier to maintain and +to use. As a general idea, \texttt{classicthesis.sty} should be +developed and distributed separately from the template bundle itself. +Excellent spin-offs such as \texttt{arsclassica} could also be +integrated (with permission by their authors) as format configurations. +Also, current trends of \texttt{microtype}, \texttt{fontspec}, etc. +should be included as well. As I am not really into deep +\LaTeX\ programming, +I will reach out to the \LaTeX\ community for their expertise and help. + \section{Organization} A very important factor for successful thesis writing is the @@ -112,9 +134,9 @@ the following: \item\texttt{ClassicThesis.tex}: the main file of your thesis where all gets bundled together. \item\texttt{classicthesis-config.tex}: a central place to load all - nifty packages that are used. In there, you can also activate - backrefs in order to have information in the bibliography about - where a source was cited in the text (\ie, the page number). + nifty packages that are used. %In there, you can also activate + %backrefs in order to have information in the bibliography about + %where a source was cited in the text (\ie, the page number). \emph{Make your changes and adjustments here.} This means that you specify here the options you want to load \texttt{classicthesis.sty} @@ -122,104 +144,106 @@ the following: similar information here. Refer to \autoref{sec:custom} for more information. - This had to change as of version 3.0 in order to enable an easy - transition from the ``basic'' style to \mLyX. + This had to change as of version 3.0 in order to enable an easy + transition from the ``basic'' style to \mLyX. \end{itemize} In total, this should get you started in no time. +\clearpage \section{Style Options}\label{sec:options} There are a couple of options for \texttt{classicthesis.sty} that allow for a bit of freedom concerning the layout: \marginpar{\dots or your supervisor might use the margins for some comments of her own while reading.} \begin{itemize} - \item General: - \begin{itemize} - \item\texttt{drafting}: prints the date and time at the bottom of + \item General: + \begin{itemize} + \item\texttt{drafting}: prints the date and time at the bottom of each page, so you always know which version you are dealing with. Might come in handy not to give your Prof. that old draft. - \end{itemize} - - \item Parts and Chapters: - \begin{itemize} - \item\texttt{parts}: if you use Part divisions for your document, + \end{itemize} + + \item Parts and Chapters: + \begin{itemize} + \item\texttt{parts}: if you use Part divisions for your document, you should choose this option. (Cannot be used together with \texttt{nochapters}.) - \item\texttt{nochapters}: allows to use the look-and-feel with + \item\texttt{nochapters}: allows to use the look-and-feel with classes that do not use chapters, \eg, for articles. Automatically turns off a couple of other options: \texttt{eulerchapternumbers}, \texttt{linedheaders}, \texttt{listsseparated}, and \texttt{parts}. - \item\texttt{linedheaders}: changes the look of the chapter - headings a bit by adding a horizontal line above the chapter - title. The chapter number will also be moved to the top of the - page, above the chapter title. + \item\texttt{linedheaders}: changes the look of the chapter + headings a bit by adding a horizontal line above the chapter + title. The chapter number will also be moved to the top of the + page, above the chapter title. - \end{itemize} + \end{itemize} \item Typography: - \begin{itemize} - \item\texttt{eulerchapternumbers}: use figures from Hermann Zapf's - Euler math font for the chapter numbers. By default, old style - figures from the Palatino font are used. + \begin{itemize} + \item\texttt{eulerchapternumbers}: use figures from Hermann Zapf's + Euler math font for the chapter numbers. By default, old style + figures from the Palatino font are used. - \item\texttt{beramono}: loads Bera Mono as typewriter font. - (Default setting is using the standard CM typewriter font.) - \item\texttt{eulermath}: loads the awesome Euler fonts for math. - (Palatino is used as default font.) + \item\texttt{beramono}: loads Bera Mono as typewriter font. + (Default setting is using the standard CM typewriter font.) + + \item\texttt{eulermath}: loads the awesome Euler fonts for math. + Pala\-tino is used as default font. - \item\texttt{pdfspacing}: makes use of pdftex' letter spacing - capabilities via the \texttt{microtype} package.\footnote{Use - \texttt{microtype}'s \texttt{DVIoutput} option to generate - DVI with pdftex.} This fixes some serious issues regarding - math formul\ae\ etc. (\eg, ``\ss'') in headers. - - \item\texttt{minionprospacing}: uses the internal \texttt{textssc} - command of the \texttt{MinionPro} package for letter spacing. This - automatically enables the \texttt{minionpro} option and overrides - the \texttt{pdfspacing} option. + \item\texttt{pdfspacing}: makes use of pdftex' letter spacing + capabilities via the \texttt{microtype} package.\footnote{Use + \texttt{microtype}'s \texttt{DVIoutput} option to generate + DVI with pdftex.} This fixes some serious issues regarding + math formul\ae\ etc. (\eg, ``\ss'') in headers. + + \item\texttt{minionprospacing}: uses the internal \texttt{textssc} + command of the \texttt{MinionPro} package for letter spacing. This + automatically enables the \texttt{minionpro} option, overriding + \texttt{pdfspacing}. - \end{itemize} - - \item Table of Contents: - \begin{itemize} - \item\texttt{tocaligned}: aligns the whole table of contents on - the left side. Some people like that, some don't. - - \item\texttt{dottedtoc}: sets pagenumbers flushed right in the - table of contents. - - \item\texttt{manychapters}: if you need more than nine chapters for - your document, you might not be happy with the spacing between the - chapter number and the chapter title in the Table of Contents. - This option allows for additional space in this context. - However, it does not look as ``perfect'' if you use - \verb|\parts| for structuring your document. - - \end{itemize} + \end{itemize} + + \item Table of Contents: + \begin{itemize} + \item\texttt{tocaligned}: aligns the whole table of contents on + the left side. Some people like that, some don't. + + \item\texttt{dottedtoc}: sets pagenumbers flushed right in the + table of contents. + + \item\texttt{manychapters}: if you need more than nine chapters for + your document, you might not be happy with the spacing between the + chapter number and the chapter title in the Table of Contents. + This option allows for additional space in this context. + However, it does not look as ``perfect'' if you use + \verb|\parts| for structuring your document. + + \end{itemize} - \item Floats: - \begin{itemize} + \item Floats: + \begin{itemize} \item\texttt{listings}: loads the \texttt{listings} package (if not already done) and configures the List of Listings accordingly. \item\texttt{floatperchapter}: activates numbering per chapter for - all floats such as figures, tables, and listings (if used). + all floats such as figures, tables, and listings (if used). - \item\texttt{subfig}(\texttt{ure}): is passed to the \texttt{tocloft} - package to enable compatibility with the \texttt{subfig}(\texttt{ure}) - package. Use this option if you want use classicthesis with the - \texttt{subfig} package. - + \item\texttt{subfig}(\texttt{ure}): is passed to the \texttt{tocloft} + package to enable compatibility with the \texttt{subfig}(\texttt{ure}) + package. Use this option if you want use \texttt{classicthesis} with the + \texttt{subfig} package. + % \item\texttt{listsseparated}: will add extra space between table % and figure entries of different chapters in the list of tables or % figures, respectively. % Deprecated as of version 2.9. - \end{itemize} + \end{itemize} -% \item\texttt{a5paper}: adjusts the page layout according to the +% \item\texttt{a5paper}: adjusts the page layout according to the % global \texttt{a5paper} option (\emph{experimental} feature). % \item\texttt{minionpro}: sets Robert Slimbach's Minion as the % main font of the document. The textblock size is adjusted @@ -227,17 +251,16 @@ allow for a bit of freedom concerning the layout: \end{itemize} The best way to figure these options out is to try the different -possibilities and see, what you and your supervisor like best. +possibilities and see what you and your supervisor like best. -In order to make things easier in general, -\texttt{classicthesis-config.tex} +In order to make things easier, \texttt{classicthesis-config.tex} contains some useful commands that might help you. \section{Customization}\label{sec:custom} %(As of v3.0, the Classic Thesis Style for \LaTeX{} and \mLyX{} share %the same two \texttt{.sty} files.) -This section will give you some hints about how to adapt +This section will show you some hints how to adapt \texttt{classicthesis} to your needs. The file \texttt{classicthesis.sty} @@ -251,30 +274,20 @@ the data in the following lines of \texttt{classicthesis-config.tex:}% \marginpar{Modifications in \texttt{classic\-thesis-config.tex}% } -\begin{lstlisting}[frame=lt] -% ************************************************** -% 2. Personal data and user ad-hoc commands -% ************************************************** -\newcommand{\myTitle}{A Classic Thesis Style\xspace} -\newcommand{\mySubtitle}{An Homage to...\xspace} +\begin{lstlisting} + % ************************************************** + % 2. Personal data and user ad-hoc commands + % ************************************************** + \newcommand{\myTitle}{A Classic Thesis Style\xspace} + \newcommand{\mySubtitle}{An Homage to...\xspace} \end{lstlisting} Further customization can be made in \texttt{classicthesis-config.tex} by choosing the options to \texttt{classicthesis.sty} (see~\autoref{sec:options}) in a line that looks like this: -\begin{lstlisting}[frame=lt] -\PassOptionsToPackage{eulerchapternumbers,drafting,listings,subfig,eulermath,parts}{classicthesis} -\end{lstlisting} - -If you want to use backreferences from your citations to the pages -they were cited on, change the following line from: -\begin{lstlisting}[breaklines=false,frame=lt] -\setboolean{enable-backrefs}{false} % true false -\end{lstlisting} -to -\begin{lstlisting}[breaklines=false,frame=lt] -\setboolean{enable-backrefs}{true} % true false +\begin{lstlisting} + \PassOptionsToPackage{eulerchapternumbers,drafting,listings,subfig,eulermath,parts}{classicthesis} \end{lstlisting} Many other customizations in \texttt{classicthesis-config.tex} are @@ -292,60 +305,47 @@ to get longer lines of text. This section will list some information about problems using \texttt{classic\-thesis} in general or using it with other packages. -Beta versions of \texttt{classicthesis} can be found at the following -Google code repository: +Beta versions of \texttt{classicthesis} can be found at Bitbucket: \begin{center} - \url{http://code.google.com/p/classicthesis/} + \url{https://bitbucket.org/amiede/classicthesis/} \end{center} There, you can also post serious bugs and problems you encounter. \subsection*{Compatibility with the \texttt{glossaries} Package} If you want to use the \texttt{glossaries} package, take care of loading it with the following options: -\begin{verbatim} - \usepackage[style=long,nolist]{glossaries} -\end{verbatim} +\begin{lstlisting} + \usepackage[style=long,nolist]{glossaries} +\end{lstlisting} Thanks to Sven Staehs for this information. \subsection*{Compatibility with the (Spanish) \texttt{babel} Package} Spanish languages need an extra option in order to work with this template: -\begin{verbatim} - \usepackage[spanish,es-lcroman]{babel} -\end{verbatim} -Thanks to an unknown person for this information (via Google Code issue reporting). +\begin{lstlisting} + \usepackage[spanish,es-lcroman]{babel} +\end{lstlisting} +Thanks to an unknown person for this information (via the issue reporting). \paragraph{Further information for using \texttt{classicthesis} with Spanish (in addition to the above)} In the file \texttt{ClassicThesis.tex} activate the language: -\begin{verbatim} - \selectlanguage{spanish} -\end{verbatim} - -In order to get the bibliography style right, you can use the following: -\begin{verbatim} - \bibliographystyle{babplain} -\end{verbatim} - -For this, it is necessary to load the package: -\begin{verbatim} - \usepackage[spanish,fixlanguage]{babelbib} - \selectbiblanguage{spanish} -\end{verbatim} - +\begin{lstlisting} + \selectlanguage{spanish} +\end{lstlisting} + If there are issues changing \verb|\tablename|, \eg, using this: -\begin{verbatim} - \renewcommand{\bibname}{Referencias} - \renewcommand{\tablename}{Tabla} -\end{verbatim} +\begin{lstlisting} + \renewcommand{\tablename}{Tabla} +\end{lstlisting} This can be solved by passing \texttt{es-tabla} parameter to \texttt{babel}: -\begin{verbatim} - \PassOptionsToPackage{es-tabla,spanish,es-lcroman,english}{babel} - \usepackage{babel} -\end{verbatim} +\begin{lstlisting} + \PassOptionsToPackage{es-tabla,spanish,es-lcroman,english}{babel} + \usepackage{babel} +\end{lstlisting} -But it is also necessary set \texttt{spanish} in the \verb|\documentclass|. +But it is also necessary to set \texttt{spanish} in the \verb|\documentclass|. Thanks to Alvaro Jaramillo Duque for this information. @@ -372,49 +372,47 @@ in general, do not hesitate to write them on that postcard of yours. \section{Beyond a Thesis} -It is easy to use the layout of \texttt{classicthesis.sty} without the -framework of this bundle. To make it even easier, this section offers -some plug-and-play-examples. - -The \LaTeX -sources of these examples can be found in the folder -with the name \texttt{Examples}. They have been tested with +The layout of \texttt{classicthesis.sty} can be easily used without the +framework of this template. A few examples where it was used to typeset +an article, a book or a curriculum vitae can be found in the folder +\texttt{Examples}. The examples have been tested with \texttt{latex} and \texttt{pdflatex} and are easy to compile. To -assure you even a bit more, PDFs built from the sources can also -be found in the folder. +encourage you even more, PDFs built from the sources can be found in the +same folder. %(It might be necessary to adjust the path to %\texttt{classicthesis.sty} and \texttt{Bibliography.bib} within the %examples.) -\lstinputlisting[caption=An Article]% - {Examples/classicthesis-article.tex} - -\lstinputlisting[caption=A Book]% - {Examples/classicthesis-book.tex} - -\lstinputlisting[caption=A Curriculum Vit\ae]% - {Examples/classicthesis-cv.tex} +%\lstinputlisting[caption=An Article]% + %{Examples/classicthesis-article.tex} + % +%\lstinputlisting[caption=A Book]% + %{Examples/classicthesis-book.tex} +% +%\lstinputlisting[caption=A Curriculum Vit\ae]% + %{Examples/classicthesis-cv.tex} \section{License} \paragraph{GNU General Public License:} This program is free software; you can redistribute it and/or modify - it under the terms of the \textsmaller{GNU} General Public License as + it under the terms of the \acsfont{GNU} General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but \emph{without any warranty}; without even the implied warranty of - \emph{merchantability} or \emph{fitness for a particular purpose}. + \emph{merchant\-ability} or \emph{fitness for a particular purpose}. See the - \textsmaller{GNU} General Public License for more details. + \acsfont{GNU} General Public License for more details. - You should have received a copy of the \textsmaller{GNU} General + You should have received a copy of the \acsfont{GNU} General Public License along with this program; see the file \texttt{COPYING}. If not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, - Boston, \textsmaller{MA} 02111-1307, \textsmaller{USA}. + Boston, MA 02111-1307, USA. %***************************************** %***************************************** |