Modello relazione tecnica calcolo strutturale

Daniele86″ post=82596Buongiorno a tutti,
è da un po’ che non riesco a seguire le discussioni. Oggi, a seguito di indicazioni tipografiche scandalose (non vi nascondo un filo di malumore nel dover comporre certi obrori…) mi domandavo se da qualche parte fosse reperibile un modello di relazione strutturale che potrebbe essere usato in uno studio professionale. Chiaramente non verrebbe usato dove lavoro, ma vorrei fare una “pulizia mentale” da tutti i cattivi comportamenti imposti dai “capi esperti di tipografia” 😉

Tempo fa stavo iniziando a impostarmi un mio modello, ma purtroppo il tempo è poco…

Buona giornata a tutti,

Daniele

Ciao Daniele,
anch’io nel mio lavoro compongo le relazioni di calcolo dei progetti in LaTeX.
Ho costruito nel tempo alcuni file di classe per comodità ed amore di pulizia sintattica dei sorgenti.
Inoltre, ho provveduto a centralizzare le iinformazioni che si ripetono dell’anagrafica del cantiere inserendole in una serie di file che vengono letti opportunamente dalla classe. Uso una classe per ciscun tipo di documento (relazione tecnica, fascicolo di calcolo eccetera).
Mi piacerebbe sviluppare ulteriormente i meccanismi di questo processo produttivo ormai ben collaudato nel tempo. Per esempio, mi piacerebbe riorganizzare la struttura delle classi scrivendone una base da cui “ereditare” per scrivere le classi specifiche per tipo documento, e mi piacerebbe anche poter disporre delle anagrafiche in un database server installato sula rete LAN.

Dal punto di vista tipografico mi regolo così: mi baso sulle classi base di LaTeX a cui lascio fare la gran parte delle scelte compositive. Paradossalmente, quello che mi interessa di più non è la buona tipografia — a cui pensa pdfLaTeX — ma la buona gestione del processo.
Cosa significa? Significa che con LaTeX cerco di strutturare al meglio i dati dei progetti per modificare in un sol luogo e aggiornare in automatico in molti altri luoghi, e mi sforzo di strutturare i contenuti — specie quelli della relazione tecnica principale — per far si che la consultazione sia immediata e che non manchino informazioni tecniche.
Quindi, mentre riciclo molto i file delle sezioni dei progetti precedenti, mi sforzo di riformulare l’indice della relazione principale ogni volta, per ripensarla ancora una volta.

Veniamo alla tua domanda. Posso mandarti i sorgenti delle mie classi a condizione che rimangano solo a te (in effetti si tratta di documentazione aziendale non divulgabile senza autorizzazione). Ma, non c’é niente di speciale e immagino che le parti più interessanti mi siano state suggerite da Enrico in vari post sul forum, magari apparentemente “strani”.

Sarebbe fantastico scrivere insieme un articolo per ArsTeXnica sull’argomento con il sunto delle nostre esperienze con LaTeX nella professione. Potremo impostarlo come un dialogo nostro mentre tu costruisci la tua infrastruttura di produzione documentale.
Il tempo è poco, ma lo possiamo distribuire in tanti “ritagli” rubati alle nostre famiglie…
Un saluto.
R.
Vi sono delle questioni TeXniche e delle questioni “gestionali”.

Daniele86″ post=82599Sarebbe molto interessante vedere come hai impostato la struttura. Sarebbe altrsì interessante scrivere un articolo su ArsTeXnica come da te proposto. Direi che si può fare.

Come dice sempre Max, ottimo!

Daniele86″ post=82599Inizio subito a discutere con te di alcune peculiarità di una relazione tecnica rispetto ad altri documenti:

• comparirà il logo dello studio nella testatina e/o al piede (?);
• compariranno dei dati dello studio, magari scritti in piccolo e in grigino (?);
• gabbia del testo non troppo stretta (penalizzazione della resa tipografica ma necessario per non abbattere una foresta per ogni relazione – necessario per equilibrio di immagini di grandi dimensioni (?));
• dove lavoro non si stampa fronte/retro, ma direi che sarebbe d’obbligo.

Io in genere metto logo e dati solo in un frontespizio caratterizzato da un’immagine della struttura così da poter poi riconoscere ad occhio il documento. Anch’io uso una gabbia un po’ più larga fronte retro.

Daniele86″ post=82599Rimango in attesa anche per la faccenda dell’articolo…. l’idea mi interessa 😉

Ciao,

Daniele

PS: “(?)” indica che l’idea è accennata ma sottoposta a “valutazione di corretetzza” e/o necessità

Allora sentiamoci per e-mail (la mia la trovi per esempio, nella guida tematica alla riga di comando).
Ciao
R.

Mi “inserisco” in questa discussione perché anche io sto affrontando il problema della redazione di documenti tecnici e vorrei condividere la mia esperienza. Ho redatto alcuni modelli di relazioni tecniche e ho anche riprodotto un modello di Attestato di certificazione energetica (secondo le linee guida nazionali, ma questo interesserà solo qualche specialista che eventualmente si troverà a leggere il filone 🙂 ).

In tutti i casi ho usato la classe scrartcl, con poche personalizzazioni e con il pacchetto siunitx, d’obbligo per certi tipi di documento. Nel caso dell’Attestato di certificazione energetica, invece, sono stato indeciso sul compilatore da usare (pdfLaTeX o ConTeXt), ma avendo fatto un uso estensivo di codice Tikz, la scelta si è rivelata, almeno dal punto di vista del codice sorgente, poco influente. L’aspetto più importante è, come sottolineato da @robitex, la gestione dei dati in ingresso. Fino a ora mi sono limitato a definire dei comandi nel preambolo definendo una corrispondenza tra chiavi e valori:`\def\chiave{valore}`
Sarebbe molto utile poter disporre di un file di testo, esterno al sorgente, da completare e far poi leggere al motore di compilazione. Da un paio di articoli letti sul blog di @robitex, mi sembra che il linguaggio Lua abbia delle grandi potenzialità per eseguire il compito di leggere dati e passarli al compilatore per ottenere il documento.

Lorenzo

GKT” post=82622Mi “inserisco” in questa discussione perché anche io sto affrontando il problema della redazione di documenti tecnici e vorrei condividere la mia esperienza. Ho redatto alcuni modelli di relazioni tecniche e ho anche riprodotto un modello di Attestato di certificazione energetica (secondo le linee guida nazionali, ma questo interesserà solo qualche specialista che eventualmente si troverà a leggere il filone 🙂 ).

In tutti i casi ho usato la classe scrartcl, con poche personalizzazioni e con il pacchetto siunitx, d’obbligo per certi tipi di documento. Nel caso dell’Attestato di certificazione energetica, invece, sono stato indeciso sul compilatore da usare (pdfLaTeX o ConTeXt), ma avendo fatto un uso estensivo di codice Tikz, la scelta si è rivelata, almeno dal punto di vista del codice sorgente, poco influente. L’aspetto più importante è, come sottolineato da @robitex, la gestione dei dati in ingresso. Fino a ora mi sono limitato a definire dei comandi nel preambolo definendo una corrispondenza tra chiavi e valori:`\def\chiave{valore}`
Sarebbe molto utile poter disporre di un file di testo, esterno al sorgente, da completare e far poi leggere al motore di compilazione. Da un paio di articoli letti sul blog di @robitex, mi sembra che il linguaggio Lua abbia delle grandi potenzialità per eseguire il compito di leggere dati e passarli al compilatore per ottenere il documento.

Lorenzo

Ciao,
io mi baso su article. Con xkeyval ho creato una chiave ‘job’ che posso dare come opzione alla classe e che prende il valore numerico che corrisponde al codice del progetto. Per esempio: job=144.
L’esecuzione dell’opzione, provoca il caricamento dl file 144.DAT posizionato in una cartella dell’albero LOCALE di TeX.
Questo file contiene delle istruzioni \set{chiave}{valore} che alla maniera classica non fa altro che definire una macro “nascosta” chiamata \prefixcode@chiave che viene utilizzata nei comandi di composizione della classe.
Così, posso condividere tra tutti i documenti il titolo del progetto per esempio (\set{titolo}{Costruzione …}).
Alla partenza di un progetto non faccio altro che creare un nuovo opportuno file .DAT.

Il meccanismo funziona ed è semplice da gestire. Ho provato anche ha produrre documenti molto simili a report complessi, come hai fatto tu con le certificazioni energetiche. Tuttavia la cosa non mi è riuscita perché non sono riuscito a trovare una soluzione che mi piacesse.
Per risolvere i problemi che ho incontrato penso sia necessario ricorrere alla memorizzazione di dati in un database dal quale leggere in compilazione con LuaLaTeX. Ci sono troppi numeri, percentuali e cifre da gestire.

Recentemente però, ho ottenuto un buon successo per la creazione di computi metrici di una serie di lavori ad impianti usando Lua puro e memorizzando i dati su un database SQLite3, per produrre il testo del sorgente da compilare successivamente. Veramente una buona cosa. In più, questo lavoro mi ha dato la base per un articolo completo per ArsTeXnica ma non so se avrò modo di scriverlo.
Attualmente sto lavorando ad un progetto a lungo termine con un RDBMS di rete in cui LaTeX svolge il ruolo di reporting tool, questa volta usando il Go, il recente linguaggio open di Google.

La domanda a cui sto cercando di rispondere è questa: è più conveniente produrre i sorgenti dei report dall’esterno oppure caricare i dati direttamente nel sorgente dal DB con LuaTeX?

Ai posteri l’ardua sentenza.
R.