This repository contains a LaTeX template to generate reports that are up to specification for the KGCOE departments.
- Can generate CMPE and EEEE reports
- Helper functions for common tasks (including graphics, ect.)
- Pandoc template for writing reports in Markdown
Run the following to install on ubuntu with texlive
./install.sh
or
Place the KGCOEReport.cls and imgs/RIT_Report.png class file in the same folder as the .tex document (image only needed for DIGIC)
If not installed in the tex path, then place the KGCOEReport.cls class file in the same folder as the .tex document
and use it as the document class with the department (or class) as an option:
\documentclass[CMPE]{KGCOEReport}
or
\documentclass[EEEE]{KGCOEReport}
or
\documentclass[DIGIC]{KGCOEReport}
The document must also contain proper variables containing the class
name, exercise number, and others.
Refer to the README.md and samples in the /docs folder
Reports can also be written in Markdown and converted to a LaTeX formatted PDF using Pandoc.
To use, install Pandoc,
copy the template and the class file into the same folder as the .md file,
and use the following command:
pandoc <lab file>.md --template=pandoc_full_template.tex -s -o <output file>.pdf
The file must contain a header defining the variables for the report.
Refer to the README.md and sample in the /docs folder
- Add helper commands for including images
- Figure out better way for variables than
\newcommand - Optional parameters