Re: Costruire una guida

#87574
OldClaudio
Partecipante
    Up
    0
    Down
    ::


    La classe refman è del 1988, precedente all’avvento di LaTeX2e; dal 1994 fino al 2006 è stata adattata a LaTeX2e e dal 2006 non è stata più toccata.

    Ammetto di non averla mai usata, ma da quel che capisco (*) serve per comporre il manuale d’uso dei pacchetti e delle classi che vengono inviate dal volonterosi che ne scrivono e li inviano a CTAN per il beneficio di tutti. Non la raccomanderei per scrivere un manuale d’uso di qualche cosa d’altro, ma il mio parere è sicuramente molto personale e di uno che non ha mai usato quella classe. Il manuale stesso di refman non sembra molto diverso da quello che si potrebbe ottenere con la classe standard ltxdoc; mi stupirei se gli autori dei refman non avessero documentato refman stesso usando proprio refman. Non sarebbe una gran réclame per il loro operato.

    Tornando al tuo problema, per costruire il manuale che ti serve, devi decidere prima che aspetto vuoi dargli, poi puoi scegliere fra classi o pacchetti quelli che ti permettono di essere più efficace.

    Non necessariamente un pacchetto o una classe creati apposta per comporre manuali, sono adatti per comporre il tuo manuale; probabilment una clase qualsiasi come book, può venire personalizzata sia nella geometria della pagina, sia nell’uso dei colori, sia nell’uso di medaglioni che possono svilupparsi su una sola pagina o su più pagine; il modo di inserire le figure; se sia necessario un indice analitico di tutti i comandi che si possono usare sia del linguaggio (se si tratta di un linguaggio) sia del pannello di controllo (se si tratta di hardware), eccetera, fanno si che una classe precostituita si probabilmente la scelta peggiore; quella classe non ti lascerebbe la possibilità di personalizzare il layout del mateiale da esporre nel modo migliore in relazione al tuo particolare manuale.

    Mi spiace inviarti questi commenti che sembrano inconcludenti; ma servono ad aiutarti per renderti conto dell’importanza dell’analisi preliminare del documento; che cosa deve documentare, a chi, cioè a quali lettori/utenti è destinato, quanto deve essere dettagliato, quale livello di sobrietà deve avere la sua veste grafica. Solo dopo esserti risposto a queste domande e ad altre chene conseguono, puoi poi decidere che cosa fare, quale classe usare, che pacchetti aggiungere, eccetera.

    Quel poco che ho capito da quel che hai scritto è che qualunque file pdf che contenga i bookmarks ha a destra o a sinistra l’indice cliccabile e strutturato che ti permette di navigare nel manuale; basta impostare correttamente il pacchetto hyperref, eventualmente caricare anche il pacchetto bookmarks e il giochetto è fatto.

    (*) usando il comando texdoc refman da terminale si apre la documentazione della classe ma, leggendo bene, c’è solo la descrizione del codice; non c’è una parola sullo scopo della classe, né sul suo uso. Tempo perso e classe “inutile”.

    Go to top