GruppOne / project-docs

Documentazione di progetto per il capitolato C5 - Stalker del corso di Ingegneria del Software 2019/2020 @ UniPD

Repository principale per la documentazione di progetto

Badge

Compilazione dei documenti

LuaLaTeX

Per semplificare i problemi relativi a encoding dei file, utilizziamo LuaLaTeX che accetta UTF-8 di default.

I documenti possono essere generati utilizzando il comando:

lualatex \
  --interaction=nonstopmode \
  --c-style-errors \
  --shell-escape \
  file.tex

UML

I diagrammi PlantUML sono inclusi dopo uno step di pre-compilazione che trasforma il sorgente PlantUML in immagini.

Dopo aver scaricato l'archivio jar di PlantUML, impostare sul proprio sistema la variabile d'ambiente PLANTUML_JAR=/path/to/plantuml.jar ed eseguire il comando:

java \
  -jar $PLANTUML_JAR \
  -progress \
  -failfast \
  -checkmetadata \
  -charset UTF-8 \
  -x **/commons/style/*.pu \
  -o img \
  **/diagrams/*.pu

Syntax Highlighting

Utilizziamo il package minted, che richiede di avere nel proprio sistema la libreria python Pygments.