lorenzo.pantieri

Secondo me va bene, al massimo potresti specificare nel testo che bisogna leggere con attenzione l’esempio proposto.

Oppure, se si vuole eliminare il problema del testo su “due livelli” si potrebbe fare una lista di esempi, cioè spezzare l’esempione in parti, come al solito, cioè con il commento a fianco.

Preambolo — Commento (notare i commenti sui pacchetti, limitare i comandi personalizzati a quelli effettivamente utili, ecc…)

Le sezioni — Commento (chiarezza nella divisione del documento, label messa subito dopo il comando di sezionamento, ecc…)

Oggetti mobili — Commento (inserirli tra paragrafi, label contenente il prefisso fig: o tab: …)

La matematica — Commento

e così via.

In ogni caso, così com’è va comunque bene.

Visto che l’esempio che avevo scritto non mi convinceva, ho provato a scrivere due esempi di documento: un articolo e un curriculum. I documenti, entrambi compilabili, illustrano alcuni degli accorgimenti che è opportuno adottare per scrivere un sorgente leggibile.

Nella stesura del codice sorgente si consiglia di adottare i seguenti accorgimenti:

• suddividere con chiarezza il documento, aiutandosi eventualmente con rientri, incolonnamenti e righe vuote supplementari;

• limitare i comandi personalizzati a quelli effettivamente utili (un abuso dei comandi personali complica la lettura del codice, soprattutto a distanza di tempo);

• scrivere le etichette subito dopo i relativi comandi;

• adottare per le etichette un formato costituito da un’abbreviazione come sec (per le sezioni), fig (per le figure), tab (per le tabelle), … seguita da : e da una parola chiave che caratterizza l’oggetto cui ci si riferisce;

• allineare le colonne delle tabelle;

• adottare per le chiavi bibliografiche una formato costituito dal nome dell’autore seguito da : e da una parola che caratterizza l’opera;
  introdurre gli oggetti mobili scrivendo il relativo ambiente tra capoversi, cioè preceduto e seguito da una riga vuota.

Gli esempi sono questi:
`% Un articolo scritto con LaTeX
\documentclass[a4paper,11pt]{article}
\usepackage[italian]{babel} % per scrivere in italiano
\usepackage{lipsum} % genera testo fittizio
\usepackage{url} % per scrivere gli indirizzi Internet

\begin{document}
\title{Il titolo}
\author{Lorenzo Pantieri}

\maketitle

\begin{abstract}
\lipsum[1]
\end{abstract}

\tableofcontents

\section{Un paragrafo}
\lipsum[1]
\subsection{Un sottoparagrafo}
\lipsum[1]
\subsection{Un sottoparagrafo}

\section{Un paragrafo}
\label{sec:esempio}
\lipsum[1]

% Bibliografia
\begin{thebibliography}{9}
\bibitem{pantieri:arte}
\textsc{L.~Pantieri} (2009),
\emph{L’arte di scrivere con \LaTeX},
\url{http://www.lorenzopantieri.net/LaTeX_files/ArteLaTeX.pdf}.
\end{thebibliography}
\end{document}`
`% Un CV scritto con LaTeX
\documentclass{scrartcl} % classe article di KOMA
\usepackage[LabelsAligned]{currvita} % buon pacchetto per CV
\usepackage[italian]{babel} % per scrivere in italiano
\usepackage{url} % per gli indirizzi Internet
\usepackage[nochapters]{classicthesis} % stile ClassicThesis

\renewcommand{\cvheadingfont}{\LARGE\color{Maroon}}
\renewcommand{\cvlistheadingfont}{\large}
\renewcommand{\cvlabelfont}{\qquad}

\begin{document}
\begin{cv}{\spacedallcaps{Curriculum vitae}}
\begin{cvlist}{\spacedlowsmallcaps{Dati personali}}
\item Lorenzo Pantieri
\item Nato a Cesena il 30 gennaio 1973
\item \url{http://www.lorenzopantieri.net/}
\end{cvlist}

\begin{cvlist}{\spacedlowsmallcaps{Esperienze lavorative}}
\item \dots
\end{cvlist}
\end{cv}
\end{document}`
Se non altro, ora sono più leggibili, rispetto al papiro di prima.

Che ne pensi?

forse c’è uno svarione anche a pagina 30, nella sottodidascalia della figura 6b.

Corretto.

Aggiornati (con un ritardo 😳 davvero ingiustificabile) anche i Complementi, sulla base delle tue indicazioni, Tommaso.

http://www.lorenzopantieri.net/LaTeX_files/Complementi.pdf

A presto e grazie di tutto,
L.

1.

`
\DeclarePairedDelimiter{\abs}{\lvert}{\rvert}
`
e probabilmente anche quello nella riga successiva. Ho controllato la documentazione di mathtools, poiche’ non mi funzionava la definizione del comando abs, e ho notato che la definizione giusta e’:
`
\DeclarePairedDelimiter\abs{\lvert}{\rvert}
`

Nessun problema, qui. La definizione
`\DeclarePairedDelimiter{\abs}{\lvert}{\rvert}`
funziona benissimo, al pari di quella con una coppia di parentesi graffe in meno
`\DeclarePairedDelimiter\abs{\lvert}{\rvert}`
Effettivamente, nella documentazione di mathtools è proposta quest’ultima definizione di \abs, anche se la sintassi generale del comando \DeclarePairedDelimiter riportata qualche riga prima è la seguente:
`\DeclarePairedDelimiter{}{}{}`
In conclusione, dovrebbero andare bene entrambe (anche se quella con la coppia di graffe in più mi sembra didatticamente più chiara). A questo punto, per individuare e risolvere il tuo problema con \abs occorre un esempio minimo compilabile.

2. http://www.lorenzopantieri.net/LaTeX_files/ArteLaTeX090511.pdf

In questa bozza (pag. 197-198) ho riportato un esempio di sorgente “ben scritto”, come proposto da Francesco. Purtroppo il risultato finale non mi soddisfa molto. Innanzitutto il codice, piuttosto lungo, è faticoso da leggere (i caratteri a spaziatura fissa non si prestano molto per comporre lunghe parti di testo).

Poi c’è un altro problema filosofico, a mio parere classico quando si compone un “modello” di documento: il testo riportato è pretestuoso e insulso, scritto solo per far vedere come funzionano comandi e ambienti. Questo problema è meno grave scrivendo una guida: lì gli esempi sono confinati in opportuni ambienti e vengono commentati “dall’esterno” ( “a un livello metalinguistico”, mi pare che si dica). Per esempio scrivere

La composizione delle formule matematiche è uno dei punti di forza di LaTeX. La seguente formula è un esempio:
`
\[
2+2=4
\]`

(si noti l’uso dell’ambiente “codice”) va benissimo: si capisce che l’esempio è solo… un esempio, e il flusso del discorso principale (“La composizione delle formule matematiche è uno dei punti di forza di LaTeX”) non viene interrotto.

Invece scrivendo un “modello” senza usare opportuni ambienti per gli esempi, questi ultimi vengono a trovarsi sullo stesso piano del discorso generale, che perde coerenza. Una cosa come

La composizione delle formule matematiche è uno dei punti di forza di LaTeX. La seguente formula è un esempio:
2+2=4

è meno facile da leggere, perché “2+2=4” è allo stesso livello del discorso principale.

Non so se sono riuscito a spiegarmi… In ogni caso, mi piacerebbe conoscere il vostro parere al riguardo.

Ciao,
L.