Come scrivere un atto telematico avanzato in Markdown
Nello scorso articolo abbiamo visto perché non usare un programma di video-scrittura, nell'articolo di oggi vedremo le regole di base per scrivere in markdown.
I link che trovate qui sotto saranno attivi dalla data di pubblicazione dei singoli articoli.
- Perché non usare un programma di video-scrittura per scrivere un atto telematico?
- Come scrivere un atto telematico avanzato in Markdown (quello che state leggendo)
- Aggiungere il “dialetto” di LaTeX ad un atto telematico scritto in markdown
- Compilare un atto telematico in markdown con Pandoc
2. Come scrivere un atto telematico avanzato in Markdown
Di seguito esaminerò velocemente la formattazione utile all’avvocato per creare un atto telematico in markdown.
2.1 Le sezioni
Per creare un indice automatico occorre dividere l’atto telematico in sezioni. Giusto a titolo esemplificativo questo (come quasi tutti gli articoli di Avvocati e Mac) è diviso in sezioni e sotto-sezioni per rendere più facile la lettura e perché, a monte, ho strutturato uno schema dell’articolo a punti.
Formattare le sezioni in markdown è banale:
#per il titolo / sezione principale (abitualmente io non lo uso nei miei atti);##per la sezione;###per la sotto-sezione;####per la sotto-sotto-sezione (che sconsiglio di usare salvo il vostro atto non sia veramente complesso).
2.2 Grassetto e Corsivo
Grassetto e Corsivo servono per dare enfasi al testo scritto. Tendenzialmente il corsivo è l’enfasi “normale” mentre il grassetto dovrebbe essere usato in casi eccezionali in cui è necessaria una particolare enfasi. Per esperienza personale negli atti giuridici si abusa (immotivatamente) dell’enfasi, addirittura evidenziando in grassetto intere frasi (così perdendo l’effetto di evidenziare un singolo concetto).
Segnalo, inoltre, che è da evitare il testo sottolineato, malcostume tipico del mondo legale. In tipografica non esiste questo modo di enfatizzare (aprite un qualsiasi libro o rivista e difficilmente troverete del testo sottolineato). Questa “scorretta prassi” nasce come retaggio dell’epoca degli atti dattiloscritti in cui, per i limiti della macchina da scrivere, non era possibile usare il grassetto o il corsivo e si sottolineava per dare enfasi. Non essendoci più queste limitazioni strutturali da ormai 20 anni, il testo sottolineato, in un atto giuridico così come in qualsiasi documento, deve essere evitato (la doppia evidenziazione del medesimo concetto in poche righe è voluta! 😜).
Se vi ho messo la pulce nell’orecchio e siete incuriositi, nel mese di Aprile 2019 ho in mente di organizzare un webinar dal titolo Tipografica per Avvocati dove parlerò in dettaglio di tipografica; qui trovate il link per iscrivervi e ricevere ulteriori informazioni sulla data e l’orario definitivo.
In Markdown per fare del testo grassetto occorre racchiudere tra due doppi asterischi il testo nel seguente modo: **grassetto**.
Per fare invece il testo in corsivo basta racchiudere il testo tra due asterischi nel seguente modo: *corsivo*.
Lo stesso risultato si può ottenere sostituendo al “*” il carattere underscore (trattino basso, in italiano) ovvero “_”. Personalmente per scrivere in Markdown uso il metodo proposto da Brett Terpstra ovvero uso i doppi asterischi per il grassetto ed un singolo trattino basso per il corsivo. Visivamente è più facile infatti distinguere l’uno dall’altro.
Ricapitolando per formattare in grassetto e corsivo in Markdown:
**grassetto**_corsivo_
Esempio di grassetto e corsivo in markdown (a sinistra) e loro visualizzazione finale (a destra)
2.3 Elenchi puntati e numerati
Per creare un elenco puntato è sufficiente per ogni punto dell’elenco fare un “*” o un “+” o un “-“. Il risultato finale sarà il medesimo.
È poi possibile indentare usando il TAB.
* punto - sottopunto + sotto-sotto-punto
Esempio di elenco puntato in markdown (a sinistra) e sua visualizzazione (a destra)
Gli elenchi numerati invece vengono creati inserendo ad inizio riga un numero seguito immeritatamente da un punto così: 1.
I numeri non devono essere consequenziali o in ordine ma il risultato finale sarà sempre un elenco numerato correttamente.
1. Primo punto 1. Secondo punto 4. Terzo punto
Esempio di elenco numerato in markdown (a sinistra) e sua visualizzazione a destra
Valgono le medesime regole di indentazione spiegate per gli elenchi puntati per gli elenchi numerati e, ovviamente, possono essere mischiati elenchi puntati con elenchi numerati.
Esempio di elenco numerato con sotto-elenco (markdown a sinistra e visualizzazione a destra)
2.4 Citazioni … e del perché sarebbe utile usarle
Creare una citazione in markdown è banale basta anteporre il simbolo maggiore al testo della citazione ovvero “>”.
> Questa è una citazione. > Per scrivere una citazione su più righe occorre anteporre il simbolo maggiore ad ogni nuova riga.
Perché bisognerebbe usarle negli atti giuridici?
Capita, troppo spesso, che in un documento giuridico venga citata per esteso una massima giurisprudenziale. Abitualmente ciò viene fatto tra virgolette all’interno di testo stesso dell’atto, a volte con il testo citato in corsivo, a volte no.
Una citazione, tuttavia, dovrebbe differenziarsi dal corpo del testo del documento principale proprio per far notare che il testo riportato non è dell’autore del testo principale ma proviene da un soggetto diverso (spesso più autorevole).
Per fare ciò, abitualmente, in tipografia si modificano vari parametri del corpo del testo e si aumentano i rientri laterali (sinistro e destro) così da rendere differente il testo citato in modo evidente ed immediato, anche solo ad uno sguardo sommario della gabbia del testo.
Di seguito un esempio esplicativo.
Esempio di citazione in un atto telematico
2.5 Collegamenti (link) a pagine web o documenti
Per creare un link (ad una pagina web o ad un documento) in Markdown occorre usare la seguente sintassi:
[Nome del link che verrà visualizzato](indirizzo http o percorso del file)
Per fare un semplice esempio digitando [link ad avvocati e mac](https://www.avvocati-e-mac.it) si creerà un link simile a questo.
Per creare invece un link (relativo) ad un documento basterà inserire il nome del file così:
[Doc. 1](doc01.pdf)
Nota importante: c’è una piccola limitazione, che allo stato non sono riuscito ad aggirare, per avere un link relativo funzionante ad un documento è necessario che il nome del file non abbia spazi al suo interno altrimenti il link non funzionerà correttaente, per cui è:
- ERRATO avere un documento nominato
doc01 questo è un documento.pdf - CORRETTO avere un documento nominato
doc01-questo-è-un-documento.pdfovvero anchedoc01_questo_è_un_documento.pdf
So che questa può essere una limitazione fastidiosa ma non sono riuscito in alcun modo a far funzionare il sistema altrimenti, pur avendo fatto svariati esperimenti e ricerche su internet.
2.6 Inserire delle immagini nel documento
Il metodo per inserire all’interno del vostro documento è simile a quello per inserire un link, basta solo anteporre un punto esclamativo “!” alla sintassi del link così:
Se l’immagine fosse troppo grossa rispetto alla pagina o, comunque, se ne volesse modificare le dimensioni, è possibile farlo aggiungendo alla fine della sintassi le parentesi quadre “{}” al cui interno inserire width (larghezza in inglese) o hight (altezza in inglese) un uguale e la partentuale di dimensione a cui si vuole ridurre o aumentare ovvero la dimensione metrica (in millimetri con il postfisso “mm” o in centimetri con il postfisso “cm”).
Ad esempio usando le seguenti sintassi:
{ width=50% }immagine ridotta al 50% della dimensione originale;{ width=30mm }immagine larga 30 millimetri.
In conclusione
Abbiamo visto come strutturare un atto telematico utilizzando il semplice linguaggio di marcatura denominato markdown.
Come potrete aver già sospettato, l'essenzialità del markdown non permette una impaginazione avanzata; per fare questo sarà necessario appoggiarsi a LaTeX, che sarà appunto l'oggetto del prossimo articolo della serie.
Gli altri articoli della serie: