Modalità di redazione di tesi, tesine, elaborati di esercitazioni

Istruzioni per la preparazione del materiale da consegnare.

span style="font-size: small;">(M.Bertocco)



Sommario

Introduzione;

Informazioni preliminari (prerequisiti);

Istruzioni per la compilazione dell'elaborato;

Contenuti e organizzazione del cd/dvd da consegnare;

Riferimenti.







Introduzione

Il presente documento descrive alcune regole che devono essere seguite nella redazione del materiale corrispondente a una tesi, tesina o relazione di una esercitazione associata a un insegnamento. Nel seguito si farà uso del termine elaborato per indicare in modo indifferente uno qualunque delle tipologie precedenti di documento.

Verranno quindi qui fornite linee guida relativamente ai prodotti software da impiegare, ai formati associati ai vari file che concorrono a costituire il lavoro e ancora alla organizzazione da dare ai file medesimi al momento della consegna su di un adeguato supporto di memorizzazione.

Tramite i riferimenti di rete in fondo alla presente guida è possibile ottenere i prodotti da impiegare (tutti disponibili in versioni gratuite e con licenza GPL o consimile), documenti di supporto, e modelli (template) utili alla predisposizione del materiale richiesto.







Prerequisiti

Se non si conosce per nulla LaTeX, allora si prega di prendere preventivamente visione (cioè ora!) di una guida introduttiva allo stesso.

Due buoni riferimenti sono:

impara LaTeX!;

una (mica tanto) breve introduzione a LaTeX.

La lettura di una delle due guide precedenti è ritenuta sufficiente per svolgere il lavoro di preparazione del testo scritto. Tuttavia, per approfondimenti, si segnala il seguente testo, spesso citato in letteratura e anche disponibile in biblioteca interdipartimentale "G.Someda" (collocazione "DEI.005.5.-11A"):

L.Lamport, a document preparation system : user's guide and reference manual, Addison-Wesley, ISBN: 0201529831







Istruzioni per la compilazione dell'elaborato

Dal punto di vista operativo, per la stesura del testo si consiglia di seguire i seguenti passi

  • lettura di una guida introduttiva a LaTeX (opzionale se si conosce già LaTeX);
  • lettura attenta della guida alla preparazione di documenti estesi (elaborato, tesi, libro);
  • installazione software LaTeX e correlati (vedi par. successivo);
  • scrittura di documento di prova in formato libero, e che però includa alcune righe di testo (con qualche lettera accentata, del tipo "è"), una figura in formato encapsulated postscript, una formula a piacere, e una semplice tabella;
  • preparazione dell'elaborato, seguendo rigorosamente le spiegazioni contenute nella guida precedente. Si suggerisce di decomprimere l'archivio seguente, contenente un "template", in un'area di lavoro, (ad es una directory di nome "src") e in tale area scrivere il testo dell'elaborato;
  • predisposione della eventuale presentazione;
  • organizzazione del materiale da consegnare seguendo scrupolosamente le istruzioni riportate nel seguito.



Strumenti software

Per la preparazione dell'elaborato scritto si devono utilizzare i seguenti programmi:

  • LaTeX, per la compilazione del testo;
  • OpenOffice.org/impress (ver.2 o succ), per la preparazione delle figure e dell'eventuale presentazione.

A tal fine, si consiglia vivamente di installare/impiegare i seguenti tools sw, tutti liberamente disponibili in rete

in ambiente unix/Linux

  • texlive (i.e. LaTeX)
  • Kile (text editor "latex aware")
  • okular/evince, pstools


in ambiente windows

  • ghostscript/ghostview/gsview
  • miktex (i.e. Latex)
  • TexNicCenter (o un qualunque altro text editor "latex aware")


in ambiente mac

  • ghostscript/ghostview/gsview
  • MacTeX
  • TeXShop


multipiattaforma

  • OpenOffice.org
  • Imagemagick
  • Inkscape
  • Gimp
  • Acrobat reader
  • BibConverter (disponibile via web)


Per Linux non è strettamente necessario seguire un ordine per l'installazione, si consiglia tuttavia di impiegare un tool per la gestione dei pacchetti come apt o yum (synaptic, ecc.).

Invece, per windows si consiglia di installare i pacchetti precedenti nel seguente ordine: 1:ghostscript/ghostview, 2:miktex, 3:texniccenter. (OpenOffice e gli altri non hanno vincoli circa l' ordine di installazione rispetto ai precedenti).

Si noti che il formato di default rispetto al quale sono salvati i file di testo può differire tra i vari sistemi operativi, a causa della recente introduzione di unicode (e altre), la qual cosa sta di fatto generando sottili incompatibilità tra sistemi operativi.

Pertanto, si raccomanda caldamente di impostare il text editor impiegato per la scrittura del file LaTeX in modo che i file di testo (.tex, .bib, ecc.) siano salvati in formato ISO-8859-15.



Latex: stili, template,...

Una volta appresi i fondamenti relativamente a LaTeX, si prega di prendere visione della
guida alla preparazione di documenti estesi (elaborato, tesi, libro,...).

Le indicazioni riportate in tale documento sono obbligatorie!

Sono anche disponibili:

  • la versione "sorgente" del documento precedente,
  • una versione "template del documento precedente

Attenzione. Il "sorgente" della guida al punto precedente è soggetto a modifiche continue senza preavviso (per tale motivo riporta la dicitura 'DRAFT'). Il suo uso atteso è di consultazione, nell'eventualità si desiderasse verificare come sono stati effettivamente impiegati i comandi resi disponibili invece dal "template".

Si raccomanda quindi di impiegare il corrispondente "template", seguendo le avvertenze riportate nella guida.







Contenuti e organizzazione del cd/dvd da consegnare

Lo scopo delle seguenti istruzioni è di favorire lo scambio di informazioni tra progetti precedenti (o paralleli) minimizzando la fatica di ciascuno.

Quindi seguire le indicazioni riportate nel seguito, permette di creare una struttura "comune" a più lavori con conseguenti benefici.

In ogni caso le indicazioni seguenti sono obbligatorie. verranno verificate al momento della consegna del lavoro e solo dopo che saranno state soddisfatte il lavoro sarà considerato concluso.



Supporti

Sono considerati supporti accettabili i seguenti:
cd-r, cd-rw, dvd+-r, dvd+-rw;

Nel seguito saranno cumulativamente riferiti con il termine "dvd", per semplicit&agrave.

Nel caso in cui sia esplicitamente autorizzato l'invio tramite posta elettronica (di norma invece vietato), tutto il materiale va compresso in un unico file, e in formato "zip", seguendo l'oraganizzazione che comunque dovrebbe avere su dvd.

Il dvd va "identificato" (es. con un comune "pennarello da cd/dvd").

Sul dvd stesso devono comparire i cognomi degli autori, il titolo del lavoro, l'anno accademico.
Nel caso eventuale di file compresso il nome del file deve essere det tipo cognome.titolo.anno.zip, dove "cognome" è il cognome dell'autore o del capogruppo, "titolo" riassume il titolo del lavoro, "anno" è l'anno di redazione (es "rossi.marcatura_ce.2010.zip"). Il nome del file deve essere unicamente composto dai caratteri da 'a' a 'z', da '0' a '9', e '_'; non deve quindi contenere spazi o caratteri "speciali" (es. lettere accentate, '-', '+', ecc.).



Organizzazione directory su disco

E' obbligatorio organizzare i dati all'interno del dvd in accordo alla seguente struttura (nel seguito si farà riferimento alla convenzione "unix", con "/" come separatore tra nomi di directory)

directory contenuto
/doc/ elaborato scritto (versione stampabile e sorgenti).
/doc/src/ sorgenti LaTeX, i srgenti stessi seguono l'organizzazione presente nel file "template" disponibile seguendo i link in fondo al presente documento (seguono alcuni esempi)
/doc/src/images/ immagini relative al sorgente LaTex (eps) e file dai quali le immagini eps sono state generate
/doc/pres/ presentazione associata al lavoro (OpenOffice.org/impress)
/docs/ copia di tutta la documentazione dalla quale l'elaborato ha tratto "ispirazione", eventualmente raggruppata in sottodirectory


Note

  • NON usare mai i caratteri spazio e i caratteri non-ascii (es. lettere accentate) nella definizione dei nomi di file (eventualmente usare il carattere "_" (uderscore) al posto dello spazio
  • NON usare mai i caratteri: spazio, i caratteri non-ascii e il carattere "_" (underscore)
    nella definizione dei nomi di file associati a sorgenti latex o immagini eps
  • Ricordare che LaTeX, è "case-sensitive", per cui è importante usare una convenzione uniforme tra nomi di file e etichette utilizzate nei sorgenti LaTeX (es. al comando \include{IlMioFile} deve corrispondenre "IlMioFile.tex", "ilmioFILE.tex", potrebbe non essere trovato da LaTeX, a seconda del sistema operativo/distribuzione LaTeX); in caso di dubbio usare solo caratteri minuscoli.
  • In radice del dvd scrivere in un file testo dal nome "00-leggimi.txt". in tale file scrivere:

    - titolo del lavoro

    - anno accademico

    - data di scrittura del dvd (anno-mese-giorno)

    - per ciascun autore (uno per riga in ordine alfabetico): cognome, nome, matricola/corso, e-mail
  • Il nome del file associato all'elaborato finale va codificato come segue:

    cognome.titolo.anno.pdf

    dove cognome è il cognome dell'autore o del capogruppo del gruppo di lavoro, titolo riassume il titolo del lavoro, anno è l'anno di redazione. ad esempio "rossi.taratura_oscilloscopi.2010.pdf", oppure "bianchi.esd_on_pcb.2009.pdf", ecc.

    analogamente l'eventuale presentazione viene salvata nel file:

    cognome.titolo.pres.anno.pdf

    ad esempio "rossi.taratura_oscilloscopi.pres.2010.pdf".

    Non codificare tali file come "main", "tesi", "elaborato", "presentazione", e così via!

  • Nella directory doc/ vanno salvati solo la versione finale dell'elaborato (versione pdf) e la versione pdf dell'eventuale presentazione. I corrispondenti sorgenti LaTeX e il file OpenOffice della presentazione vanno memorizzati rispettivamente in doc/src/ e doc/pres/
  • in ogni caso, vanno eliminati dal source tree (directory "doc/src" e nodi figli) i file di appoggio creati dalle varie compilazioni LaTeX/bibTex e affini (es ".aux", ".toc.", ".bbl",...), i file "di backup" creati dai text editor (es ".bak" ".backup", ecc.).







Riferimenti

Si riportano alcuni link di interesse generale o correlati ai tools citati.

Nota. I link seguenti sono stati verificati solo al momento della prima scrittura del presente documento.