Merge pull request #6 from mas-group/fix/chapters

Modified the chapters so that they are independent subfiles
a2s-institute · Sep 22, 2018 · b9bc71b · b9bc71b
2 parents b916b69 + 0bdff67
commit b9bc71b
Show file tree

Hide file tree

Showing 13 changed files with 92 additions and 77 deletions.
diff --git a/README.md b/README.md
@@ -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).
diff --git a/chapters/abstract.tex b/chapters/abstract.tex
@@ -0,0 +1,7 @@
+%!TEX root = ../report.tex
+
+\begin{document}
+    \begin{abstract}
+        Your abstract
+    \end{abstract}
+\end{document}
diff --git a/chapters/acknowledgment.tex b/chapters/acknowledgment.tex
@@ -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}
diff --git a/chapters/appendix.tex b/chapters/appendix.tex
@@ -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}
diff --git a/chapters/ch01_introduction.tex b/chapters/ch01_introduction.tex
@@ -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}
diff --git a/chapters/ch02_stateoftheart.tex b/chapters/ch02_stateoftheart.tex
@@ -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}
diff --git a/chapters/ch03_methodology.tex b/chapters/ch03_methodology.tex
@@ -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}
diff --git a/chapters/ch04_solution.tex b/chapters/ch04_solution.tex
@@ -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}
diff --git a/chapters/ch05_evaluation.tex b/chapters/ch05_evaluation.tex
@@ -1,5 +1,7 @@
 %!TEX root = ../report.tex
 
-\chapter{Evaluation}
+\begin{document}
+    \chapter{Evaluation}
 
-Implementation and measurements.
+    Implementation and measurements.
+\end{document}
diff --git a/chapters/ch06_results.tex b/chapters/ch06_results.tex
@@ -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}
diff --git a/chapters/ch07_conclusion.tex b/chapters/ch07_conclusion.tex
@@ -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}
diff --git a/LastNameI-[RnD-MT]Report.pdf → report.pdf b/LastNameI-[RnD-MT]Report.pdf → report.pdf
diff --git a/LastNameI-[RnD-MT]Report.tex → report.tex b/LastNameI-[RnD-MT]Report.tex → report.tex
@@ -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
@@ -56,7 +46,6 @@
 %-------------------------------------------------------------------------------
 %	CONTENT CHAPTERS
 %-------------------------------------------------------------------------------
-
 \mainmatter % Begin numeric (1,2,3...) page numbering
 
 \pagestyle{mainmatter}
@@ -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