Errori tipici

Il punto nelle abbreviazioni spacing

Il punto finale di un'abbreviazione deve essere seguito da uno spazio forzato.

Prof. Nome Cognome // [!code --]
Prof.\ Nome Cognome // [!code ++]

La stessa cosa vale per le abbreviazioni come ecc.

Attenzione

Non usare etc. ma ecc..

Maiuscole degli elenchi puntati spacing

Gli elenchi puntati sono formattati in modo che il primo elemento di ciascun elemento sia minuscolo e che ogni elemento sia seguito da un punto e virgola. A meno che non si tratti di un elenco puntato in cui ogni elemento è una frase completa, in tal caso ogni elemento è seguito da un punto e da una lettera maiuscola.

elenco breve

Frase che precede l'elenco:
\begin{itemize}
  \item primo elemento;
  \item secondo elemento.
\end{itemize}

elenco lungo

Una frase che precede l'elenco:
\begin{itemize}
  \item Frase completa molto lunga che non può essere contenuta in una sola riga e che quindi va a capo;
  \item Frase che segue il primo elemento.
\end{itemize}

Notazione matematica

Equazioni e simboli matematici spacing

• Why is [ ... ] preferable to $$ ... $$?

Regola generale

• usa \[ ... \] per le equazioni e \( ... \) per le formule nel testo;

• Il pacchetto amsmath (caricato da mathtools) ridefinisce \[ come \begin{equation*} che è esattamente una forma non numerata dell'ambiente equation.

Due punti e colon spacing

• Using \colon or : in formulas?

Regola generale

• usa \colon quando sono un "due punti di punteggiatura";
• usa il simbolo : quando rappresenta una relazione tra ciò che è alla sua sinistra e ciò che è alla sua destra.

L'utilizzo principale di : è nella descrione degli insiemi, ad esempio

\{\, x \colon x \notin x \,\} // [!code --]
\{\, x : x \notin x \,\} // [!code ++]

Al contrario, il simbolo \colon dovrebbe essere utilizzato per le mappature

f: A \to B // [!code --]
f\colon A \to B // [!code ++]

Scrittura della matematica

Per la scrittura delle formule su una riga si utilizzano, erroneamente, le parentesi tonde (\( e \)), al posto dei dollari ($ e $).

corretto

Se consideriamo la variabile \(x\)... // [!code ++]

errato

Se consideriamo la variabile $x$... // [!code --]

Mentre per la scrittura delle formule in blocco si utilizzano, erroneamente, i doppi dollari ($$ e $$), al posto delle parentesi quadre (\[ e \]).

corretto

\[
    x_{1,2} = \frac{ -b \pm \sqrt{b^2 - 4ac}}{2a}
\]

errato

$$
    x_{1,2} = \frac{ -b \pm \sqrt{b^2 - 4ac}}{2a}
$$

Consigli per la scrittura

I consigli seguenti sono tratti da Technical writing — Alberto Montresor:

Definizione di nuovi termini

• When you define a new term for the first time, use \emph{} (corsivo). After that, do not use italics any more.

Plurali in italiano

• Il plurale di una parola inglese usata in una frase in italiano non vuole la s.

• Non utilizzare inglesismi quando esiste un termine italiano equivalente. "pushare", "deliverare", "mergiare", etc. non sono parole italiane.

Riferimenti ai prossimi capitoli, sezioni, ecc.

• When you refer to chapters, sections, etc., you need to mention what you are referring to, not just writing down a number.

file.tex

\ref{ch:ref-chapter-six} conclude la tesi // [!code --]
Il Capitolo~\ref{ch:ref-chapter-six} conclude la tesi // [!code ++]

file.pdf

6 conclude la tesi // [!code --]
Il Capitolo 6 conclude la tesi // [!code ++]

file.tex

L'architettura è mostrata in~\ref{fig:ref-fig-architecture} // [!code --]
L'architettura è mostrata in Figura~\ref{fig:ref-fig-architecture} // [!code ++]

file.pdf

L'architettura è mostrata in 2.1 // [!code --]
L'architettura è mostrata in Figura 2.1 // [!code ++]

Utilizzo delle maiuscole nei riferimenti

• Use capital letters when you refer to a specific chapter/section/figure/whatever, use non-capital letter in other cases

file.tex

Nel capitolo~\ref{ch:ref-chapter-six} // minuscola // [!code --]
Nel Capitolo~\ref{ch:ref-chapter-six} // maiuscola // [!code ++]

file.pdf

Nel capitolo 6 // minuscola // [!code --]
Nel Capitolo 6 // maiuscola // [!code ++]

Attenzione

Questi errori possono essere evitati tramite l'utilizzo del package cleveref come spiegato nella sezione Riferimenti incrociati.

Nel prossimo Capitolo // maiuscola // [!code --]
Nel prossimo capitolo // minuscola // [!code ++]

Suggerimento

Quando ti riferisci ad un capitolo / sezione / figura / qualsiasi cosa, usa il carattere tilde (~) per evitare la separazione del riferimento dal numero. Su Windows puoi digitare Alt+126 per ottenere il carattere tilde.