https://github.com/flytewizard/uvic-ecs-work-term-report
UVic ECS Work Term Report Template
https://github.com/flytewizard/uvic-ecs-work-term-report
co-op ecs overleaf template uvic work-term-report
Last synced: 3 months ago
JSON representation
UVic ECS Work Term Report Template
- Host: GitHub
- URL: https://github.com/flytewizard/uvic-ecs-work-term-report
- Owner: FlyteWizard
- License: mit
- Created: 2022-04-25T15:42:36.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-09-01T18:07:31.000Z (over 3 years ago)
- Last Synced: 2025-10-11T07:46:00.231Z (8 months ago)
- Topics: co-op, ecs, overleaf, template, uvic, work-term-report
- Language: TeX
- Homepage: https://www.overleaf.com/read/zrrbdkncbxhf
- Size: 3.53 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# UVic ECS Work Term Report - Template
A template following the [Computer Science Work Term Report Guidelines](./admin/computer-science-work-term-report-guidelines.pdf). The report is built using LaTeX and Overleaf.
- [Work Term Report](./work-term-report.pdf)
- [Letter of Transmittal](./letter.pdf)
## Overleaf
The report template can be copied and modified in Overleaf. To learn more about copying a project in Overleaf read "[Copying A Project](https://www.overleaf.com/learn/how-to/Copying_a_project)".
[https://www.overleaf.com/read/zrrbdkncbxhf](https://www.overleaf.com/read/zrrbdkncbxhf)
## Report Structure
The report structure is spilt up into sections. It also includes a template for the letter of transmittal.
The file `main.tex` is the entry point of the report. All the preamble and imports are within this file. If you want to add a section you'll need to include it in `main.tex`.
The file `bibliography.bib` is the bibliography. Add all your references to this file. Once they are include you can reference them within the report by using the `\cite{}` command. To learn more about BibLaTeX read "[Getting started with BibLaTeX
](https://www.overleaf.com/learn/latex/Articles/Getting_started_with_BibLaTeX)". The following tool is helpful in validating and formatting your BIB file: [BibTeX Tidy](https://flamingtempura.github.io/bibtex-tidy/).
The file `glossary.tex` is the glossary. You can add all your terms and acronyms to this file and then reference them within your report with `\gls{}`. You can learn more by reading the [Glossaries](https://www.overleaf.com/learn/latex/Glossaries) article on Overleaf.
The `sections` folder includes all the report sections (title, professional reflection, executive summary, introduction, discussion, conclusion, recommendation, acknowledgements, and appendix). In addition, there is a `discussion` folder. The folder splits up the discussion into readable parts. You can create a TEX file for each section heading within discussion.
The `figures` and `snippets` folders are for images and code files respectively.
And finally, the file `letter.tex` is the letter of transmittal. To include the letter in the report you'll need to compile the file into a PDF and upload it to the root folder. The template provides a compiled letter.
## LICENSE
MIT License
## Acknowledgements
The template is based on [https://github.com/trstephen/work-term-report](https://github.com/trstephen/work-term-report).
## Affliated Links
Overleaf allows users to refer a friend. You can learn more about referring a friend here: [Help us spread the word about Overleaf](https://www.overleaf.com/user/bonus).
- [Overleaf Referral Link](https://www.overleaf.com?r=CxCY1gVMJzbSHx3j&rm=d&rs=b)