Skip to content

Commit

Permalink
Merge pull request #6 from mas-group/fix/chapters
Browse files Browse the repository at this point in the history
Modified the chapters so that they are independent subfiles
  • Loading branch information
argenos authored Sep 22, 2018
2 parents b916b69 + 0bdff67 commit b9bc71b
Show file tree
Hide file tree
Showing 13 changed files with 92 additions and 77 deletions.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@ The logo of an external institution can be added with the command `\thirdpartylo


## Usage
The main file of the report is `LastNameI-[RnD-MT]Report.tex`; this should be changed to match the naming convention specified by the wiki, e.g. for an R&D, John Doe would name his file `DoeJ-RnDReport.tex`.
The main file of the report is `report.tex`; chapters, appendices, and the abstract are given in separate files in the `chapters` directory.

When submitting a report, the name of the pdf should be changed to match the naming convention specified in the MAS wiki, namely

```
LastNameI-[RnD-MT]Report
```

Examples: For an R&D, John Doe would name his file `DoeJ-RnDReport.pdf`; for a thesis, John Doe would name the file `DoeJ-MTReport.pdf`.

If there are any problems, don't hesitate to let us know! You can open an issue [here](https://github.com/mas-group/project-report/issues/new).
7 changes: 7 additions & 0 deletions chapters/abstract.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
%!TEX root = ../report.tex

\begin{document}
\begin{abstract}
Your abstract
\end{abstract}
\end{document}
16 changes: 7 additions & 9 deletions chapters/acknowledgment.tex
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %
% ACKNOWLEDGEMENT %
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\specialhead{ACKNOWLEDGMENTS}

ACK. ACK. ACK. here you can write your acknowledgements.
%!TEX root = ../report.tex

\begin{document}
\begin{acknowledgements}
Thanks to ....
\end{acknowledgements}
\end{document}
13 changes: 9 additions & 4 deletions chapters/appendix.tex
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
%!TEX root = ../report.tex
\chapter{Design Details}
Your first appendix

\chapter{Parameters}
Your second chapter appendix
\begin{document}

\chapter{Design Details}
Your first appendix

\chapter{Parameters}
Your second chapter appendix

\end{document}
34 changes: 18 additions & 16 deletions chapters/ch01_introduction.tex
Original file line number Diff line number Diff line change
@@ -1,33 +1,35 @@
%!TEX root = ../report.tex

\chapter{Introduction}
\begin{document}
\chapter{Introduction}

\lipsum[1-5]
\section{Motivation}
\subsection{...}
\lipsum[1-5]
\section{Motivation}
\subsection{...}

\lipsum[6-10]
\lipsum[6-10]

\subsection{...}
\subsection{...}


\section{Challenges and Difficulties}
\subsection{...}
\section{Challenges and Difficulties}
\subsection{...}

\lipsum[11-15]
\lipsum[11-15]

\subsection{...}
\subsection{...}

\subsection{...}
\subsection{...}



\section{Problem Statement}
\subsection{...}
\section{Problem Statement}
\subsection{...}

\lipsum[21-30]
\lipsum[21-30]

\subsection{...}
\subsection{...}


\subsection{...}
\subsection{...}
\end{document}
12 changes: 7 additions & 5 deletions chapters/ch02_stateoftheart.tex
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
%!TEX root = ../report.tex

\chapter{State of the Art}
\begin{document}
\chapter{State of the Art}

\section{....}
Use as many sections as you need in your related work to group content into logical groups
\section{....}
Use as many sections as you need in your related work to group content into logical groups

Don't forget to correctly cite your sources \cite{art1}.
\section{Limitations of previous work}
Don't forget to correctly cite your sources \cite{art1}.
\section{Limitations of previous work}
\end{document}
13 changes: 8 additions & 5 deletions chapters/ch03_methodology.tex
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
%!TEX root = ../report.tex
\chapter{Methodology}

How you are planning to test/compare/evaluate your research.
Criteria used.
\begin{document}
\chapter{Methodology}

\section{Setup}
How you are planning to test/compare/evaluate your research.
Criteria used.

\section{Experimental Design}
\section{Setup}

\section{Experimental Design}
\end{document}
11 changes: 6 additions & 5 deletions chapters/ch04_solution.tex
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
%!TEX root = ../report.tex

\chapter{Solution}
\begin{document}
\chapter{Solution}

Your main contributions go here
Your main contributions go here

\section{Proposed algorithm}
\section{Proposed algorithm}


\section{Implementation details}
\section{Implementation details}
\end{document}
6 changes: 4 additions & 2 deletions chapters/ch05_evaluation.tex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
%!TEX root = ../report.tex

\chapter{Evaluation}
\begin{document}
\chapter{Evaluation}

Implementation and measurements.
Implementation and measurements.
\end{document}
13 changes: 7 additions & 6 deletions chapters/ch06_results.tex
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
%!TEX root = ../report.tex

\chapter{Results}
\begin{document}
\chapter{Results}

\section{Use case 1}
Describe results and analyse them
\section{Use case 1}

Describe results and analyse them

\section{Use case 2}

\section{Use case 2}

\section{Use case 3}
\section{Use case 3}
\end{document}
12 changes: 6 additions & 6 deletions chapters/ch07_conclusion.tex
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
%!TEX root = ../report.tex

\chapter{Conclusions}
\begin{document}
\chapter{Conclusions}

\section{Contributions}
\section{Contributions}

\section{Lessons learned}

\section{Lessons learned}


\section{Future work}
\section{Future work}
\end{document}
Binary file renamed LastNameI-[RnD-MT]Report.pdf → report.pdf
Binary file not shown.
22 changes: 4 additions & 18 deletions LastNameI-[RnD-MT]Report.tex → report.tex
Original file line number Diff line number Diff line change
Expand Up @@ -32,22 +32,12 @@
%----------------------------------------------------------------------------------------
% PREFACE
%----------------------------------------------------------------------------------------

\pagestyle{plain}


\cleardoublepage
\statementpage

\begin{abstract}
Your abstract
\end{abstract}


\begin{acknowledgements}
Thanks to ....
\end{acknowledgements}

\subfile{chapters/abstract}
\subfile{chapters/acknowledgment}

\tableofcontents
\listoffigures
Expand All @@ -56,7 +46,6 @@
%-------------------------------------------------------------------------------
% CONTENT CHAPTERS
%-------------------------------------------------------------------------------

\mainmatter % Begin numeric (1,2,3...) page numbering

\pagestyle{mainmatter}
Expand All @@ -69,14 +58,11 @@
\subfile{chapters/ch06_results}
\subfile{chapters/ch07_conclusion}


%-------------------------------------------------------------------------------
% APPENDIX
% APPENDICES
%-------------------------------------------------------------------------------

\begin{appendices}
\subfile{chapters/appendix}

\subfile{chapters/appendix}
\end{appendices}

\backmatter
Expand Down

0 comments on commit b9bc71b

Please sign in to comment.