A pandoc LaTeX template for creating a PhD thesis in markdown and LaTeX.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

182 lines
6.5 KiB

3 years ago
# LaTeKiSS
**LaTeKiSS** è un template *[pandoc][]* per tesi di laurea. Il suo obbiettivo è sollevare gli studenti dall'impaginazione, in modo da concentrarsi esclusivamente sul contenuto della tesi.
3 years ago
*LaTeKiSS* è realizzato in modo da essere quanto più possibile *LaTex-free* per l'utente finale.
Lo studente, così, potrà scrivere la sua tesi in *markdown* e inserire le informazioni extra tramite un file `.yaml`.
3 years ago
Nella seguente guida è specificato come adattare il template alle proprie necessità e come ottenere il documento finale.
3 years ago
Questo template usa il pacchetto LaTeX [ClassicThesis][classicthesis] realizzato da André Miede.
3 years ago
---
## Guida
### Installazione
- Installare pandoc e una distribuzione LaTeX.
- Scaricare l'ultima versione di questo tema dalla pagina delle release.
- Copiare il file `latekiss.tex` nella cartella dei template e rinominarlo in `latekiss.latex`. La cartella dei template varia a seconda del sistema operativo.
- Unix, Linux, macOS: `~/.pandoc/templates/`
- Windows XP: `C:\Documents And Settings\USERNAME\Application Data\pandoc\templates`
- Windows Vista o superiore: `C:\Users\USERNAME\AppData\Roaming\pandoc\templates`
### Utilizzo
Una volta installato tutto il materiale necessario sarà specificare l'utilizzo del tema *LaTeKiSS* durante la compilazione tramite pandoc.
Per esempio nel caso in cui l'intera tesi sia stata scritta all'interno del file `thesis.md` è possibile ottenere il documento formattato in pdf attraverso il seguente comando.
```bash
pandoc thesis.md -o thesis.pdf --template latekiss
```
Nella cartella `samples` sono disponibili alcuni esempi di utilizzo.
#### Configurazioni consigliate
Al fine di ottenere un risultato migliore è consigliabile utilizzare il flag `--top-level-division chapter` e la variabile `numbersections` settata a `true`.
Con queste nuove configurazioni il comando per la compilazione è il seguente.
```bash
pandoc arsclassica.md -o arsclassica.pdf --top-level-division chapter -V numbersections --template latekiss
```
#### Link
I link e i riferimenti sono in nero di default, e possibile abilitare il colore andando a settare la variabile `colorlinks` a `true`.
È possibile cambiare i colori di default andando a settare le variabili `linkcolor`, `filecolor`, `citecolor`, `urlcolor`.
#### Riferimenti
È possibile gestire i vari riferimenti attraverso il filtro [pandoc-crossref][].
#### Bibliografia
È possibile gestire la bibliografia attraverso il flag `--citeproc`.
#### Compilazione degli esempi
Di seguito è riportato il comando utilizzato per compilare gli esempi forniti nella cartella samples.
Rispetto al comando precedente in questo caso sono si è utilizzato `pandoc-crossref`, `pandoc-citeproc` e le configurazioni consigliate.
```bash
pandoc --template latekiss <input-file> -o <output-file> --top-level-division chapter -V numbersections -F pandoc-crossref --bibliography bibliography.yaml
```
3 years ago
### Variabili
- `abstract` (string)
3 years ago
abstract del documento
- `abstract-title` (string)
3 years ago
titolo della pagina dell'abstract
- `academic-year` (string)
3 years ago
anno accademico
- `acronym` (lista)
- `short`(string)
nome breve dell'acronimo
- `long` (string)
nome lungo dell'acronimo
- `ac-title` (string)
3 years ago
titolo della pagina degli acronimi
- `ac-onlyused` (boolean)
stampa solo gli acronimi utilizzati nel testo. Falso come valore di default
- `ac-smaller` (boolean)
stampa gli acronimi con un font più piccolo
- `ac-footnote` (boolean)
stampa il nome lungo dell'acronimo come nota a piè di pagina
- `ac-nohyperlinks` (boolean)
gli acronimi non presentano gli hyperlink
- `ac-withpage` (boolean)
nella lista degli acronimi viene aggiunta la pagine di primo utilizzo.
Per un corretto funzionamento utilizzare anche `ac-onlyused`
- `acknowledgments `(string)
3 years ago
ringraziamenti
- `acknowledgments-title `(string)
3 years ago
titolo della pagina dei ringraziamenti
- `author` (string)
3 years ago
nome e cognome dell'autore
- `babel` (string)
3 years ago
lingua del pacchetto babel
- `bibliography `(string)
3 years ago
path del file .bib
- `copyright` (string)
3 years ago
messaggio di copyright
- `course` (string)
3 years ago
il corso di laurea che si sta frequentando
- `dedication `(string)
3 years ago
dedica
- `dedication-title` (string)
3 years ago
titolo della pagina di dedica
- `department` (string)
3 years ago
il dipartimento a quale afferisce il corso di laurea
- `draf` (string)
3 years ago
versione della bozza. Da non specificare nel documento finale
- `eulerchapternumber` (boolean)
usa il font AMS Euler per il numero del capitolo. Palatino come font di default
- `floatnumbering` (boolean)
usa la numerazione float per le figure e le altre risorse. False come valore di default
- `fontsize `(string)
3 years ago
grandezza del carattere. 11pt come valore di default
- `colorlink`(boolean)
se impostato i link appaiono colorati. Falso come valore di default
- `institute `(string)
3 years ago
l'istituto al quale si è iscritti
- `keywords` (lista di string)
3 years ago
lista con le parole chiave del documento
- `lineheaders` (boolean)
aggiunge una linea di separazione tra il numero del capitolo e il nome del capitolo. Falso come valore di default
- `logo` (string)
3 years ago
path del logo dell'università
- `matr` (int)
3 years ago
matricola dell'autore
- `openright` (boolean)
3 years ago
il capitolo inizia sempre alla pagina destra. Falso come valore di default
- `papersize` (string)
3 years ago
grandezza del foglio. A4 come valore di default
- `quote` (string)
3 years ago
citazione
- `quote-author` (string)
3 years ago
autore della citazione
- `subject` (string)
3 years ago
oggetto della tesi
- `subtitle `(string)
3 years ago
sottotitolo della tesi
- `supervisor`
- `name` (string)
3 years ago
nome del relatore
- `title` (string)
3 years ago
titolo del relatore
- `style` (string)
consente di impostare lo liste della tesi tra classicthesis e arsclassica. classicthesis come valore di default
- `title` (string)
3 years ago
titolo della tesi
- `toc` (boolean)
3 years ago
include l'indice
3 years ago
- `toc-aligned` (boolean)
allinea l'indice. False come valore di default
- `toc-depth` (int)
3 years ago
configura la profondità dell'indice. Due come valore di default
- `toc-dotted` (boolean)
allinea i numeri di pagina a destra aggiungendo i puntini. False come valore di default
- `toc-title` (string)
3 years ago
configura il titolo dell'indice
- `lof` (boolean)
3 years ago
include l'indice delle figure
- `lof-title` (string)
3 years ago
configura il titolo dell'indice delle figure
- `lot` (boolean)
3 years ago
include l'indice delle tabelle
- `lot-title` (string)
3 years ago
configura il titolo dell'indice delle figure
- `twoside` (boolean)
3 years ago
se si desidera ottenere pagina destra e pagina sinistra. Falso come valore di default
[pandoc]: https://pandoc.org/
3 years ago
[classicthesis]: https://bitbucket.org/amiede/classicthesis/wiki/Home
[pandoc-crossref]: https://lierdakil.github.io/pandoc-crossref/