Repositories:
See readme.txt for more information on the group and the
project's repositories.
The minutes of each group meeting are kept in reverse chronological order in the
file minutes.md.
Auxiliary notes for the project are kept in the file notes.md.
The slides for the presentation are in
doc/presentation.pdf, and their source in
doc/presentation.tex. A link to the video recording
of the presentation, accessible by TCD accounts, is included in the project
report.
The output of this project is the technical report
doc/report.pdf. Its source can be found in the file
doc/report.tex, which follows the given template in
resources/author.tex. The Biblatex bibliography
database for all documentation is in doc/rubik.bib.
The resources/author.tex template is distributed with
the Springer-Verlag TeX bundle
resources/ProcSci_TeX.zip. It requires
installing the included svproc.cls document class in the standard TeX inputs
locations, or in the same directory as the TeX document using it.
-
This project prefers the more modern
biblatexandbiberbibliography tools and dialects over their still traditional BibTeX counterparts. The former include more and better-formatted styles OOTB, and have better Unicode support. The main reason to prefer the latter is when conforming to a style that requires it. -
The report is encoded in UTF-8, which requires a modern TeX engine such as LuaTeX (recommended) or XeTeX (untested), both of which are included in the standard TeX Live distribution.
-
Automate your LaTeX compilations using a tool such as
latexmk. It is particularly helpful in later stages of the writeup when cross-references and bibliographies are involved.To configure
latexmkto use LuaLaTeX, for example, add the following to your~/.latexmkrcfile:# Use LuaLaTeX $pdf_mode = 4;
Then to compile the document
report.tex, just runlatexmk report.tex. -
The
mintedpackage makes it easy to include beautifully syntax-highlighted code listings.When compiling documents that use
minted, it is important to specify the LaTeX command-line option--shell-escape. Using thelatexmkexample from above, the resulting command would belatexmk --shell-escape report.tex. -
The
booktabspackage documentation includes a nice primer for typesetting beautiful tables, and thectablepackage provides a flexible interface.