AsciiDoc
“Quando la tipografia è curata, le parole diventano immagini.” Shawn Lukas
Introduzione
Questo modello per tesi fa uso di AsciiDoc, un formato di documenti più semplice e conciso rispetto a LaTeX, ma che genera comunque contenuto ricco e accattivante. È spesso usato per la documentazione tecnica. Scrivere la tua tesi in questo formato ti permette di semplificarti la vita.
Puoi usare questo progetto come modello per una nuova repository sul tuo profilo: basta cliccare su “Use this template” in alto a destra.
Prerequisiti
- Ruby
v2.7
o superiore; - Asciidoctor PDF.
Si consiglia l’installazione di un’estensione code editor che supporti Asciidoc.
Come Iniziare?
Per compilare il file di esempio tesi.adoc
utilizzare il comando:
asciidoctor-pdf -a pdf-fontsdir=fonts tesi.adoc
CI/CD
Cliccando su Actions in alto, potrai abilitare l’automatizzazione del progetto:
- Per ogni push su una PR diretta verso
main
, verrà controllato che la tua tesi compili correttamente; - Se avrai impostato Github Actions come
Settings
→Pages
→Build and depolyment
→Source
, a ogni modifica sumain
la tua tesi verrà pubblicata suhttps://<nome-utente>.github.io/<nome-repository>/tesi.pdf
.
Ricorda che se modifichi nome e percorso di tesi.adoc
o unibo.yml
, dovrai
modificare le tue Actions di conseguenza.
Personalizzazione
Asciidoc è il linguaggio che dovrai utilizzare, e puoi trovare qui la documentazione.
Asciidoctor PDF è il software che produrrà il .pdf
, e puoi trovare qui la
documentazione per
l’impaginazione.
🚸 Fai attenzione a modificare il file
unibo.yml
.L’indentazione è importantissima (2 spazi).
È vietato modificare l’estensione del file
unibo.yml
.
Files
Sezioni
Decoratori
Liste
La documentazione ufficiale per la struttura e lo stile:
- https://docs.asciidoctor.org/asciidoc/latest/lists/unordered/[Liste Generiche]
- https://docs.asciidoctor.org/asciidoc/latest/lists/unordered/[Liste Ordinate]
- https://docs.asciidoctor.org/pdf-converter/latest/theme/list/[Stile]
Offriamo diversi stili per le liste:
•
con il tipo [circle]
+
■
con il tipo [square]
+
❉
con il tipo [disc]
Esempio di lista generica:
[circle]
* Protons
* Electrons
* Neutrons
Esempio di lista ordinata:
1. Protons
2. Electrons
3. Neutrons
Se usi .
al posto dei numeri nella lista ordinata, i numeri
verrano inseriti automaticamente.
Immagini
Tabelle
Math Mode
Grafici
Syntax Highlighting
Bibliografia
La bibliografia si trova nel file bibliografia.adoc
.
Non è altro che una lista generica di elementi che cominciano
per * [[[segnaposto,Testo del segnaposto]]]
. +
Il segnaposto
prima della virgola è un codice che si può
utilizzare nel testo come referenza, il testo del segnaposto è
il testo che appare al posto del codice.
Numeri di Pagina
La sezione footer
nel file unibo.yml
controlla i numeri di
pagina
che sono pre-impostati al centro. Per impostarli sul lato esterno alla
rilegatura, sostituisci tutta la sezione footer
con questa:
footer:
height: 100
recto:
right:
content: "{page-number}"
verso:
left:
content: "{page-number}"
Risorse Esterne
Il font Computer Modern
è rilasciato in licenza SIL Open Font License.