summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/univie-ling/doc/univie-ling-wlg.tex
blob: 627a7fe84e88d441a242280d0c6dfe2aaabd0684 (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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
\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.13, 2020/11/11}

\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.
	\item{\joption{peerrev=true|false}}: If \joption{true}, a statement is added to the imprint stating that the papers
	      of this issue have undergone double-blind peer review.
	\item{\joption{preprint=true|false}}: If \joption{true}, the issue is marked as preprint on the titlepage and in
	     the journal metadata. Pagination info in these places is suppressed.
\end{description}

\section{General settings}

\subsection{Editorial data}

Data for a particular issue can be set via:

\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
\end{description}
%
If needed, the editorial board (as printed in the imprint) can be adapted for a particular issue via:

\begin{description}
 \setlength\itemsep{0pt}
 \item{\jcsmacro{edboardGL\{<name>\}}} Set editorial board member(s) for General Linguistics
 \item{\jcsmacro{edboardAL\{<name>\}}} Set editorial board member(s) for Applied Linguistics
 \item{\jcsmacro{edboardHL\{<name>\}}} Set editorial board member(s) for Historical Linguistics
 \item{\jcsmacro{techboard\{<name>\}}} Set technical board member(s)
\end{description}
%
In general, the data for the editorial board should be set/changed in a local copy of the file
\texttt{univie-ling-wlg.cls} which is shipped with this class.

\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.
Please note that language switches for abstracts in a different language should be done inside the \jmacro{abstract}
environment. It is suggested to use \textsf{babel}'s \jfmacro{otherlanguage} environment for this purpose.

\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}.


\section{Release History}

\raggedright
\begin{itemize}
  \item 2020/11/11 (v.\,1.13) 
  \begin{itemize}
  	\item Use \textsf{totpages} package rather than \textsf{lastpage} in order to fix
          clash with \textsf{totpages} which is loaded by a secondary package.
    \item New option \joption{peerrev}.
    \item New option \joption{preprint}.
    \item Factor out editorial data to new \texttt{univie-ling-wlg.cls} file
    \item Make editorial data configurable locally via \jcsmacro{edboardGL}, \jcsmacro{edboardAL}, 
          \jcsmacro{edboardHL}, and \jcsmacro{techboard}.
  \end{itemize}
  \item 2020/06/25 (v.\,1.12) Adapt to compatibility-breaking \textsf{doclicense} change.
  \item 2020/05/05 (v.\,1.11) Update editorial board info.
  \item 2020/05/01 (v.\,1.10) Fix encoding incompatibilities.
  \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}