Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 3.04 KB

README.md

File metadata and controls

45 lines (31 loc) · 3.04 KB
Raw

DBS Assessments Template

This is a LaTeX template and document class for assessments at Dublin Business School. With this template, you can create assessments in a structured and appealing format. It includes pre-made sections, styles, and features that meet the requirements of Dublin Business School (As of November 2023).

Using the Template

To use this template, follow these steps:

  1. Click the green "Use this template" button at the top of this GitHub page to create a new repository based on this template.
  2. Clone the created repository to your computer.
  3. Customize the TitlePage LaTeX file (titlePage.tex) to include your assessment information.
  4. Insert images into the images folder and use the sections folder for your text. Name the text files according to the numbering (e.g., file-01.tex) to have them automatically inserted into the document.
  5. Create the assessment by compiling the assessment.tex using LaTeX.

Used Packages and Features

This template uses various LaTeX packages to facilitate the creation of assessments. Here are some of the packages used and their functions:

  • babel: Support for multiple languages.
  • biblatex: Allows source and citation management. The APA citation style is set as default but can be easily changed to other citation styles in the nak.cls file. More details can be found here.
  • hyperref: Generates hyperlinks within the document.
  • tikz: Creates diagrams and graphics.
  • listings: Embeds source code with syntax highlighting.
  • graphicx and subcaption: Inserts images with captions.
  • cleveref: Automatic references to chapters, figures, etc.
  • acronym: Manages acronyms.
  • threeparttable: For tables with footnotes.
  • Other packages for tables, fonts, and more.

Using Minted for Code (Optional)

This template provides the option to insert and format source code using the minted package. minted is a powerful package that offers syntax highlighting for various programming languages. To use this feature:

  1. Uncomment the relevant sections in the settings.cls and main.tex files.
  2. Install the required python-pygments package on your system (see here).
  3. Configure the code as per the instructions in the comments.
  4. Insert your source code into the prepared environment in the main.tex file.

For more details on using minted, see here.

Support

If you have any questions or issues with using this template, I am happy to assist. You can contact me through my GitHub page.