Costruire una guida

BOTTERI” post=87039Salve a tutti, forse qualcuno mi può aiutare.. Nell’ambito della mia tesi devo anche fare una guida utente strutturata per farvi un esempio come l help di Windows.. Mi è stato accennato che latex ha un layout già predisposto simile.. Sapete dirmi qualcosa in più?
Grazie mille !

Benvenuto/a nel forum!

Con le classi standard è possibile ottenere ciò che può essere una guida utente: il risultato sarebbe motlo simile alle guide per LaTeX che puoi trovare qui nel sito. il resto dipende principalmente dal risultato che vuoi ottenere, dal tuo livello di conoscenza di LaTeX e dal tempo che hai a disposizione per portare a termine il lavoro.

Lorenzo

BOTTERI” post=87039Salve a tutti, forse qualcuno mi può aiutare.. Nell’ambito della mia tesi devo anche fare una guida utente strutturata per farvi un esempio come l help di Windows.. Mi è stato accennato che latex ha un layout già predisposto simile.. Sapete dirmi qualcosa in più?
Grazie mille !

Potresti allegare un’immagine di esempio? Credo che potrebbero tornare utili pacchetti come mdframed e tcolorbox, comunque.

Ciao
Claudio

BOTTERI” post=87042Domani faccio lo screen della pagina e lo posto.. Ma quindi devo solo cambiare il layout della pagina ? Perché ho provato a smanettare un po’ ma non ho trovato nulla.. (L ho installato ieri).. Non devo scaricare pacchetti aggiuntivi? Perché a me avevano parlato del layout refman (sempre che esista) ma non ho trovato dove inserire questa impostazione nell editor

`\documentclass{refman}`
Leggiti una guida di base, comunque.
Pacchetti aggiuntivi devi scaricarli se non hai una installazione completa. Che cosa hai installato?

Lorenzo

Ogni pacchetto o classe in LaTeX ha una guida.
Assicurati di aver installato refman, poi apri il tuo terminale (editor di ms-dos su windows) e digita texdoc refman si aprirà una guida di questo pacchetto.
Leggila.
Saluti

PS: lascia perdere texniccenter è datato usa TeXworks, dovrebbe essere già integrato in miktex.

BOTTERI” post=87054Ho scaricato Miktex, la versione base e come editor texniccenter. In pratica io devo fare una sorta di guida, esportabile in PDF con a sinistra tutti gli argomenti, linkati poi ovviamente a ciò che ci devo scrivere sopra che mi appare sulla destra. Ma è possibile fare una cosa così oppure devo cercare altri programmi ? Sono disperata ! 😮

Ogni pacchetto o classe in LaTeX ha una guida.
Assicurati di aver installato [tt]refman[/tt], poi apri il tuo terminale (editor di ms-dos su windows) e digita [tt]texdoc refman[/tt] si aprirà una guida di questo pacchetto.
Leggila.
Saluti

PS: lascia perdere texniccenter è datato usa TeXworks, dovrebbe essere già integrato in miktex.

BOTTERI” post=87054Ho scaricato Miktex, la versione base e come editor texniccenter. In pratica io devo fare una sorta di guida, esportabile in PDF con a sinistra tutti gli argomenti, linkati poi ovviamente a ciò che ci devo scrivere sopra che mi appare sulla destra. Ma è possibile fare una cosa così oppure devo cercare altri programmi ? Sono disperata ! 😮

Io non sono per nulla sicuro di aver capito capito cosa devi fare 🙄
Potresti spiegarti un po’ meglio?

Ciao
Ivan

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”.

ivan” post=87065

Ho scaricato Miktex, la versione base e come editor texniccenter. In pratica io devo fare una sorta di guida, esportabile in PDF con a sinistra tutti gli argomenti, linkati poi ovviamente a ciò che ci devo scrivere sopra che mi appare sulla destra. Ma è possibile fare una cosa così oppure devo cercare altri programmi ? Sono disperata ! 😮

Io non sono per nulla sicuro di aver capito capito cosa devi fare 🙄
Potresti spiegarti un po’ meglio?

Ciao
Ivan

Mi associo e ti invito nuovamente ad allegare almeno uno screenshot di cosa intendi: in alcuni casi è fondamentale per capire quale direzione prendere… e questo è uno di quei casi.

Ciao
Claudio

Il pacchetto hyperref serve proprio per quello, quindi non ci sono problemi con i link esterni come verso i link interni; leggi il manuale di hyperref per sapere come introdurre la parola o frase da cliccare affinché si associata alla destinazione che vuoi linkare.

BOTTERI” post=87285Da quello che ho letto anche su internet refman non è una cosa proprio semplice.. Sapete dirmi se è possibile però creare dei link ( tipo comando href in HTML ) e la sintassi per farli ? Cercherò di fare il manuale d’uso in quel modo..

Capisco che i link siano rilevanti, ma non capisco “Cercherò di fare il manuale d’uso in quel modo..”: quale sarebbe il modo con i link?

Comunque sia, prova un po’ a guardare qui: non ti sarebbero utili dei riquadri di questo tipo? Per una guida, riquadri del genere sono la prima cosa a cui uno dovrebbe pensare invece di dedicare del tempo a una classe che, senza documentazione, come dice OldClaudio è decisamente tempo perso.

Ciao
Claudio

Perché l’immagine non è scontornata: lo spazio che trovi e l’immagine (la parte utile dell’immagine) a sinistra, nonostante il comando \centering (che comunque non va seguito da una riga completamente vuota), sono segni evidenti che la parte utile dell’immagine ha bordi bianchi molto estesi.

Si raccomanda sempre di scontornare le immagini.

Nel tuo caso, visto che la tuoa immagine è in formato JPEG, qualunque programma di elaborazione fotografica o di immagini bitmapped va bene per scontornare; se non ne disponi, puoi sempre installare il programma gratuito GIMP (Gno Image Manipulation Program) disponibile per tutte le piattaforme.

BOTTERI” post=87302[attachment=759]image.jpg[/attachment]
Ne approfitto per chiedervi questa cosa visto che è tutta la mattina che ci sbatto la testa.. Per quale motivo dopo che inserisco un immagine ( formato jpg) mi lascia dello spazio bianco sotto ?

Se devi creare delle immagini di finestre e dialoghi basta premettere il tasto ALT a PrintScreen quando la finestra di interesse è in primo piano.
Verrà creata l’immagine già ritagliata solamente della finestra.
R.