From 656f705eeb92255c43efeda19342962a012dd670 Mon Sep 17 00:00:00 2001
From: karl <karl.kirchner@h-brs.de>
Date: Mon, 24 Oct 2022 14:35:15 +0200
Subject: [PATCH] replaced the thesis_english file
---
literatur.bib | 49 +---
thesis_english.tex | 627 +++++++++++++++++++++++++++++----------------
2 files changed, 410 insertions(+), 266 deletions(-)
diff --git a/literatur.bib b/literatur.bib
index 718526e..90c632e 100644
--- a/literatur.bib
+++ b/literatur.bib
@@ -1,4 +1,5 @@
-% Encoding: ISO-8859-1
+% This file was created with JabRef 2.10.
+% Encoding: ISO8859_1
@Book{Becker2008,
@@ -142,49 +143,3 @@
Url = {https://www.sublimetext.com}
}
-@Misc{Goel2012,
- author = {Sanjay Goel},
- title = {{Research Method for Engineering Research Students -- Part II: A Checklist for Reflective Self-assessment of the Research Work}},
- howpublished = {\url{https://goelsan.wordpress.com/2012/04/15/research-method-for-engineering-research-students-part-II-a-checklist-for-reflective-self-assessment-of-the-research-work/}},
- month = {April 15},
- year = {2012},
- note = {Accessed: 2022-10-21},
- url = {https://goelsan.wordpress.com/2012/04/15/research-method-for-engineering-research-students-part-II-a-checklist-for-reflective-self-assessment-of-the-research-work},
-}
-
-@Book{CargillO2013,
- title = {Writing scientific research articles: Strategy and steps},
- publisher = {John Wiley \& Sons},
- year = {2013},
- author = {Cargill, Margaret and O'Connor, Patrick},
-}
-
-@Article{Zhang2014,
- author = {Zhang, Weixiong},
- title = {Ten Simple Rules for Writing Research Papers},
- journal = {PLOS Computational Biology},
- year = {2014},
- volume = {10},
- number = {1},
- pages = {1-3},
- month = {01},
- doi = {10.1371/journal.pcbi.1003453},
- keywords = {rank4},
- publisher = {Public Library of Science},
- url = {https://doi.org/10.1371/journal.pcbi.1003453},
-}
-
-@Article{Hyland1994,
- author = {Ken Hyland},
- title = {Hedging in academic writing and {EAF} textbooks},
- journal = {English for Specific Purposes},
- year = {1994},
- volume = {13},
- number = {3},
- pages = {239 - 256},
- issn = {0889-4906},
- doi = {https://doi.org/10.1016/0889-4906(94)90004-3},
- url = {http://www.sciencedirect.com/science/article/pii/0889490694900043},
-}
-
-@Comment{jabref-meta: databaseType:bibtex;}
diff --git a/thesis_english.tex b/thesis_english.tex
index 2a1e00c..cd54915 100644
--- a/thesis_english.tex
+++ b/thesis_english.tex
@@ -1,243 +1,338 @@
-\NeedsTeXFormat{LaTeX2e} %% latest stable release of LaTeX
+\documentclass{hbrs_thesis_english}
-\documentclass[a4paper]{book}
-
-%% Allow for German character input from keyboard
-\usepackage[utf8]{inputenc}
-\usepackage[T1]{fontenc}
-
-\usepackage{mathptmx} %% Change the document font - mathptmx provides Times font (defualt)
-
-%% German-specific headers, content (e.g. date) and commands (e.g. hypenation)
-\usepackage[ngerman]{babel}
-
-%% Need to also deal with the bibliography (e.g. "und" within author list; "Seiten")
-%% options: babplain, babplain-fl, babalpha, babalpha-fl, babunsrt, babunsrt-fl, bababbrv and bababbrv-fl.
-%% The -fl means to use the first, last name style of author listing (after the first author)
-\usepackage[fixlanguage]{babelbib}
-\selectbiblanguage{ngerman}
-
-\usepackage{amsmath}
-\usepackage{xfrac} %% alternative fraction notation using \sfac
-
-%\usepackage{float} %% better float management
-
-%% Figures
-\usepackage{graphicx} %% Grafiken einbinden (hängt von latex/dvipdf oder pdflatex ab!) || For figures
-\usepackage{subfig} %% Teilgrafiken erlauben || Allows subfigures within one parent figure
-
-%% Tables
-\usepackage{booktabs, threeparttable} %% table with footnotes and lines (see Table 2)
-\usepackage[labelfont=bf, labelsep=period]{caption} %% captions with boldface ``Figure #.'' and ``Table #.'' with period as label seperator
-
-%% Scientific units
-\usepackage{siunitx} %% For proper units (e.g. \si{kg.m.s^{-1}}) and numbers (e.g. \num{.3e45})
-
-\usepackage{url} %% For citing webpages
-\usepackage[hidelinks]{hyperref} %% insert document internal links
-
-%% geometry of page
-%% vertikal
-\setlength{\voffset}{-0.5cm}
-\setlength{\textheight}{23cm}
-\setlength{\topmargin}{0cm}
-\setlength{\headheight}{6mm}
-\setlength{\headsep}{1cm}
-\setlength{\topskip}{0cm}
-\setlength{\footskip}{1cm}
-%% horizontal
-\setlength{\hoffset}{-0.4cm}
-\setlength{\textwidth}{15.5cm}
-\setlength{\oddsidemargin}{0.8cm}
-\setlength{\evensidemargin}{0.8cm}
-
-\setlength{\parindent}{15pt} %% kein Einzug bei Paragrafenbeginn || paragraph indentation
+\usepackage{lipsum}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%% Hier geht es los || Your document editing starts here
-
-%% Autor und Abgabedatum ändern || Author and Date
-\def\autor{FirstName LastName}
-\def\datum{01. Januar 2020}
+%% Basic Information
+\thesistype{Master Thesis}
+\degree{Master of Computer Science}
+\title{Thesis Title}
+\author{FirstName LastName}
+\supervisorfirst{Title FirstName Last Name}
+\supervisorsecond{Title FirstName Last Name}
+\supervisorthird{Third Supervisor/Mentor}
+\date{Month DD, 20XX}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%% Titelseite || Title page
\begin{document}
-
-\sloppy
-\pagestyle{headings}
-\pagenumbering{roman}
-
-\begin{titlepage}
- \begin{minipage}{0.5\textwidth}
- \raggedright
- \includegraphics[width=8cm]{Logo_HBRS_74mm_Pfade.pdf}
- \end{minipage}
- \hspace{1cm}
- \begin{minipage}{0.5\textwidth}
- \raggedleft
- %\includegraphics[height=1.2cm]{second_logo.pdf} %% if you want to include a company logo uncomment this
- \end{minipage}
-
- \renewcommand{\baselinestretch}{1.4}\normalsize
- \vspace{2cm}
- \begin{center}
-
-%% einen Typ auswählen
- \begin{Huge}\textbf{Bachelorarbeit / Masterarbeit}\end{Huge} \\
- \vspace{0.8cm}
-
-%% einen Studiengang auswählen
-% \begin{Large}\textbf{Bachelor of Computer Science}\end{Large} \\
- \begin{Large}\textbf{Master of Computer Science}\end{Large} \\
-
- \vspace{2.2cm}
- \renewcommand{\baselinestretch}{1.2}\normalsize
- \begin{huge}
- \textbf{Endgültiger Titel \\}
- \end{huge}
- \renewcommand{\baselinestretch}{1.5}\normalsize
- \vspace{0.7cm}
-
- \begin{Large}\textbf{von \autor\ \\}
- \end{Large}
- Matrikelnummer \\ ~\\
- \begin{Large}
- \textbf{Fachbereich Informatik}
- \end{Large}
- \end{center}
-
- \vspace{5.0cm}
-
- \begin{large}
- \textbf{
- \begin{tabular}{ll}
- Erstbetreuer & Title FirstName LastName \\
- Zweitbetreuer & Title FirstName LastName \\
- & \\
- Eingereicht am: & \datum\ \\ %% or type in: 01. Januar 2017
- \end{tabular}
- }
- \end{large}
-\end{titlepage}
+\maketitle
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Erklärung || Declaration of Academic Integrity
\cleardoublepage
-\section*{Erklärung}
+\section*{Declaration of Academic Integrity}
+
+``Ich versichere hiermit, die von mir vorgelegte Arbeit selbstst\"{a}ndig verfasst zu haben. Alle Stellen, die w\"{o}rtlich oder sinngem\"{a}\ss{} aus ver\"{o}ffentlichten oder nicht ver\"{o}ffentlichten Arbeiten anderer entnommen sind, habe ich als entnommen kenntlich gemacht. S\"{a}mtliche Quellen und Hilfsmittel, die ich f\"{u}r die Arbeit benutzt habe, sind angegeben. Die Arbeit hat mit gleichem Inhalt bzw. in wesentlichen Teilen noch keiner anderen Pr\"{u}fungsbeh\"{o}rde vorgelegen.
+
+Mir ist bewusst, dass sich die Hochschule vorbeh\"{a}lt, meine Arbeit auf plagiierte Inhalte hin zu \"{u}berpr\"{u}fen und dass das Auffinden von plagiierten Inhalten zur Nichtigkeit der Arbeit, zur Aberkennung des Abschlusses und zur Exmatrikulation f\"{u}hren kann.''\\
-\glqq Ich versichere hiermit, die von mir vorgelegte Arbeit selbstständig verfasst zu haben. Alle Stellen, die wörtlich oder sinngemaß aus veröffentlichten oder nicht veröffentlichten Arbeiten anderer entnommen sind, habe ich als entnommen kenntlich gemacht. Sämtliche Quellen und Hilfsmittel, die ich für die Arbeit benutzt habe, sind angegeben. Die Arbeit hat mit gleichem Inhalt bzw. in wesentlichen Teilen noch keiner anderen Prüfungsbehörde vorgelegen.
+\noindent ``I hereby declare that I have independently written the work that I have submitted. All passages, taken literally or paraphrased from published or unpublished works of others, I have appropriately cited as such. All sources and resources I have used for the submitted work are given. The work has not yet been submitted to any other examination body with the same content or in substantial parts.
-Mir ist bewusst, dass sich die Hochschule vorbehält, meine Arbeit auf plagiierte Inhalte hin zu überprüfen und dass das Auffinden von plagiierten Inhalten zur Nichtigkeit der Arbeit, zur Aberkennung des Abschlusses und zur Exmatrikulation fähren kann.\grqq
+I am aware that the university reserves the right to check my work for plagiarized content, and that finding plagiarized content can lead to the dismissal of the work, to the disqualification of the conclusion and to exmatriculation.''
\vspace{2cm}
\begin{minipage}[t]{7cm}
\rule{5cm}{0.1mm}
\flushleft
-Ort, Datum \\
+Location, Date
\end{minipage}
\null\hfill
\begin{minipage}[t]{7cm}
\rule{7cm}{0.1mm}
\flushleft
-Unterschrift \\
+Signature
\end{minipage}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%% Dankesagung
+%% Acknowledgments
\cleardoublepage
-\section*{Danksagung}
-1--2 Absätze \\
+\section*{Acknowledgments}
+Approximately 1--2 paragraphs, but this is very flexible.\\
-An dieser Stelle möchte ich all jenen danken, die mich während meines Studiums
-und der Anfertigung dieser Arbeit begleitet haben. \\
+Thank the people who helped you achieve this academic goal.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%% Zusammenfassung || Abstract
+%% Abstract
\cleardoublepage
-\section*{Zusammenfassung}
-1 Absätz \\
+\section*{Abstract}
-Fassen Sie Ihre Arbeit zusammen. Dies geschieht in der Regel zuletzt, nachdem Sie den
-Rest Ihrer Arbeit geschrieben haben. \\
+This template is to guide you in your thesis writing. Each chapter of the thesis below will contain a brief explanation of what contents it should contain. This template was designed for thesis work that involves data generate and interpretation.\\
+
+\textcolor{HBRS}{Ultimately, you should speak to your supervisors about exactly to what contents (i.e. chapters) your thesis should contain. For example, an engineering or product development project may follow a different thesis outline.}\\
+
+The purpose of the Abstract is to summarize your thesis. You want to provide an overall context for why your project is important. This is usually the last section that is written, after you have finished the other thesis sections. An Abstract is typically 1 paragraph long, but under certain circumstance it can be 2-3 paragraphs.\\
+
+\paragraph{General Guide to Writing an Abstract}\mbox{}\\
+
+The following is a \textit{general} guide to writing an Abstract:
+\begin{itemize}
+ \item Meta-level context: place the thesis content into a bigger picture on why it is important
+ \item Narrow context: what is the exact problem that you investigated
+ \item Methodology (can be optional): how did you investigate the problem
+ \item Results: what is the main result of the thesis
+ \item Discussion: what do the results mean with regards to the narrow context stated
+\end{itemize}
+
+\par\noindent\rule{\textwidth}{1.2pt}
+
+\paragraph{Recommendation for Overall Thesis Writing}\mbox{}\\
+
+Good scientific writing is readable. The goal of scientific research writing is to a) reports new knowledge, whose data is reproducible, and c) whose statements are supported by data and citations When you are writing and revising your thesis, keep in mind the following \textcolor{HBRS}{$\textrm{C}^3$}:
+
+\begin{enumerate}
+ \item \textbf{Concisely} written text is always better
+ \begin{itemize}
+ \item strive to use less words (done mostly during revision)
+ \item keep the sentences' main information content intact (i.e. the sentence's purpose)
+ \item use easy to understand words when possible and appropriate
+ \item write full sentences
+ \end{itemize}
+ \item \textbf{Clear} thought process should be seen in your thesis structure and writing, with a logical grouping of ideas shown
+ \begin{itemize}
+ \item when organizing your thesis, paragraphs, and their individual sentences, logically separate and isolate individual ideas
+ \end{itemize}
+ \item \textbf{Context} should always be provided for the different variety of information presented in the thesis
+ \begin{itemize}
+ \item avoid making assumptions that the reader understands your thought process
+ \end{itemize}
+\end{enumerate}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%% Inhaltsverzeichnis || Content and list of figures and tables
+%% Content and list of figures and tables
-\tableofcontents %% Inhaltsverzeichnis generieren || Table of Contents
-\listoffigures %% Abbildungsverzeichnis || List of Figures
-\listoftables %% Tabellenverzeichnis || List of Tables
+\tableofcontents %% Table of Contents
+\listoffigures %% List of Figures
+\listoftables %% List of Tables
\cleardoublepage
%% Switch to different style of numbers
\pagenumbering{arabic}
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%% Kapitel 1 || Chapter 1
+%% Chapter: Introduction
+
+\chapter{Introduction}
+
+\paragraph{General Guide to Writing an Introduction}\mbox{}\\
-\chapter{Einleitung}
-ca. 1-2 Seiten
+The goal of the Introduction is to provide context for the thesis's work. Typically, it starts off with a broad context, narrows to more specific context, and ends with the specific focus of the thesis. There is some freedom here on exactly how you set up this section - some include subsection that isolate specific idea, while others do not. This will depend on your own style and in agreement with your supervisor. This section cites existing sources of knowledge, which should primarily be peer-reviewed literature.\\
+
+
+The following is a \textit{general} guide to writing an Introduction:
\begin{enumerate}
- \item Fassen Sie die Bedeutung des Themas zusammen.
- \item Beschreiben Sie den Stand der Technik.
- \item Geben Sie die spezifische Frage / Hypothese an, die Sie beantworten / erkunden. Das Ziel der Arbeit muss klar werden.
+ \item Provide some meta-level context
+ \item Provide some more domain-specific context
+ \item State the purpose of the thesis, can be written in present or past tense depending on if a statement is considered to be always true (i.e. present tense) or if a statement concerns the past.\\
+ \textcolor{HBRS}{''We show here the solution to ...''} \\
+ \textcolor{HBRS}{''The work reported here was conducted ...''}
+ \item Present the a review of foundational (older, but relevant) and the state-of-the-art (see below for more about this) work, written in past tense
+ \item Specify the research question(s) or hypothesis that your thesis answers - clear statements must be given
+ \item Optional: highlight the benefit of the work - present perfect \& modal verbs \\
+ \textcolor{HBRS}{''Researchers can use ...''}
+ \item Optional: state and very briefly explain what sections are coming next in the thesis (this can usually be left out, but ask your supervisor), written in present tense
\end{enumerate}
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%% Kapitel 2
-\chapter{Material und Methoden} %% Remove and Materials if it doesn't apply.
-ca. 1-3 Seiten
+\subsection{State-of-the-Art}
-Dieser Abschnitt liefert die erforderlichen Informationen für die Reproduzierbarkeit der Arbeit. Das kann verwendete Materialien und Software einschließen. \\
+Understanding and presenting the state-of-the-art is crucial to the quality of your thesis research, results and write-up. Due to the importance of this, the state-of-the-art can be given its own chapter (e.g. Chapter 2) if there is enough knowledge to cover. The goal of this section is to establish the importance of your research in context to topic's domain (i.e. community). Thus, it should focus upon the existing knowledge that is directly relevant to your research. You should prioritize covering a) the most recently published knowledge and b) relatively recent work (e.g. within the last ca. 5-7 years), but is highly cited.\\
-\section{Zitate und Zitieren}
-%% Indirect and short direct quotations.
-%% For quoting short statements or sentences -- use \glqq und \grqq
+The state-of-the-art cites lots of literature, with short written summaries that places the literature into context of your thesis. The literature cited should mostly be peer-reviewed papers, with other sources also allowed (e.g. preprints, websites) if deemed important and trustworthy. The state-of-the-art is written in the past tense.\\
+
+\subsection{Research Questions vs. Hypothesis}
+The thesis work should be centered around a research question, or if the area is already quite advanced then a hypothesis.
+
+\begin{itemize}
+ \item Research Questions: allow for a wide variety of outcomes
+ \item Research Hypothesis: usually allows for a narrow set of outcomes
+\end{itemize}
+
+A well formulated question or hypothesis will \textbf{greatly help you focus} your efforts during your thesis, and \textbf{provide a clear direction} for writing your thesis.
+
+\subsubsection{Research Question}
+A research question
+\begin{itemize}
+ \item is used when little work (knowledge) exists or
+ \item is used when there is a contradiction within the literature
+ \item does not state how variables will be related (correlated)
+ \item is \textbf{inquisitive} in nature
+\end{itemize}
+
+\noindent \textbf{Example}: \textcolor{HBRS}{``What effect does being able to read English well have on a student's grade?''}\\
+
+\noindent Ultimately, the research question should %\cite{ChinO2008}
+\begin{itemize}
+ \item be built upon some level of existing knowledge
+ \item generate new knowledge
+ \item be exploratory
+ \item have initial predictions
+ \item generate new questions
+ \item generate new solutions
+ \item initiate a process for future hypothesizing
+\end{itemize}
+
+\paragraph{Types of research questions}\mbox{}
+\begin{itemize}
+ \item \textbf{Factual} - look for causal relationships and describe them\\
+ (e.g. \textcolor{HBRS}{``Which fuel additive results in the most horsepower?''})
+ \item \textbf{Comparative} - these identify at least two alternatives to a situation and compare them with what actual happens\\
+ (e.g. \textcolor{HBRS}{``Does bioethanol produce less greenhouse gas than diesel?''})
+ \item \textbf{Predictive} - constructing ``scenarios'' of how something might occur\\
+ (e.g. \textcolor{HBRS}{``Will molecule X be a strong protein binder?''})
+ \item \textbf{Problem solving} - propose solutions to existing problems\\
+ (e.g. \textcolor{HBRS}{``Does the use of a cover reduce evaporation from swimming pools?''})
+ \item \textbf{Paradoxical} - explore an apparently contradictory situation to make a suggestion for resolving the contradiction\\
+ (e.g. \textcolor{HBRS}{``How can we fertilize crops without creating algal blooms?''})
+ \item \textbf{Relationship} - if (and how) things are related to one another\\
+ (e.g. \textcolor{HBRS}{``Are X and Y related?''}, \textcolor{HBRS}{``What is correlated with X?''}, and\textcolor{HBRS}{\\``What causes X?''})
+ \item \textbf{Causality} - pushing the correlation concept further\\
+ (e.g. \textcolor{HBRS}{``Does X cause more Y under one condition than another?''})
+ \item \textbf{Solution Creation and/or Refinement} - propose a solution to an existing problem\\
+ (e.g. \textcolor{HBRS}{``What is an effective way to achieve X?''} and\\\textcolor{HBRS}{``Can we improve upon the way X is done?''})
+\end{itemize}
+% {\credit{Adapted from \url{https://www.scribd.com/document/358783254/Researchable-questions-and-Right-Answers-Activity}}} %\bibentry{Univ_Queensland_research_question
+% \cite{Feldt2010}}
+
+\paragraph{Examples and how to improve}\mbox{}
+\begin{itemize}
+ \item Too narrow: \textcolor{HBRS}{``What is the childhood obesity rate in NRW, Germany?''} (Simple quantitative answer.)
+ \item Less narrow: \textcolor{HBRS}{``How does the education level of the parents impact childhood obesity rates in NRW, Germany?''} (Data allows you to draw a conclusion.)
+ \bigskip
+ \item Too objective: \textcolor{HBRS}{``How much time do young children spend doing physical activity per day?''} (What is the data going to say?)
+ \item More subjective: \textcolor{HBRS}{``What is the relationship between physical activity levels and childhood obesity?''} (Correlation)
+\end{itemize}
+% {\credit{Adapted from https://cirt.gcu.edu/research/developmentresources/tutorials/question}}
+
+\subsubsection{Hypothesis}
+A hypothesis
+\begin{itemize}
+ \item is used when a large body of work already exists
+ \item usually makes a \textbf{prediction} of the relationship between two variables
+ \item are considered to be more precise than a research question
+\end{itemize}
-Lorem ipsum dolor sit amet, consectetur adipiscing elit \cite[SS. 35-40]{Becker2008}. Donec venenatis ultrices convallis \cite{Jones2013, MilaniSRCL2009}. \glqq Integer sagittis vel purus nec molestie\grqq{} \cite{Jones2013b}. Nullam dictum fermentum egestas. Sed erat sapien, eleifend ut accumsan non, rutrum vel sem. Aenean dignissim velit quis consequat faucibus \cite{OConnorH2009}. Etiam aliquet non tellus vitae tristique. Integer euismod volutpat sem at commodo (see \cite{Smith2016}). Pellentesque rhoncus nibh non mauris scelerisque, a fringilla arcu sodales. Curabitur vel libero nec massa lacinia varius \cite[Kapital ~2]{R-base}. Morbi non facilisis nisi. Lorem ipsum dolor sit amet, consectetur adipiscing elit \cite{sublime}.
+\noindent \textbf{Example}: ``Reading English is positively correlated with a student's grade.''
+
+\bigskip
+\noindent Hypothesis:
+\begin{itemize}
+ \item A proposed explanation for a phenomenon.
+ \item It is considered more ``scientific'' (i.e. it must be testable)
+ \item Must be a statement
+ \item Provides a bridge between \textit{theory}, \textit{observables} and \textit{practice}
+ \begin{itemize}
+ \item How variables (theory) affect (i.e. influences) an observable
+ \item Perform experiments that test the theory (practice)
+ \end{itemize}
+\end{itemize}
+
+
+\paragraph{Hypothesis examples}\mbox{}
+\begin{description}
+ \item [\textbf{\textcolor{HBRS}{Not too good}}] Device X will perform better than all other devices.
+ \item [\textbf{\textcolor{HBRS}{Not too good}}] Device X will help to discover some underlying aspect of something.
+ \item [\textbf{\textcolor{HBRS}{Better}}] Device X in the process of Y will help doctors perform Z more rapidly, with higher success rates than M.
+ \item [\textbf{\textcolor{HBRS}{Good}}] A robotic hand can be designed and fabricated that will mimic the natural hand with sufficient accuracy to perform more delicate error-free surgeries.
+\end{description}
+% {\credit{\bibentry{Antonsson1987}}}
-Quisque nisl est [\textit{sic}], rutrum nec eros facilisis, malesuada scelerisque diam. Quisque dictum suscipit aliquet. Ut faucibus faucibus erat tristique porta. Aenean dictum semper nulla, sit amet facilisis orci venenatis. At vero eos et accusam et justo duo dolores in:
-%% For direct quotation with multiple sentences - use the quote environment
+\paragraph{Hypothesis example - improving it}\mbox{}
+\begin{description}
+ \item [\textbf{\textcolor{HBRS}{Poor}}] ``Water levels affect the amount of lice suffered by rainbow trout.''
+ \begin{itemize}
+ \item No guidance towards how to design the research \vfill
+ \end{itemize}
+
+ \item [\textbf{\textcolor{HBRS}{Better}}] ``Rainbow trout suffer more lice when water levels are low.''
+ \begin{itemize}
+ \item Some direction, but not really testable \vfill
+ \end{itemize}
+
+ \item [\textbf{\textcolor{HBRS}{Best}}] ``Rainbow trout suffer more lice in low water conditions because there is less oxygen in the water.''
+ \begin{itemize}
+ \item Established variables that are testable
+ \end{itemize}
+\end{description}
+% {\credit{https://explorable.com/how-to-write-a-hypothesis}}
+
+
+
+\bigskip
+\par\noindent\rule{\textwidth}{1.2pt}
+% Below are some helpful examples for you to refer to
+\paragraph{Examples for Citations}\mbox{}\\
+
+%% Indirect and short direct quotations.
+A sentence with one citation \citep{sublime}. An example of a sentence with two citations \citep{Jones2013, MilaniSRCL2009}. This is how one would cite a reference with its page numbers \citep[pp. 35-40]{Becker2008}. This is an example with reference number and chapter \citep[Chap.~2]{R-base}. One can also refer the reader to more information \citep[see][]{Smith2016}. ``This is a quoate example'' \citep{Jones2013b}. A block quote can be given in the following manner:
+
\begin{quote}
-Lorem ipsum dolor sit amet [writing is fun], consetetur sadipscing elitr ... sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. \cite[S. 23]{Smith2016}
+Lorem ipsum dolor sit amet [writing is fun], consetetur sadipscing elitr ... sed diam nonumy eirmod temp [sic] invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. \citep[p. 23]{Smith2016}
\end{quote}
\noindent
-Citing an article written by one author \cite{Giddings2008}. \\
-Citing an article written by two authors \cite{OConnorH2009}. \\
-Citing an article written by three or more authors \cite{BlischakDW2016}. \\
-Citing multiple articles for one topic \cite{Giddings2008, OConnorH2009, BlischakDW2016} \\
-Citing a book \cite{Becker2008}. \\
-Citing an article from a conference proceedings \cite{MilaniSRCL2009}. \\
-Citing a chapter within a book \cite{EasterbrookSSD2008}. \\
-Citing a master thesis \cite{Smith2016}. \\
-Citing a program that has no formal citation, but a webpage \cite{sublime} \\
-Citing a webpage \cite{Wikipedia-OganizationalEthics2017}. \\
-Citing a personal communication \cite{Jones2013}.
-
-\section{Unterkapitel -- Gleichungen und Listen}
-\subsection{Unterunterkapitel -- Gleichungen}
+Citing an article written by one author \citep{Giddings2008}. \\
+Citing an article written by two authors \citep{OConnorH2009}. \\
+Citing an article written by three or more authors \citep{BlischakDW2016}. \\
+Citing multiple articles for one topic \citep{Giddings2008, OConnorH2009, BlischakDW2016} \\
+Citing a book \citep{Becker2008}. \\
+Citing an article from a conference proceedings \citep{MilaniSRCL2009}. \\
+Citing a chapter within a book \citep{EasterbrookSSD2008}. \\
+Citing a master thesis \citep{Smith2016}. \\
+Citing a program that has no formal citation, but a webpage \citep{sublime} \\
+Citing a webpage \citep{Wikipedia-OganizationalEthics2017}. \\
+Citing a personal communication \citep{Jones2013}.
+
+\paragraph{Special Author Notations Within a Quote}\mbox{}\\
+
+In the above section there is a long quote that is offset from the rest of the writing. This is how presents a long quote, even though there are no quotation marks present. Within that quote there are special notations that the author has added to communicate to the reader. These are the following:
+
+\begin{description}
+ \itemsep=0.0em
+ \itemindent=0.5cm
+ \item[[sic]] - indicates something was incorrectly written or said in the original quote
+ \item[...] - indicates that something is being left out on purpose
+ \item[[new words]] - indicates that words were inserted, which were not originally present
+\end{description}
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Chapter: Methodology
+
+\chapter{Methodology} %% Remove and Materials if it doesn't apply.
+
+\paragraph{General Guide to Writing the Methodology}\mbox{}\\
+
+The Methodology section is where you establish the credibility for your results. Enough information shoudl be provided that enables someone else to
+\begin{enumerate}
+ \item reproduce your results, and
+ \item can assess if the approach and tools used are appropriate and state-of-the-art.
+\end{enumerate}
+
+The Methodology is written in the past tense.
+
+\section{Examples: Equations}
%% Equations using inline mode - not numbered
-Mathematische Gleichungen können innerhalb eines Satzes geschrieben werden, und ohne entsprechende Referenznummer: $E=mc^2$. Oder Gleichungen können in einem Anzeigemodus (Gleichungen \ref{eq.one}--\ref{eq.matrix}) mit entsprechender Referenznummer angegeben werden (z.B. Gleichung \ref{eq.one}). Die Gleichungen können komplexer werden. Zum Beispiel können sie mehrere Zeilen (d.h. Split) und Ausrichtungen (dh das \& Zeichen) innerhalb des Latexcodes enthalten (z.B. Gleichungen \ref{eq.two}--\ref{eq.three} or \ref{eq.main}). \\
+
+Math equations can be written within a sentence, and without a corresponding reference number: $E=mc^2$. Or equations can be given in a display mode (Equations \ref{eq.one}--\ref{eq.matrix}) that has a corresponding reference number (see Equation \ref{eq.one}). The equations can become more complex. For example, they can include multiple lines (i.e. split) and alignments (i.e. the \& sign) within the latex code (e.g. Equations \ref{eq.two}--\ref{eq.three} or \ref{eq.main}). \\
%% Note that the equation label is completely up to you.
\begin{equation}
3\times\frac{1}{2}=1\frac{1}{2}
- \label{eq.one}
+ \label{eq.zero}
\end{equation}
%% Using sfac
\begin{equation}
3\times\sfrac{1}{2}=1\sfrac{1}{2}
- \label{eq.one_v2}
+ \label{eq.one}
\end{equation}
%% Alignment equations using &, with mulitple reference numbers
@@ -246,7 +341,7 @@ Mathematische Gleichungen können innerhalb eines Satzes geschrieben werden, und
& = 2x + 1 \label{eq.three}
\end{align}
-%% Use ``split'' to create multiple lines, align equantion on &, but only report one reference number
+%% Use "split" to create multiple lines, align equantion on &, but only report one reference number
\begin{equation}
\begin{split}
\Delta E^{CBS}_{e} = & \frac{2}{3} \left( E_{\text{Part1}} - \sum_{1}^{n} E_{\text{Part2}}^{\frac{1}{2}} \right) + \\
@@ -265,45 +360,109 @@ Mathematische Gleichungen können innerhalb eines Satzes geschrieben werden, und
\label{eq.matrix}
\end{equation}
-\subsection{Unterunterkapitel / Subsubsection -- Listen / List of Items}
-Sie können eine numerische Liste wie die folgende verwenden: \\
+\section{Examples: Lists}
+
+\noindent You can have a numeric list, such as the following:
\begin{enumerate}
- \item Erster Gegenstand
- \item Zweiter Gegenstand
+ \item First item
+ \item Second item
\end{enumerate}
-\noindent Oder eine Aufzählungspunktliste, wie die folgende: \\ %% Notice the \noindent
+\noindent Or a bullet point list, such as the following: \\
\begin{itemize}
- \item Erster Gegenstand
- \item Zweiter Gegenstand
+ \item First item
+ \item Second item
\end{itemize}
-\noindent Oder eine benutzerdefinierte Liste, wie die folgende: \\
+\noindent Or a customized list, such as the following:
\begin{description}
- \item[1$^{st}$:] Erster Gegenstand
- \item[$\alpha$:] Zweiter Gegenstand
+ \item[1$^{st}$:] First item
+ \item[$\alpha$:] Second item
\end{description}
+\noindent Now, modifying the spacing and indentation:
+\begin{itemize}
+ \itemsep=-0.5em
+ \itemindent=1.5cm
+ \item First item
+ \item Second item
+\end{itemize}
+
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%% Kapitel 3
+%% Chapter: Results
+
+\chapter{Results}
-\chapter{Ergebnisse}
+\paragraph{General Guide to Writing the Results}\mbox{}\\
+The results section is the core of your thesis, and is focused on data. In this section you present (but not interpret) the data that you generated during your research. If you have qualitative or simple quantitative (e.g. 1 or 2 numbers) results, then then information can be presented through sentences. For more complicated results, one should use tables and figures. To start this section, the first thing to do is to create a draft of the figures and tables. \textcolor{HBRS}{Tip}: create dummy data on that mimics what you think the final data will look like - this allows you to create a template for your tables and figures prior to having the final data.
-In diesem Abschnitt präsentieren wir Ihre Daten, Tabellen und Abbildungen. Vermeiden Sie es hier, Daten zu interpretieren; dazu dient das nächste Kapitel. \\
+\bigskip
+\textbf{When to Use Tables}
+\begin{itemize}
+ \item when working with numbers
+ \item when the focus is on individual data values
+ \item when the accuracy or precision of specific data is important
+\end{itemize}
+
+\bigskip
+\textbf{When to Use Figures}
+\begin{itemize}
+ \item when working with a shape or picture
+ \item when the focus should be on an overall pattern
+ \item when the accuracy or precision of data is unimportant
+\end{itemize}
+
+\bigskip
+Initially be comprehensive is the data reporting, and then reduce amount by transferring less important or relevant data to the Appendix. This chapter will naturally undergo several revisions, especially as you improve your thoughts (often due to writing the Discussion section) about how the data should be presented in the tables and figures. Identify, from your results, a clearly connected story that leads to a ``take-home-message'' that you can write about in the Discussion and Conclusion sections. \textcolor{HBRS}{Tip}: write one, two or three short summary statements based on your initial analysis/thoughts of your figures and tables (devote time to this) - use these statements to \textcolor{HBRS}{direct} the Results \& Discussion's \textcolor{HBRS}{focus}; you might also need to revisit the focus of the Introduction.\\
-\section{Unterkapitel -- Abbildungen}
-Bilder sind manchmal gut für die Darstellung komplexer Informationen (z.B. Abbildung \ref{fig:one}). \\
+The verb tense within the Results can be the following (yes, one can use all three in single written piece):
+\begin{enumerate}
+ \item Paste tense
+ \begin{itemize}
+ \item to focus on the completed study (what was done and found)
+ \item active or passive voice\\
+ passive example: ``To observe the behavior for simulations of larger sizes, additional models \textbf{were executed} with ... The resulting from the larger models are shown in ...''
+ \end{itemize}
+ \item Present tense
+ \begin{itemize}
+ \item to describe an ''always true'' situation\\
+ ``This data directly \textbf{correlates} with the faster GPU processing power.''
+ \item when the sentence focuses on the document\\
+ ``The final image classification in Figure 4 \textbf{shows} ...''
+ \end{itemize}
+ \item Modal verb (e.g. may, might, can, could, will, would, shall, should )
+ \begin{itemize}
+ \item often use to ``hedge'' a statement - to make it contains some uncertainty
+ \item often used in ``that'' clauses \\
+ ``The increase values \textbf{may be} related to ...''
+ \end{itemize}
+% \credit{\bibentry{CargillO2013}}\\
+% \credit{\bibentry{Hyland1994}}
+\end{enumerate}
+
+\section{Examples: Sentences}
+In general, you want to a) introduce, b) locate and, sometimes, c) highlight the data that you present. The following sentences will exemplify these ideas:
+
+\begin{itemize}
+ \item ``Figure 1 provides a diagram of the resulting apparatus configuration.''
+ \item ``The mean and standard deviations are provided in Table 1. As seen, the values of X are twice the magnitude of those from Y.''
+ \item ``The overall statistical analysis of the raw data can be found in Tables 1-2. Overall, the data showed high precision, with little outliers present. Those that were outliers predominately come from the X dataset.''
+\end{itemize}
+
+\section{Examples: Figures}
+Images are good for representing complex information (e.g. Figure \ref{fig:one}).
\begin{figure}[h!]
\centering
\captionsetup{justification=centering}
\includegraphics[height=2cm]{fhlogo}
- \caption{Untertitel für diese Abbildung.}
+ \caption{Caption for this figure.}
\label{fig:one}
\end{figure}
-Zwei Bilder können zu einer Abbildung kombiniert werden (z. B. Abbildung \ref{fig:two}). \\
+Two pictures can be combined into one figure (e.g. Figure \ref{fig:two}).
\begin{figure}[h!]
\centering
@@ -311,26 +470,18 @@ Zwei Bilder können zu einer Abbildung kombiniert werden (z. B. Abbildung \ref{f
\subfloat[Subcaption 1]{\includegraphics[width=0.2\hsize]{fhlogo}}
\hspace*{0.1\hsize}
\subfloat[Subcaption 2]{\includegraphics[width=0.2\hsize]{fhlogo}}
- \caption{Untertitel für diese Abbildung.}
+ \caption{Caption for this figure.}
\label{fig:two}
\end{figure}
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%% Kapitel 4 || Chapter 4
-
-\chapter{Diskussion}
-
-In diesem Abschnitt interpretieren Sie Ihre Daten, diskutieren die Implikationen und wie die neuen Erkenntnisse verwendet werden können. Ggf.\ können Sie hier auch ansprechen, was nicht funktioniert hat, oder spezifische Schwierigkeiten beschreiben und wie Sie diese überwunden haben. \\
+\section{Examples: Tables}
-\section{Unterkapitel}
-
-Einfache Tabellen (z.B. Tabelle \ref{tab:example_1}) können in LaTeX mit der Tabellen-Umgebung und tabellarischen Befehlen erstellt werden. Die Einrückungen innerhalb des \LaTeX-Codes selbst dienen nur der übersichtlichkeit für Sie -- sie wirken sich nicht auf das Ergebnis aus. \\
+Simple tables (e.g. Table \ref{tab:example_1}) can be made using the table and tabular commands. The indentations within the \LaTeX{} code itself is only for your ease of reading -- it does not affect the result.
%% Example of a simple table, without any special loaded libraries
\begin{table}[h!]
\captionsetup{justification=centering}
- \caption{Beschriftung steht über der Tabelle. \\
- In der Regel ist es günstig, sehr lange Beschriftungen zu vermeiden. \\
+ \caption{Table one's caption goes above. \\
And look at what you can do to a very long caption!}
\label{tab:example_1}
\centering
@@ -346,20 +497,20 @@ Einfache Tabellen (z.B. Tabelle \ref{tab:example_1}) können in LaTeX mit der Ta
\end{tabular}
\end{table}
-\noindent Eine komplexere Tabelle kann auch gebildet werden (z. B.Tabelle \ref{tab:example_2}). \\
+\noindent A more complex table can also be formed (e.g.Table \ref{tab:example_2}).
%% Example of a more complex table, using threeparttable
\begin{table}[!ht]
\centering
\begin{threeparttable}
- \captionsetup{font=normalsize,labelfont=bf,labelsep=period}
- \caption{Tabellenbeschriftung steht oberhalb der Tabelle.}
+ \captionsetup{font=normalsize, labelfont=bf, labelsep=period}
+ \caption{Table two's caption goes above.}
\label{tab:example2}
\normalsize
\label{tab:example_2}
\begin{tabular}[c]{l | cc || cc}
\toprule
- & \multicolumn{2}{c ||}{\textbf{Main Header 1\tnote{a}}} & \multicolumn{2}{c}{\textbf{Main Header 2\tnote{a}}}\\
+ & \multicolumn{2}{c ||}{\textbf{Main Header 1\tnote{a}}} & \multicolumn{2}{c}{\textbf{Main Header 2\tnote{b}}}\\
& \textbf{Subheader $\alpha$} & \textbf{Subheader $\beta$} & \textbf{Subheader $\gamma$} & \textbf{Subheader $\zeta$}\\
\midrule
\textbf{Item 1} & 1.0 & 2.0 & 3.0 & 4.0\\
@@ -382,18 +533,58 @@ Einfache Tabellen (z.B. Tabelle \ref{tab:example_1}) können in LaTeX mit der Ta
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%% Kapitel 5 || Chapter 5
+%% Chapter: Discussion
+
+\chapter{Discussion}
+
+\paragraph{General Guide to Writing the Discussion}\mbox{}\\
+In this section you should interpret your data, discuss the implications and how the new findings can be used. One can also include what did not work, or specific difficulties and they were overcomed. Structurally, the discussion starts off focused on specific results and ends with comments concerning how the results might affect a broader perspective.
+
+A Discussion section can, but not necessarily, contain the following:
+\begin{enumerate}
+ \item Reference to the main purpose or hypothesis of the study, or summarize the main activities of study
+ \item \textbf{How you interpret the figures and tables} (i.e. the data) with respect to the underlying story that you are telling
+ \item \textbf{Drawn conclusions and an explanation of your finding}, and supported by references
+ \item \textbf{Limitation of the study}
+ \item Source of error (approximations, datasets) and their potential impact on the results and interpretation
+ \item Implication to the broader field (i.e. the bigger picture)
+ \item Recommended future research (alternatively, this can be in the Conclusion)
+\end{enumerate}
+Note that items 2--5 can occur multiples times for each grouping of results that you have.\\
-\chapter{Zusammenfassung und Ausblick}
-ca. 1-3 Absatz \\
+The Discussion is written in the present tense, with modal verbs to modulate the strength of your interpretations:
+
+\begin{itemize}
+ \item{Present}
+ \begin{itemize}
+ \item ``The results of this benchmark study \textbf{confirms} that ...''
+ \item Choose your verb to reflect the confidence in your data interpretation, for example:\\
+ ``This data \textbf{demonstrates} a direct correlation between ...''\\
+ vs.\\
+ ``This data \textbf{suggest} a correlation between ...''
+ \end{itemize}
+ \item{Modulate the strength of you claims by}:
+ \begin{itemize}
+ \item Using modal verbs (e.g. may be, might be), for example\\
+ ``Further work on optimization could decrease the growth and therefore \textbf{might allow} larger networks to be interactively simulated.''
+ \end{itemize}
+\end{itemize}
-In diesem Abschnitt sollen das Projekt mit der zugrunde liegende Hypothese bzw. den Zielen sowie die Ergebnisse auf der Grundlage Ihrer Interpretation der Daten zusammengefasst werden. Sie sollten auch erwöhnen, was die nächsten Schritte sein sollten, um das Projekt in Zukunft fortzusetzen. \\
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%% Literaturverzeichnis
+%% Chapter: Conclusion
+
+\chapter{Conclusion}
+
+\paragraph{General Guide to Writing the Discussion}\mbox{}\\
+In this section you should summarize your research project; its research question, hypothesis or goals; and your interpretation of the data. You could also include what might be the next steps for continuing the project. The Conclusion is usually a few paragraph long.
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Bibliography
\cleardoublepage
-\addcontentsline{toc}{chapter}{Literaturverzeichnis}
+\addcontentsline{toc}{chapter}{Bibliography}
%% Harvard style citations with alphebetically sorted bibliography
%% Must be used with \usepackage[sort&compress]{natbib} in the document preamble
@@ -402,25 +593,23 @@ In diesem Abschnitt sollen das Projekt mit der zugrunde liegende Hypothese bzw.
%% Vancouver style citations with bibliography sorted by appearance of reference
%% Must be used with \usepackage[sort&compress,numbers]{natbib} in the document preamble
-%% babplain (e.g. und, Seiten) vs. plain (e.g. and, pages)
-\bibliographystyle{babunsrt-lf}
-
-% \bibliographystyle{IEEEtran} % a common used one in engineering
+\bibliographystyle{ieeetr} % a common used one in engineering
% \bibliographystyle{unsrtnat}
+% \bibliographystyle{plain}
\bibliography{literatur}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%% Anhang || Appendix
+%% Appendix
\cleardoublepage
-\addcontentsline{toc}{chapter}{Anhang}
+\addcontentsline{toc}{chapter}{Appendix}
\begin{appendix}
-\chapter{Anhang Thema A Titel}
-In diesem Abschnitt können Sie zusützliche Informationen, hilfreiche Scripts/Code, Tabellen und Abbildungen platzieren. In der Regel dient dies zur Ergänzung oder Erläuterung von Informationen im Hauptteil Ihrer Arbeit. Ein Beispiel dafür könnten im Hauptteil nicht dargestellte Daten sein (z. B. x,y,z-Koordinate im kartesischen Raum). überlegen Sie, was hilfreich sein könnte für den Leser und womöglich auch für Studenten, die zukünftig an diesem Thema arbeiten. \\
+\chapter{Appendix Topic A Title}
+In this section you can add additional information, helpful scripts/code, tables and figures. Usually this is information elaborates upon or clarifies something within the main body of your thesis. An example of this could be unprocessed data (e.g. x,y,z coordinate in Cartesian space). Consider what could be helpful to the reader and to future students who work on this topic.
-% \chapter{Anhang Thema B Titel} %% Use if needed
+% \chapter{Appendix Topic B Title} %% Use if needed
\end{appendix}
--
GitLab