Inhoudsopgaven

• Inleiding

• Structuur

• Latex

• Issues

• Merge requests

Inleiding

Dit latex template kan gebruikt worden voor het schrijven van verslagen voor de minor Teaching Technology and Science en de Educatieve minor van de Hogeschool van Amsterdam (HvA).

Structuur

De verschillende bestanden en directories die in dit template worden gebruikt hebben verschillende doelen. De bestanden structuur wordt hier getoond.

├── LICENSE  
├── README.md  
├── hvaFoo.sty  
├── hvaTemplate.sty  
├── references.bib  
├── img/  
├── Logos/  
│   ├── HvA_compact_zwart_RGB.pdf  
│   └── HvA-Lerarenopleidingen-zwart-RGB.pdf  
└── report.tex

Bestanden structuur van de TTS-latexTemplate

De belangrijkste bestanden

• hvaFoo.sty
  Implementeert twee commando's, een commando om een lesplan formulier in te vullen en een commando om een observatie lesuitvoer in te vullen.
• hvaTemplate.sty
  Hierin staan een aantal standaard latex packages en wordt de pagina indeling mee opgezet. Daarnaast zorgt dit bestand er voor dat er een titel pagina/voorblad kan worden gegenereerd in een HvA stijl en kan er voor worden gekozen uit een tweetal copyrights.
• references.bib
  Hierin komen alle bibtex referenties te staan waarnaar wordt verwezen.
• report.tex
  Hierin wordt het verslag geschreven. Om het latex project in meerdere bestanden op te kunnen delen kan er bijvoorbeeld gebruik worden gemaakt van \input{<relative path to tex file>}.

De belangrijkste directories

• img/
  Bevat alle afbeeldingen die in het latex project worden gebruikt.
• Logos/
  Bevat alle afbeeldingen/logo's die door hvaTemplate.sty worden gebruikt.

Latex

Latex kan gebruikt worden voor het schrijven van verslagen en genereert op basis van de `.tex` bestanden een pdf. Het zogenaamd compileren van een latex bestand kan lokaal (op de eigen computer) gedaan worden als mede in de cloud.

Latex in de cloud compileren

De meest gebruiksvriendelijke manier om latex projecten te compileren voor een nieuwe gebruiker is door gebruik te maken van Overleaf. Om Overleaf te kunnen gebruiken moet je een gratis account aanmaken. Na het aanmaken van een nieuw project kunnen de bestanden van dit repository naar het nieuwe project worden geüpload en kan er verder worden gewerkt in de Overleaf omgeving.

Latex lokaal compileren

Het compileren van grotere projecten in Overleaf kost erg veel tijd en kan een reden zijn om een latex project lokaal te willen compileren. Er bestaan een aantal editors die hiervoor gebruikt kunnen worden.

• texstudio
• vscode met de latex-workshop extensie

De eisen voor de installatie is terug te vinden via de links hierboven en zal hier niet verder worden toegelicht.

Issues

Indien er een bug of fout is gevonden in dit repository wordt er vriendelijk verzocht hier een issue voor aan te maken. Het is fijn als er in een issue wordt beschreven wat het probleem is en hoe het probleem gereproduceerd kan worden.

Wanneer er een feature mist kan ook hiervoor een issue worden aangemaakt. Beschrijf in een dergelijk issue wat de gewenste feature is en waarom die nodig is.

Merge requests

Verbeteringen op deze template worden natuurlijk erg gewaardeerd. Als je een verbetering wilt maken is het de bedoeling dat je eerst een issue aanmaakt met daarin beschreven wat je beoogde verbetering inhoud waarna je bij een merge request naar de start issue kunt verwijzen. Op deze manier blijft het overzichtelijk om de veranderingen bij te houden.

Voordat een merge request wordt geaccepteerd zal er worden gekeken naar de aanpassingen van de merge request. Het is de bedoeling dat een merge request een enkel issue oplost. Als een merge request meerdere issues tegelijkertijd oplost zal deze worden geweigerd en moet de merge request worden opgesplitst in meerdere losse merge requests.