mirror/VWA
Archived
1
0
Fork 0
Code Releases Activity
This repository has been archived on 2024-06-28. You can view files and clone it, but cannot push or open issues or pull requests.
VWA/example-style-chapter.tex

553 lines
15 KiB
TeX
Raw Blame History

%----------------------------------------------------------------
%
% File : thesis-style.tex
%
% Author : Keith Andrews, IICM, TU Graz, Austria
%
% Created : 27 May 93
%
% Changed : 19 Feb 2004
%
% styling and technical implementation adopted 2011 by Karl Voit
%----------------------------------------------------------------
%% defined an anvironment for the style Keith used to use:
\newenvironment{mykeithtabbing}[1]{%%
\begin{tabular}{lp{0.9\hsize}}
}{%%
\end{tabular}
}
\newcommand{\mybadgood}[2]{%%
\begin{mykeithtabbing}
{}\emph{Bad:} & \sout{#1} \\
\emph{Good:} & #2 \\
\end{mykeithtabbing}
}
\chapter{Language and Writing Style}
\label{chap:Style}
\begin{framed}
This chapter is an adopted version of a single chapter of
\citeauthor{KeithThesis} thesis template \cite{KeithThesis} in its
version from 2011-12-11.
The reason why \cite{KeithThesis} is not recommended to be used instead
of this template is its more \enquote{traditional} \LaTeX{}
implementation. But the information contained regarding \enquote{How
to write a thesis} is generally brilliant and worth reading.
Using this chapter here is meant as a teaser. If you do like this
chapter, please go and download the full template to read its
content:~\cite{KeithThesis}.
What was modified from the original chapter:
\begin{itemize}
\item strikethrough of bad examples
\item minor typographical details
\item technical modifications
\begin{itemize}
\item moved citations from \verb+\citet{}+ and
\verb+\citep{}+ to \verb+\textcite{}+ and \verb+\cite{}+
\item changed quoting style to \verb+\enquote{}+
\item created various commands and environments to encapsulate
format
\end{itemize}
\end{itemize}
\end{framed}
The classic reference for English writing style and grammar is
\textcite{StrunkWhite}. The original text is now available for free
online \cite{Strunk}, so there is no excuse at all for writing poor
English. Readers should consult it first, then continue reading this
chapter. Another good free guide is \textcite{NASAGuide}.
%orig% The classic reference for English writing style and grammar is
%orig% \citet{StrunkWhite}. The original text is now available for free
%orig% online \citep{Strunk}, so there is no excuse at all for writing poor
%orig% English. Readers should consult it first, then continue reading this
%orig% chapter. Another good free guide is \citet{NASAGuide}.
\textcite{Zobel-WritingCompSci} and \textcite{BugsInWriting} are guides
specifically aimed at computer science students.
\textcite{Phillips-HowGetPhD} gives practical advice for PhD
students.
The following Sections~\ref{sec:Clear} and \ref{sec:Gender} are
adapted from the CHI'94 language and writing style guidelines.
\section{Some Basic Rules of English}
There are a few basic rules of English for academic writing, which are
broken regularly by my students, particularly if they are non-native
speakers of English. Here are some classic and often encountered
examples:
\begin{itemize}
\item \emph{Never} use I, we, or you.
Write in the passive voice (third person).
\mybadgood{You can do this in two ways.}{There are two ways this can be done.}
\item \emph{Never} use he or she, his or her.
Write in the passive voice (third person).
\mybadgood{The user speaks his thoughts out loud.}{The thoughts of the user are spoken out loud.}
See Section~\ref{sec:Gender} for many more examples.
\item Stick to a consistent dialect of English. Choose either
British or American English and keep to it throughout the
whole of your thesis.
\item Do \emph{not} use slang abbreviations such as \enquote{it's},
\enquote{doesn't}, or \enquote{don't}.
Write the words out in full: \enquote{it is}, \enquote{does not}, and \enquote{do not}.
\mybadgood{It's very simple to\ldots}{It is very simple to\ldots}
\item Do \emph{not} use abbreviations such as \enquote{e.\,g.} or
\enquote{i.\,e.}.
Write the words out in full: \enquote{for example} and \enquote{that is}.
\mybadgood{\ldots in a tree, e.\,g.\xspace{}the items\ldots}{\ldots in a tree, for example the items\ldots}
\item Do \emph{not} use slang such as \enquote{a lot of}.
\mybadgood{There are a lot of features\ldots}{There are many features\ldots}
\item Do \emph{not} use slang such as \enquote{OK} or \enquote{big}.
\mybadgood{\ldots are represented by big areas.}{\ldots are represented by large areas.}
\item Do \emph{not} use slang such as \enquote{gets} or \enquote{got}.
Use \enquote{becomes} or \enquote{obtains}, or use the passive voice (third
person).
\mybadgood{The radius gets increased\ldots}{The radius is increased\ldots}
\mybadgood{The user gets disoriented\ldots}{The user becomes disoriented\ldots}
\item \emph{Never} start a sentence with \enquote{But}.
Use \enquote{However,} or \enquote{Nevertheless,}. Or consider joining the
sentence to the previous sentence with a comma.
\mybadgood{But there are numerous possibilities\ldots}{However, there are numerous possibilities\ldots}
\item \emph{Never} start a sentence with \enquote{Because}.
Use \enquote{Since}, \enquote{Owing to}, or \enquote{Due to}. Or turn the two
halves of the sentence around.
\item \emph{Never} start a sentence with \enquote{Also}. Also should
be placed in the middle of the sentence.
\mybadgood{Also the target users are considered.}{The target users are also considered.}
\item Do \emph{not} use \enquote{that} as a connecting word.
Use \enquote{which}.
\mybadgood{\ldots a good solution that can be computed easily.}{\ldots a good solution which can be computed easily.}
\item Do \emph{not} write single-sentence paragraphs.
Avoid writing two-sentence paragraphs. A paragraph should contain at
least three, if not more, sentences.
\end{itemize}
% rules on the use of a comma in lists
% http://en.wikipedia.org/wiki/Serial_comma
\section{Avoid Austrianisms}
\label{sec:Austrianisms}
I see these mistakes time and time again. Please do not
let me read one of them in your work.
\begin{itemize}
\item \enquote{actual}~$\ne$~\enquote{current}
If you mean \enquote{aktuell} in German, you probably mean
\enquote{current} in English.
\mybadgood{The actual selection is cancelled.}{The current selection is cancelled.}
\item \enquote{allows to} is not English.
\mybadgood{The prototype allows to arrange components\ldots}%%
{The prototype supports the arrangement of components\ldots}
% they allow to achieve
\item \enquote{enables to} is not English.
\mybadgood{it enables to recognise meanings\ldots}{it enables the recognition of meanings\ldots}
\item \enquote{according}~$\ne$~\enquote{corresponding}
\mybadgood{For each browser, an according package is created.}{For each browser, a corresponding package is created.}
\item \enquote{per default} is not English.
Use \enquote{by default}.
\mybadgood{Per default, the cursor is red.}{By default, the cursor is red.}
\item \enquote{As opposed to} is not English.
Use \enquote{In contrast to}.
\mybadgood{As opposed to C, Java is object-oriented.}{In contrast to C, Java is object-oriented.}
\item \enquote{\emph{anything}-dimensional} is spelt with a hyphen.
For example: two-dimensional, three-dimensional.
\item \enquote{\emph{anything}-based} is spelt with a hyphen.
For example: tree-based, location-based.
\item \enquote{\emph{anything}-oriented} is spelt with a hyphen.
For example: object-oriented, display-oriented.
\item \enquote{\emph{anything}-side} is spelt with a hyphen.
For example: client-side, server-side.
\item \enquote{\emph{anything}-friendly} is spelt with a hyphen.
For example: user-friendly, customer-friendly.
\item \enquote{\emph{anything}-to-use} is spelt with hyphens.
For example: hard-to-use, easy-to-use.
\item \enquote{realtime} is spelt with a hyphen if used as
an adjective, or as two separate words if used as a noun.
\mybadgood{\ldots using realtime shadow casting.}{\ldots using real-time shadow casting.}
\mybadgood{\ldots display the object in realtime.}{\ldots display the object in real time.}
\end{itemize}
\section{Clear Writing}
\label{sec:Clear}
The written and spoken language of your thesis is English as
appropriate for presentation to an international audience. Please take
special care to ensure that your work is adapted to such an audience.
In particular:
\begin{itemize}
\item Write in a straight-forward style, using simple sentence
structure.
\item Use common and basic vocabulary. For example, use \enquote{unusual}
for \enquote{arcane}, and \enquote{specialised} for \enquote{erudite}.
\item Briefly define or explain all technical vocabulary the first
time it is mentioned, to ensure that the reader understands it.
\item Explain all acronyms and abbreviations. For example, the first
time an acronym is used, write it out in full and place the acronym
in parentheses.
\mybadgood{\ldots When using the \myacro{GUI} version, the use may\ldots}%%
{\ldots When using the Graphical User Interface (\myacro{GUI}) version, the use may\ldots}
\item Avoid local references. For example, not everyone knows the
names of all the provincial capitals of Austria. If local context is
important to the material, describe it fully.
\item Avoid \enquote{insider} comments. Ensure that your whole audience
understands any reference whose meaning you do not describe. For
example, do not assume that everyone has used a Macintosh or a
particular application.
\item Do not \enquote{play on words}. For example, do not use \enquote{puns},
particularly in the title of a piece. Phrases such as ``red
herring'' require cultural as well as technical knowledge of
English.
\item Use unambiguous formats to represent culturally localised things
such as times, dates, personal names, currencies, and even
numbers. 9/11 is the 9th of November in most of the world.
\item Be careful with humour. In particular, irony and sarcasm can be
hard to detect if you are not a native speaker.
\item If you find yourself repeating the same word or phrase too often,
look in a thesaurus such as \textcite{Roget,RogetII} for an
alternative word with the same meaning.
\end{itemize}
Clear writing experts recognise that part of writing understandable
documents is understanding and responding to the needs of the intended
audience. It is the writer's job to maintain the audience's
willingness to go on reading the document. Readers who are continually
stumped by long words or offended by a pompous tone are likely to stop
reading and miss the intended message.
\section{Avoiding Gender Bias}
\label{sec:Gender}
Part of striking the right tone is handling gender-linked terms
sensitively. Use of gender terms is controversial. Some writers use
the generic masculine exclusively, but this offends many readers.
Other writers are experimenting with ways to make English more
neutral. Avoiding gender bias in writing involves two kinds of
sensitivity:
\begin{enumerate}
\item being aware of potential bias in the kinds of observations and
characterisations that it is appropriate to make about women and men,
and
\item being aware of certain biases that are inherent in the language
and of how you can avoid them.
\end{enumerate}
The second category includes using gender-specific nouns and pronouns
appropriately. Here are some guidelines for handling these
problems:
\begin{itemize}
\item Use a gender-neutral term when speaking generically of people:
\begin{tabular}{ll}
man & the human race \\
mankind & humankind, people \\
manpower & workforce, personnel \\
man on the street & average person \\
\end{tabular}
\item Avoid clearly gender-marked titles. Use neutral terms when
good ones are available. For example:
\begin{tabular}{ll}
chairman & chairperson \\
spokesman & speaker, representative \\
policeman & police officer \\
stewardess & flight attendant \\
\end{tabular}
\item If you are speaking of the holder of a position and you know the
gender of the person who currently occupies the position, use the
appropriate gender pronoun. For example, suppose the \enquote{head nurse}
is a man:
\mybadgood{The head nurse must file her report every Tuesday.}{The head nurse must file his report every Tuesday.}
\item Rewrite sentences to avoid using gender pronouns. For example,
use the appropriate title or job name again:
\mybadgood{Interview the user first and then ask him to fill out a questionnaire.}%%
{Interview the user first and then ask the user to fill out a questionnaire.}
\item To avoid using the third person singular pronoun (his or her),
recast your statement in the plural:
\mybadgood{Each student should bring his text to class.}{All students should bring their texts to class.}
\item Address your readers directly in the second person, if it is
appropriate to do so:
\mybadgood{The student must send in his application by the final deadline date.}%%
{Send in your application by the final deadline date.}
\item Replace third person singular possessives with articles.
\mybadgood{Every student must hand his report in on Friday.}{Every student must hand the report in on Friday.}
\item Write your way out of the problem by using the passive voice.
\mybadgood{Each department head should do his own projections.}{Projections should be done by each department head.}
\item Avoid writing awkward formulations such as \enquote{s/he}, \enquote{he/she},
or \enquote{his/her}. They interfere when someone is trying to read a
text aloud. If none of the other guidelines has been helpful, use
the slightly less awkward forms \enquote{he or she}, and \enquote{his or hers}.
\end{itemize}
Remember, the goal is to avoid constructions that will offend your
readers so much as to distract them from the content of your work.
\section{Titles and Headings in Initial Caps}
% Capitalization in Titles
% http://www.writersblock.ca/tips/monthtip/tipmar98.htm
\section{Use a Spelling Checker}
In these days of high technology, spelling mistakes and typos are
inexcusable. It is \emph{very} irritating for your supervisor to have
to read through and correct spelling mistake after spelling mistake
which could have been caught by an automated spelling checker.
Believe me, irritating your supervisor is not a good idea.
So, use a spelling checker \emph{before} you hand in \emph{any}
version, whether it is a draft or a final version.
Since this is apparently often forgotten, and sometimes even wilfully
ignored, let me make it absolutely clear:
\begin{quote}
\begin{em}
Use a spelling checker, please. \\
Use a spelling checker! \\
Use a spelling checker, you moron. \\
\end{em}
\end{quote}
\section{Use a Dictionary}
If you are not quite sure of the meaning of a word, then use a
dictionary. \textcite{DictionaryCom} is a free English dictionary,
\textcite{DictChemnitz} and \textcite{DictLeoOrg} are two very good
English-German dictionaries.
\section{Use a Thesaurus}
If a word has been used several times already, and using another
equivalent word might improve the readability of the text, then
consult a thesaurus. \textcite{Roget} and \textcite{RogetII} are free
English thesauri.
View git blame Copy permalink