diff options
author | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
commit | e0c6872cf40896c7be36b11dcc744620f10adf1d (patch) | |
tree | 60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/univie-ling/doc/univie-ling-wlg.tex |
Initial commit
Diffstat (limited to 'macros/latex/contrib/univie-ling/doc/univie-ling-wlg.tex')
-rw-r--r-- | macros/latex/contrib/univie-ling/doc/univie-ling-wlg.tex | 238 |
1 files changed, 238 insertions, 0 deletions
diff --git a/macros/latex/contrib/univie-ling/doc/univie-ling-wlg.tex b/macros/latex/contrib/univie-ling/doc/univie-ling-wlg.tex new file mode 100644 index 0000000000..6c491d7d2d --- /dev/null +++ b/macros/latex/contrib/univie-ling/doc/univie-ling-wlg.tex @@ -0,0 +1,238 @@ +\documentclass[english]{article} + +\usepackage[osf]{libertine} +\usepackage[scaled=0.7]{beramono} +\usepackage[T1]{fontenc} +\usepackage[latin9]{inputenc} +\usepackage{url} +\usepackage[pdfusetitle, + bookmarks=true,bookmarksnumbered=false,bookmarksopen=false, + breaklinks=false,pdfborder={0 0 0},backref=false,colorlinks=false] + {hyperref} + +% Tweak the TOC (make it more compact) +\usepackage{tocloft} +\setlength{\cftaftertoctitleskip}{6pt} +\setlength{\cftbeforesecskip}{3pt} +\setlength{\cftbeforesubsecskip}{0pt} +\renewcommand{\cfttoctitlefont}{\normalsize\bfseries} +\renewcommand{\cftsecfont}{\small\bfseries} +\renewcommand{\cftsecpagefont}{\small\bfseries} +\renewcommand{\cftsubsecfont}{\small} +\renewcommand{\cftsubsecpagefont}{\small} + +% markup +\newcommand*\jmacro[1]{\textbf{\texttt{#1}}} +\newcommand*\jcsmacro[1]{\jmacro{\textbackslash{#1}}} +\newcommand*\joption[1]{\textbf{\texttt{#1}}} +\newcommand*\jfmacro[1]{\texttt{#1}} +\newcommand*\jfcsmacro[1]{\jfmacro{\textbackslash{#1}}} + +% macros +\newcommand*\uvlt{\textsf{univie-ling-wlg}} +\providecommand{\LyX}{L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@} + +% improve layout +\tolerance 1414 +\hbadness 1414 +\emergencystretch 1.5em +\hfuzz 0.3pt +\widowpenalty = 10000 +\vfuzz \hfuzz +\raggedbottom + +\usepackage{microtype} + +\usepackage{babel} + +\usepackage{listings} +\lstset{language={[LaTeX]TeX}, + basicstyle={\small\ttfamily}, + frame=single} + +\setcounter{tocdepth}{2} + +\begin{document} + +\title{The \uvlt\ class} + +\author{\texorpdfstring{Jürgen Spitzmüller% + \thanks{Please report issues via \protect\url{https://github.com/jspitz/univie-ling}.}}{Jürgen Spitzmüller}} + +\date{Version 1.9, 2019/01/21} + +\maketitle + +\begin{abstract} +\noindent The \uvlt\ class provides a \LaTeXe\ class suitable for articles in the journal \emph{Wiener Linguistische Gazette} (WLG), +the house journal of the Department of Linguistics at the University of Vienna.\footnote{See \url{https://wlg.univie.ac.at}.} +\end{abstract} + +\tableofcontents + +\clearpage + +\section{Aims and scope} + +The \uvlt\ class provides a \LaTeXe\ class suitable for articles in the journal \emph{Wiener Linguistische Gazette} (WLG) and should +be used for contributions to this journal. It comes with suitable \textsf{biblatex} style files that follow the style sheet of the journal. + +\section{Fonts}\label{fonts} + +The class uses PostScript (a.\,k.\,a. Type\,1) fonts and thus requires classic (PDF)LaTeX. + +By default, the class uses by default \emph{Crimson} as a serif font (via the \textsf{cochineal} package). +Alternatively, the quite similar shaped \emph{MinionPro} can also be used. +It covers more glyphs and is probably a bit more polished than \emph{Cochineal}, but due to license reasons it is not included in the common +\LaTeX\ distributions. \emph{MinionPro} is provided by the excellent \textsf{FontPro} package.% +\footnote{\url{https://github.com/sebschub/FontPro} <25.\,01.\,2017>.} However, some effort is needed to install the package and fonts. +Please refer to the package's documentation in case you are interested. + +If you want to use \emph{MinionPro}, use the class option \joption{expertfonts=true} (see sec.~\ref{coptions}). + + +\section{Class Options}\label{coptions} + +The \uvlt\ class provides a range of key=value type options to control the font handling, package loading and some specific behavior. +These are documented in this section. + +\subsection{Font selection} + +As elaborated above, the package supports only PostScript fonts (via LaTeX and PDFLaTeX). +PostScript is the traditional LaTeX font format. Specific LaTeX packages and metrics files are needed to use the fonts (but the default font +needed to use this class should be included in your LaTeX distribution and thus ready to use). + +The class provides the following option to set the font handling: +\begin{description} + \setlength\itemsep{0pt} + \item{\joption{expertfonts=true|false}}: if this option is set to true, \emph{MinionPro} is used instead of \emph{Crimson}. + See sec.~\ref{fonts} for details. +\end{description} + +\subsection{Package loading}\label{packageloading} + +Some extra features provided by the class can toggled. This might be useful if you do not need the respective feature anyway, +and crucial if you need an alternative package that conflicts with one of the preloaded package. + +\begin{description} + \setlength\itemsep{0pt} + \item{\joption{biblatex=true|false}}: If \joption{true}, \textsf{biblatex} is loaded with a suitable style. This is actually encouraged. + See sec.~\ref{bibliography} for details. + \item{\joption{covington=true|false}}: If \joption{false}, \textsf{covington} is not loaded. Covington is used for numbered examples. +\end{description} + +\subsection{Titlepage settings}\label{titlepage} + +The class can generate a titlepage in two different forms. + +\begin{description} + \setlength\itemsep{0pt} + \item{\joption{titlepage=none|specialprint|issue}}: If \joption{none} (default), no titlepage is generated. + With \joption{issue}, a title page for a whole journal issue is output. + With \joption{specialprint}, a special print (``Sonderdruck'') title page suitable for single articles + is generated. +\end{description} + +\section{General settings} + +\subsection{Editorial data} + +\begin{description} + \setlength\itemsep{0pt} + \item{\jcsmacro{startpage\{<page>\}}} Set start pagination (default: 1). + \item{\jcsmacro{issue\{<number>\}\{<year>\}}} Set journal issue (number and year) + \item{\jcsmacro{issuetitle\{<title>\}}} Set title of special issue + \item{\jcsmacro{issuesubtitle\{<subtitle>\}}} Set subtitle of special issue + \item{\jcsmacro{issueeditors\{<names>\}}} Set editors of special issue. +\end{description} + +\subsection{Titling} + +\begin{description} + \setlength\itemsep{0pt} + \item{\jcsmacro{author\{<name>\}}}: Article author(s); multiple authors separated by \jfcsmacro{and}. + Author affiliations should be specified via the macro \jcsmacro{aff\{Affilitation\}} immediately behind the author name, + using \jcsmacro{aff*[m|f]\{Affilitation\}} for the corresponding author (the optional argument, \joption{f} or \joption{m}, + specifies the gender) + \item{\jcsmacro{title\{<title>\}}}: Title of the paper. + \item{\jcsmacro{subtitle\{<subtitle>\}}}: Subtitle. +\end{description} +Use \jfcsmacro{maketitle} to set the title after the above settings have been made. + +\subsection{Abstract and keywords} +The abstract is set with the \jmacro{abstract} environment. +Keywords (following the abstract) are set with the \jcsmacro{keywords\{<comma-separated keywords>\}} macro. + +\subsection{Structuring} + +The usual sectioning commands are used. For quotations, it is advised to use the display quote environments provided by the \textsf{csquotes} +package (which is automatically loaded). If you want to start your paper with a smart quote, use + +\jcsmacro{motto{[<source>]}\{Motto\}} + +\section{Semantic markup}\label{markup} + +The class defines some basic semantic markup common in linguistics: + +\begin{description} + \setlength\itemsep{0pt} + \item{\jcsmacro{Expression\{<text>\}}}: To mark expressions (object language). Typeset in \emph{italics}. + \item{\jcsmacro{Concept\{<text>\}}}: To mark concepts. Typeset in \textsc{small capitals}. + \item{\jcsmacro{Meaning\{<text>\}}}: To mark meaning. Typeset in `single quotation marks'. +\end{description} +You can redefine each of these commands, if needed, like this: +\begin{lstlisting}[language={[LaTeX]TeX},basicstyle={\small\ttfamily},frame=single,morekeywords={enquote}] +\renewcommand*\Expression[1]{\textit{#1}} +\renewcommand*\Concept[1]{\textsc{#1}} +\renewcommand*\Meaning[1]{\enquote*{#1}} +\end{lstlisting} + +Furthermore, the class features a \jcsmacro{versal\{<text>\}} macro to typeset capital text and acronyms (slightly scaled and tracked). + + +\section{Linguistic examples and glosses} + +The class automatically loads the \textsf{covington} package which provides macros for examples and glosses. +Please refer to the \textsf{covington} manual \cite{covington} for details. + +\section{Bibliography}\label{bibliography} + +If the class option \joption{biblatex=true} is set, the \uvlt\ class loads a bibliography style which matches journal style sheet. These conventions draw on the +\emph{Unified Style Sheet for Linguistics} of the LSA (\emph{Linguistic Society of America}). +In order to conform to this style, the \uvlt\ class uses the \textsf{biblatex} package with the \textsf{univie-ling} style that is included in the \textsf{univie-ling} bundle. + +\section{\LyX\ layouts and templates} + +A layout for \LyX\footnote{See \url{https://www.lyx.org}.}\ can be retrieved from \url{https://github.com/jspitz/univie-ling/raw/master/lyx/layouts/univie-ling-wlg.layout}. + +A template is provided as well: \url{https://github.com/jspitz/univie-ling/raw/master/lyx/templates/template-wlg-article.lyx}. + +\clearpage + +\section{Release History} + +\begin{itemize} + \item 2019/01/21 (v.\,1.9) No change to this class. + \item 2019/01/15 (v.\,1.8) No change to this class. + \item 2018/11/07 (v.\,1.7) No change to this class. + \item 2018/11/04 (v.\,1.6) Remove \jmacro{subexamples} environment as this is now provided by \textsf{covington}. + \item 2018/09/03 (v.\,1.5) + \begin{itemize} + \item Introduce \jmacro{subexamples} environment. + \item Fix \joption{expertfonts} option. + \end{itemize} + \item 2018/04/26 (v.\,1.4) Fix full date issue in biblatex bibliography style. + \item 2018/03/02 (v.\,1.3) Add (CC BY-NC-ND-4.0) license statement to copyright page (via \textsf{doclicense} package). + \item 2018/02/13 (v.\,1.2) Rename \texttt{wlg.cls} to \texttt{univie-ling-wlg.cls} as per TeXLive request. + \item 2018/02/11 (v.\,1.1) Initial release to CTAN. +\end{itemize} + +\begin{thebibliography}{1} + + \bibitem{covington} Covington, Michael A. and Spitzmüller, Jürgen: + \emph{The covington Package. Macros for Linguistics}. September 7, 2018. + \url{http://www.ctan.org/pkg/covington}. + +\end{thebibliography} + +\end{document} |