Produzione di un manuale tecnico – chiedo suggerimento

  • Creatore
    Topic
  • #63120
    Up
    0
    Down
    ::


    Ciao, vorrrei abbandonare il wordprocessor a favore di LaTeX, per creare un “template” per la documentazione tecnica dei miei sw.

    Vorrrei quindi concentrarmi sui contenuti e non sulla formattazione.

    Ho letto un sacco di guide, thread e quant’altro ma + leggo, + mi si crea confusione.

    Non pretendo che mi venga postato il codice ma che mi si instradi nella direzione giusta.

    Vorrei semplicemente :
    1. indice clickabile (link) con la pagina del capitolo, coi classici puntini fino al num di pagina
    2. paragrafi e sottoparagrafi non numerati
    3. intestazione pagina con linea e testo a mia scelta

    Io sto provando con la classe document.cls e \tableofcontents ma ma nell’indice non mette mette ine link, ne puntini, ed i paragrafi sono numerati.
    Forse la classe document non è quella guista ? ma nella “mica tanto breve..” sembrava la + calzante.

    Uso MikTeX 2.9 / windows / pdflatex.exe.

    Grazie.
    Damiano

Visualizzazione 24 filoni di risposte
  • Autore
    Risposte
    • #63121
      Up
      0
      Down
      ::

      damu” post=62061
      Vorrei semplicemente :
      1. indice clickabile (link) con la pagina del capitolo, coi classici puntini fino al num di pagina

      `\usepackage{hyperref}`

      damu” post=62061
      2. paragrafi e sottoparagrafi non numerati

      `
      \section*{}
      \subsection*{}
      `

      damu” post=62061
      3. intestazione pagina con linea e testo a mia scelta

      `
      \usepackage{fancyhdr}
      `

      (e leggi la documentazione di fancyhdr per impostare il testo “a tua scelta”)

    • #63122
      Up
      0
      Down
      ::


      ciao, io ti posso dire:
      indice cliccabile -> pacchetto hyperref
      paragrafi e sottoparagrafi non numerati -> comandi \section*{} e \subsection*{}

      saluti

    • #63123
      Up
      0
      Down
      ::

      damu” post=62061Ciao, vorrrei abbandonare il wordprocessor a favore di LaTeX, per creare un “template” per la documentazione tecnica dei miei sw.

      Vorrrei quindi concentrarmi sui contenuti e non sulla formattazione.

      Ho letto un sacco di guide, thread e quant’altro ma + leggo, + mi si crea confusione.

      Non pretendo che mi venga postato il codice ma che mi si instradi nella direzione giusta.

      Vorrei semplicemente :
      1. indice clickabile (link) con la pagina del capitolo, coi classici puntini fino al num di pagina
      2. paragrafi e sottoparagrafi non numerati
      3. intestazione pagina con linea e testo a mia scelta

      Io sto provando con la classe document.cls e \tableofcontents ma ma nell’indice non mette mette ine link, ne puntini, ed i paragrafi sono numerati.
      Forse la classe document non è quella guista ? ma nella “mica tanto breve..” sembrava la + calzante.

      Uso MikTeX 2.9 / windows / pdflatex.exe.

      Grazie.
      Damiano

      In genere si evitano i puntini nel caso dei capitoli. Per avere i collegamenti carica il pacchetto hyperref (per ultimo). Per avere paragrafi non numerati, scrivi
      `\setcounter{secnumdepth}{0}`
      nel preambolo, in modo che solo i capitoli siano numerati; paragrafi di primo e secondo livello andranno specificati con i normali \section e \subsection e andranno automaticamente nell’indice. Per le testatine, pacchetto fancyhdr.

      Ciao
      Enrico

    • #63124
      Up
      0
      Down
      ::


      Grazie a tutti per le dritte !!
      Mi avete sbloccato !

      Ho 1problema con l’underscore:

      data\_lavorazione stampa data lavorazione
      \_ stampa spazio

      \begin{verbatim} _ \end{verbatim} stampa _

      dove sbaglio ?

    • #63125
      Up
      0
      Down
      ::


      intanto che aspetti che arrivi qualcuno più esperto di me, cosa carichi e con che opzioni nel preambolo? Magari mi sbaglio di grosso, ma online ho visto solo 2 occasioni di questo problema: quando usi latin1 come opzione di inputenc su linux e quando usi OT1 al posto di T1 come opzione di fontenc.
      Purtroppo non sono riuscito a replicare il problema in locale (solo con OT1 non mi va, ma proprio non ottengo il carattere neanche nel file .tex).
      saluti

    • #63126
      Up
      0
      Down
      ::


      Nono, sei andato alla grande !
      Era il secondo caso : l’unico pck che includevo era babel, e quindi per default, il compilatore che sto usando prende “OT1”.
      Anche includendo fontenc, senza opzioni, l’underscore è uno spazio.
      Dunque col mio compilaore (This is pdfTeX, Version 3.1415926-2.3-1.40.12 (MiKTeX 2.9)), win 7, bisogna specificare l’opzione OT !

      Grazie.
      Damiano

    • #63127
      Up
      0
      Down
      ::


      No problem,
      ti raccomando, comunque, una lettura dell’Arte

    • #63128
      Up
      0
      Down
      ::


      Cortesemente,
      Ho cercato a lungo in rete, e nei man a mia disposizione, un componente per inserire i blocchi di codice (c++/sql), boxxati, ed in “modalità verbatim”.
      Non avendone trovati sto cercando di definirmelo da solo:

      \newcommand{\scatola}[1] {
      \fbox{\begin{minipage}[t]{1\textwidth} #1 \end{minipage}}
      }

      \newenvironment {codice}[1] {
      \scatola{\verb=#1=}
      }

      ho provato anche ad usare l’env verbatim, con \end{verbatim} nell’endcode del mio env codice, ma non riesco a farlo funzionare.
      Dove sbaglio ?

      Grazie.
      Damiano

    • #63129
      Up
      0
      Down
      ::


      non so cosa tu intenda per “boxxati” comunque per listati di programmazione c’è l’ottimo pacchetto “listings” che ti raccomando. Molto ben fatto e personalizzabile. E penso che abbia già SQL e C++ come linguaggi.
      EDIT: ne parla anche l’Arte a pag 76.
      ripeto te ne raccomando caldamente una lettura oppure almeno di considerarla come primo riferimento in caso di problemi
      Saluti

    • #63130
      Up
      0
      Down
      ::


      Perfetto, grazie. Mi guardo le docu di quel pck.

      Per boxxato intendevo messo in un riquadro, in pratica quello che fa il mio comando “scatola”.

      Grazie ancora per l’aiuto e la celerità delle tue risposte.

      Ciao
      Damiano

      EDIT
      E’, immagino che sia valida quella guida, era una delle prime che avevo adocchiato.
      Problemone : non riesco a personalizzare il colore del font col reader pdf = backgeuond e testo nero.
      Leggerlo cpn bg bianco mi uccide e quindi me lo sto prendendo a piccole dosi..
      E’ la 1a volta che mi capita.. insomma tt per dirti che nn sono unoi di quelli che nn ha voglia di leggere i manuali.

      Ciao

    • #63131
      Up
      0
      Down
      ::


      Ciao,

      si con il pacchetto listings puoi personalizzare veramente tantissimo le tue box: puoi, per esempio, colorare lo sfondo, usare diversi riquadri. Inoltre listings ti permette facilmente di evidenziare le key word del codice!!! Ad esempio:
      `
      \lstset{language=SQL,%
      basicstyle=\scriptsize\ttfamily,%
      commentstyle=\color{blue},%
      keywordstyle=\color{red}\bf,%
      showstringspaces=false,
      numbers=left, numberstyle=\scriptsize}
      `

    • #63132
      lorenzo.pantieri
      Partecipante
      • #63133
        Up
        0
        Down
        ::


        Cortesemente,
        nel mio preambolo

        \lstset{
        language=SQL,
        basicstyle=\scriptsize\ttfamily, commentstyle=\color{blue},
        keywordstyle=\color{red}\bf,
        showstringspaces=false,
        %numbers=left,
        numberstyle=\scriptsize,
        frame=single,
        breaklines=true,
        stepnumber=5
        }

        Chiamando

        \lstinline/TMP_STATS_PCK.DUMP_LAVO_PROV (‘UD’, TO_DATE (‘20090101′,’YYYYMMDD’), TO_DATE (‘20091231′,’YYYYMMDD’), ‘SORGENTE_SITICLIENT_VECCHIO’);/

        non prende tutti i settings, uno per tutti, frame=single.
        Ho letto “L’arte di scrivere codice” (nel senso “mi sono ducmentato”), e cercato in rete, non ho trovato alcuna nota che dice che la chiamata inline non supporta tutte le opzioni della versione “ambiente” begin/end o che lstset non ha effetto sulla versione inline.
        E’ + una questione di principio diciamo…potrei usare sempre e solo begin/end..ma dato che devo mettere sql in item, la versione inline mi sembra + calzante.

        Grazie.
        Damiano

      • #63134
        Up
        0
        Down
        ::


        E’ vero: infatti la versione inline è perfetta se usata con gli elenchi, dove, ad esempio, non è carino vedere le righe del codice o il riquadro.
        Usare l’ambiente lstlisting è, invece, preferibile quando riporti lunghi listati.

      • #63135
        Up
        0
        Down
        ::


        Ah ok, quindi è cosa voluta e non un baco o un mio errore.

        Grazie.
        Damiano

      • #63136
        Up
        0
        Down
        ::


        Cortesemente, non trovo l’opzione o comando, se esiste, per far sì che un capitolo cominci in una nuova pagina.

        Grazie
        Damiano

        EDIT:
        In realtà ho suddiviso il mio documento in sezioni/sottosezioni/sotto-sotto-sezioni.
        Con chapter non ottenebo i titoli “grandi”…

        Non so se sbaglio qualcosa o includo qualche pachhetto che non va bene

        Grazie

      • #63137
        OldClaudio
        Partecipante
          Up
          0
          Down
          ::


          Se usi la classe article il comando \chapter non è definito; se usi book o report, \chapter manda su una nuova pagina automaticamente, sempre. Se usi altre classi, per favore dicci quale classe usi, e possibilmente, se è book o report, facci vedere anche il tuo preambolo (tutto quanto da \documentclass a \begin{document}.

        • #63138
          Up
          0
          Down
          ::


          Hai ragione:

          \documentclass[a4paper,12pt,italian]{article}
          \usepackage[italian]{babel}
          \usepackage[T1]{fontenc}
          \usepackage{verbatim}
          \usepackage{moreverb}
          \usepackage{listings}
          \usepackage{color}
          \usepackage{parskip}
          \usepackage{hyperref}
          \usepackage{fancyhdr}

          \title{Statistiche lavorazioni SITI}
          \author{Damiano}

          \lstset{language=SQL,
          basicstyle=\scriptsize\ttfamily,
          commentstyle=\color{blue},
          keywordstyle=\color{red}\bf,
          showstringspaces=false,
          numbers=left,
          numberstyle=\scriptsize,
          breaklines=true,
          stepnumber=2
          }
          \pagestyle{fancy}
          \fancyhead{}

          \newcommand {\sezione}[1] {
          \newpage
          \rhead{\thesection\ #1}
          \section{#1}
          }

          Il mio scopo è produrre documentazione tecnica di software, avevo letto sui manuali latex che document.cls è la più indicata.
          Sempre dai manuali avevo capito che, sempre per document.cls, la gerarchia fosse : capitolo->sezione->sottosezione…
          Ma con \chapter, a differenza di sezione, non mi manda a capo il testo, non mette in neretto, o comunque in evidenza, il nome del capitolo..etc quindi sono partito dalla sezione a scendere saltando il capitolo.

          Se guardi questo accrocchio :

          \newcommand {\sezione}[1] {
          \newpage
          \rhead{\thesection\ #1}
          \section{#1}
          }

          è il mio tentativo di :
          – mettere il \newpage in automatico
          – mettere nell’intestazione solo il capitolo “corrente” che, come ho scritto prima, per me è \section e di omettere le altre “sotto-entità”

          Inoltre mi prendo dei warning di under/over full che non mi spiego ma che devo ancora approfondire ma che al momento non mi spiego.

          %\usepackage{parskip} lo includo volutamente per togliere il rientro.

          Grazie mille

        • #63139
          OldClaudio
          Partecipante
            Up
            0
            Down
            ::


            Stai facendo confusione: parli di una classe document.cls che non esiste e nel tuo preambolo usi la classe article.

            sostituisci article con report e facci saper che cosa succede; togli anche la ridefinizione di \section, che nella classe report si rova sotto al livello di chapter e quindi non serve a niente andare a pagina nuova ad ogni sezione; basta andare a capo ad ogni capitolo.

          • #63140
            Up
            0
            Down
            ::


            Come mi aspettavo ho sistemato una cosa e ne ho rotte altre 2 (dico così perchè capita spesso con altri linguaggi).
            In soldoni:
            – adesso il \chapter si comporta come mi aspettavo, con la sola differenza che in automatico scrive “Capitolo n” e poi dopo il parametro di \chapter{}
            – fancy salta le prime 2 pag dopo il titolo e l’indice; forse perchè compare già la dicitura “Capitolo 1” e “Capitolo 2” e sarebbe ridondante. Mi sembrava di avere letto qualcosa a proposito nelle reference di fancy..ora non ricordo

            In realtà mi servirebbe un tex di una guida tipo la “mica tanto breve guida…” da cui prendere spunto.
            Il layout di quella guida era quello che circa mi prefiggevo di ottenere.
            Di manuali ne ho scaricati e letti a tonnellate, ma vedo che ancora non mi ci ritrovo molto; mi sembra di scrivere html.
            —-
            I sorgenti della guida non sono liberi ?
            Sull’ftp di CTAN non sono a disposizione

            Grazie

          • #63141
            OldClaudio
            Partecipante
              Up
              0
              Down
              ::


              Perché metti \chapter prima dell’indice? l’indice usa \chapter per conto suo.

              Senti, non so se i file sorgente della GuidaGuIT ti possano essere utili, ma dal vecchio sito erano scaricabili col file GuidaGuIT.zip. Pur avendo messo insieme quel lavoro, però, non te lo consiglio, perché la tua conoscenza di LaTeX è modesta e quei file sorgente sono difficili.

            • #63142
              Up
              0
              Down
              ::


              Scusami, mi sono spiegato male.
              Utilizzo \tableofcontents per generare l’indice, e so che matcha in automativo \chapter{}, \section{} e sotto sezioni varie; hyperref per renderli clickabili.

              Solo che, con report, \chapter{mio capitolo} produce:

              Capitolo 1

              Mio capitolo

              “Capitolo 1” è generato dal compilatore, io volevo solamente:

              1 Mio capitolo

              bla bla bla

              Alla fine della fiera, sono tornato su article, e ho definito:

              \newcommand {\creatitolo} {
              \maketitle
              \newpage
              }
              \newcommand {\creaindice} {
              \rhead{Indice generale}
              \tableofcontents
              \newpage
              }
              \newcommand {\sezione}[1] {
              \newpage
              \rhead{\thesection.\ #1}
              \section{#1}
              }

              Immagino non sia il top per gli esperti ma il linguaggio me lo consente ed ottengo ciò che volevo.

              Per il discorso sorgenti, cerco nel vecchio sito.

              Grazie
              Damiano

            • #63143
              OldClaudio
              Partecipante
                Up
                0
                Down
                ::


                Ti sarebbe bastato ridefinire \chaptername con
                `
                \renewcommand\chaptername{}
                `
                e ottenvi il risultato corretto anche con report; io sono un po’ duro di comprendonio e qualche volta fraintendo le spiegazioni, talvolta non molto chiare, che leggo sul forum.:neutral:

              • #63144
                Up
                0
                Down
                ::


                Ma figurati, non c’è problema !
                Io cerco di stringare il + possibile per non fare post kilometrici sacrificando a volte la comprensibilità.

                Alla fine senza voi del forum sarei ancora daccapo!

                Se riesco a non usare “accrocchi” tipo il mio meglio, poi a volte ci si arrangia come si può.. 🙂

                Domani vedo come va con report allora..

                Grazie
                Damiano

              • #63145
                Up
                0
                Down
                ::


                Ditemi cortesemente se l’approccio è corretto :
                devo creare un riquadro (rettangolo bordato per intenderci) a pié di pagina, diviso in 3 parti, parti che contengono testo (il layout del mio documento mi viene imposta).

                Io definirei nel \fancyfoot{} una tab senza bordo, 1riga – 3cols, e racchiusa in un \framebox.

                Al di là della domanda imbecille, che mi farà ottenere il piè di pagina desiderato, mi dirà se l’approccio che ho preso con gli oggetti latex è corretto.

                Grazie
                Damiano

            Visualizzazione 24 filoni di risposte
            • Devi essere connesso per rispondere a questo topic.

            Go to top