Classe per la produzione di Manuale d’Uso

  • Creatore
    Topic
  • #79273
    Umberto
    Partecipante
      Up
      0
      Down
      ::


      Volevo sapere se qualcuno ha esperienza nella produzione / gestione di manuali utente in LaTeX (NON manuale d’uso di LaTeX, ma LaTeX per manuale d’uso :)).
      Benche’ le problematiche siano abbastanza differenti da quelle tipiche dei documenti più indicati per essere gestiti con LaTeX (la mia esperienza è attualmente limitata alle tesi universitarie) vorrei approfondire l’argomento non solo perche’ non amo (eufemismo) Word, ma soprattutto perche’ dovrebbe essere più semplice predisporre un pacchetto multilingua.

      Grazie
      Umberto

    Visualizzazione 18 filoni di risposte
    • Autore
      Risposte
      • #79274
        Up
        0
        Down
        ::

        umberto” post=78373Volevo sapere se qualcuno ha esperienza nella produzione / gestione di manuali utente in LaTeX (NON manuale d’uso di LaTeX, ma LaTeX per manuale d’uso :)).
        Benche’ le problematiche siano abbastanza differenti da quelle tipiche dei documenti più indicati per essere gestiti con LaTeX (la mia esperienza è attualmente limitata alle tesi universitarie) vorrei approfondire l’argomento non solo perche’ non amo (eufemismo) Word, ma soprattutto perche’ dovrebbe essere più semplice predisporre un pacchetto multilingua.

        Grazie
        Umberto

        Benvenuto!

        La domanda è un po’ troppo generica per poterti dare un consiglio.
        Che tipo di manuale devi comporre? Sarà in forma cartacea o elettronica?

        Ciao
        Ivan

      • #79275
        Umberto
        Partecipante
          Up
          0
          Down
          ::


          Ringrazio innanzitutto per il benvenuto!

          Per meglio definire il quesito approfitto delle ottime funzionalità dell’interfaccia per allegare un esempio di manuale d’uso, che vorrei provare a gestire con LaTeX.

          E’ chiaro fin dall’inizio che la formattazione originale non potrà essere rispettata e che si dovrà accettare qualche compromesso.

          Per quanto riguarda le modalità di diffusione, nonostante il generale impegno nel passare a formati elettronici (dove si potrebbe già fare molto in html), la carta è sempre richiesta, dunque parliamo di un documento cartaceo il cui pdf viene comunque reso disponibile in formato elettronico.

          Grazie, ciao.
          Umberto

        • #79276
          robitex
          Amministratore del forum
            Up
            0
            Down
            ::


            Ciao.
            Ti segnalo una discussione che potrebbe interessarti:
            http://www.guitex.org/home/it/forum/5-tex-e-latex/76860-manuale-tecnico-aggiornabile
            In più, che non compare nessun allegato nel tuo messaggio precedente (attenzione alle dimensioni troppo grandi del file).

            Inoltre ti ringrazio vivamente perché in tanto tempo sei uno dei pochi, forse l’unico, ad aver ringraziato del benventuo.
            Buon TeX!
            R.

          • #79277
            Umberto
            Partecipante
              Up
              0
              Down
              ::


              Effettivamente ho modificato ripetutamente le dimensioni dell’allegato, ma non sono riuscito a farlo passare (ultimo tentativo 198 Kb).

              Sai quale è il limite, senza farmi andare a controllare nelle indicazioni del sito?!

              Nel frattempo andrò a consultare la discussione che mi hai gentilmente indicato.

              Grazie, ciao.
              Umberto

            • #79278
              robitex
              Amministratore del forum
                Up
                0
                Down
                ::


                Le dimensioni max dei file sono 120 KB, delle immagini 150KB.
                Ciao

              • #79279
                OldClaudio
                Partecipante
                  Up
                  0
                  Down
                  ::

                  Effettivamente ho modificato ripetutamente le dimensioni dell’allegato, ma non sono riuscito a farlo passare (ultimo tentativo 198 Kb).

                  Quando poi scriverai il manuale, ricordati di usare le unità di misura giuste. 🙁
                  Quello che tu hai scritto significa chilo bit, anzi per essere più precisi, significa kelvin bit, non chilo byte. 😆
                  In ogni caso chilo byte si scrive KiB secondo le norme ISO.:wink:


                  @robitex
                  : questa osservazione vale anche per te.

                • #79280
                  robitex
                  Amministratore del forum
                    Up
                    0
                    Down
                    ::

                    OldClaudio” post=78385

                    Effettivamente ho modificato ripetutamente le dimensioni dell’allegato, ma non sono riuscito a farlo passare (ultimo tentativo 198 Kb).

                    Quando poi scriverai il manuale, ricordati di usare le unità di misura giuste. 🙁
                    Quello che tu hai scritto significa chilo bit, anzi per essere più precisi, significa kelvin bit, non chilo byte. 😆
                    In ogni caso chilo byte si scrive KiB secondo le norme ISO.:wink:


                    @robitex
                    : questa osservazione vale anche per te.

                    Grazie Claudio,
                    le abitudini, specie quelle secolari, sono dure a morire…
                    R.

                  • #79281
                    Umberto
                    Partecipante
                      Up
                      0
                      Down
                      ::

                      OldClaudio” post=78385

                      In ogni caso chilo byte si scrive KiB secondo le norme ISO.

                      No vorrei nè andare fuori tema, visto che si parlava di LaTeX per produrre manuali d’uso, nè fare il pignolo, visto che sono l’ultimo arrivato, comunque qui c’è scritta una cosa diversa:
                      http://it.wikipedia.org/wiki/Kilobyte

                      Umberto

                    • #79282
                      Umberto
                      Partecipante
                        Up
                        0
                        Down
                        ::


                        Questo è il manuale d’esempio che volevo allegare fin dall’inizio, finalmente ridotto alle dimensioni opportune.

                        Umberto

                        Attachments:
                        You must be logged in to view attached files.
                      • #79283
                        OldClaudio
                        Partecipante
                          Up
                          0
                          Down
                          ::

                          umberto” post=78388

                          In ogni caso chilo byte si scrive KiB secondo le norme ISO.

                          No vorrei nè andare fuori tema, visto che si parlava di LaTeX per produrre manuali d’uso, né fare il pignolo, visto che sono l’ultimo arrivato, comunque qui c’è scritta una cosa diversa:
                          http://it.wikipedia.org/wiki/Kilobyte

                          Umberto

                          Infatti in quel sito di Wikipedia devi guardare la metà di destra della tabella, non la metà di sinistra; e se anche è lecito usare k per 1000 e Ki per 2^{10}=1024, la scrittura K è errata, come è errato l’uso di Kilobyte nel nome della pagina web di Wikipedia.
                          La stessa pagina Wikipedia dice che l’abitudine di scrivere come capita rende abbastanza confusa l’interpretazione di chilo. (ma non rende confusa l’interpretazione di kelvin, anche se la quai totalità degli italiani non sa distinguere fra k e K — retaggio dell’autarchia dei tempi passati che sopravvive nella scuola elementare dove ancora oggi si insegna che l’alfabeto italiano è fatto di 21 lettere — e i bambini italiani che si chiamano Jessica, Katia, Walter, Xavier, Yuri come fanno a scrivere i loro nomi?).

                          Non è per pignoleria che ho scritto quello che ho scritto, ma è la mia battaglia persa in partenza per convincere almeno gli utenti di LaTeX a scrivere metrologicamente in modo corretto; se piace loro l’uso di LaTeX per produrre bei documenti composti correttamente, dovrebbe piacere loro che siano anche scritti correttamente anche nei dettagli; non sto parlando di refusi, che scappano a tutti, ma di errori.

                          E parlando di manuali d’uso, per giunta multilingue, la correttezza metrologica, se mai nel manuale si parlasse di qualche quantità fornita di misura e unità di misura, fa parte della correttezza generale.

                        • #79284
                          Up
                          0
                          Down
                          ::

                          OldClaudio” post=78393

                          [quote=”OldClaudio” post=78385]

                          In ogni caso chilo byte si scrive KiB secondo le norme ISO.

                          No vorrei nè andare fuori tema, visto che si parlava di LaTeX per produrre manuali d’uso, né fare il pignolo, visto che sono l’ultimo arrivato, comunque qui c’è scritta una cosa diversa:
                          http://it.wikipedia.org/wiki/Kilobyte

                          Umberto

                          Infatti in quel sito di Wikipedia devi guardare la metà di destra della tabella, non la metà di sinistra; e se anche è lecito usare k per 1000 e Ki per 2^{10}=1024, la scrittura K è errata, come è errato l’uso di Kilobyte nel nome della pagina web di Wikipedia.
                          La stessa pagina Wikipedia dice che l’abitudine di scrivere come capita rende abbastanza confusa l’interpretazione di chilo. (ma non rende confusa l’interpretazione di kelvin, anche se la quai totalità degli italiani non sa distinguere fra k e K — retaggio dell’autarchia dei tempi passati che sopravvive nella scuola elementare dove ancora oggi si insegna che l’alfabeto italiano è fatto di 21 lettere — e i bambini italiani che si chiamano Jessica, Katia, Walter, Xavier, Yuri come fanno a scrivere i loro nomi?).

                          Non è per pignoleria che ho scritto quello che ho scritto, ma è la mia battaglia persa in partenza per convincere almeno gli utenti di LaTeX a scrivere metrologicamente in modo corretto; se piace loro l’uso di LaTeX per produrre bei documenti composti correttamente, dovrebbe piacere loro che siano anche scritti correttamente anche nei dettagli; non sto parlando di refusi, che scappano a tutti, ma di errori.

                          E parlando di manuali d’uso, per giunta multilingue, la correttezza metrologica, se mai nel manuale si parlasse di qualche quantità fornita di misura e unità di misura, fa parte della correttezza generale.

                          Offtopic

                          Perdonate l’offtopic ma sono molto incuriosito dalla questione descritta da Claudio. Fermo restando che sono piuttosto analfabeta riguardo alle norme ISO, quella dell’unità di misura KiB mi giunge veramente nuova. Da quanto tempo esiste questa dizione? Perché nessuno la pubblicizza e soprattutto la utilizza? Confesso che la prima volta che l’ho vista, l’ho vista scritta da Claudio e credevo fosse un refuso!

                          Ciao,

                          Andrea

                        • #79285
                          OldClaudio
                          Partecipante
                            Up
                            0
                            Down
                            ::


                            Hai presente la Guida GuIT e l’appendice sulla simbologia e le unità di misura?

                            Hai presente che alla fine del primo capitolo sulla composizione della matematica semplice c’è un lungo paragrafo sulla metrologia con una divertente descrizione di alcuni strafalcioni comuni?

                            Comunque le norme ISO UNI in Italia hanno valore di legge, ma a differenza delle leggi non sono pubblicate sulla Gazzetta Ufficiale, ma sono stampate a cura dell Ente Nazionale di Unificazione di Milano, che si fa pagare le copie come se fossero stampate su foglia d’oro.

                            Per questo motivo consiglio sempre di scaricare dal sito del NIST (National Institute for Scence and Tecnology, USA — mi spiace Andrea ma è in inglese — la perfida Albione è sempre in agguato 😉 ) il documento sp811.pdf che oltre a contenere le norme ISO parafrasate, contiene anche le istruzioni per scrivere in modo metrologicamente corretto. Tranne qualche piccola cosa che si applica solo all’inglese americano, il tutto è molto, molto ben fatto.

                          • #79286
                            robitex
                            Amministratore del forum
                              Up
                              0
                              Down
                              ::


                              Il K maiuscolo sono i gradi Kelvin giusto? Non il moltiplicatore del fattore 1000 dell’unità base!
                              R.

                              Ps. sarà ancche ben fatto ma sembra che il documento del NIST sia fatto in Word… peccato.

                            • #79287
                              admin
                              Amministratore del forum
                                Up
                                0
                                Down
                                ::

                                robitex” post=78403Il K maiuscolo sono i gradi Kelvin giusto?

                                Forse è meglio dire solo Kelvin e non gradi Kelvin, giusto? 🙂

                                Ciao
                                Orlando

                              • #79288
                                OldClaudio
                                Partecipante
                                  Up
                                  0
                                  Down
                                  ::


                                  È ancora meglio dire kelvin, con la lettera minuscola, come si dice volt e non Volt, come si dice newton e non Newton. Norme ISO, non è una idea mia, ma lo vuole la grammatica si tratta di nomi comuni non di nomi propri anche se derivano da (co)gnomi propri.

                                • #79289
                                  Umberto
                                  Partecipante
                                    Up
                                    0
                                    Down
                                    ::

                                    robitex” post=78381Ciao.
                                    Ti segnalo una discussione che potrebbe interessarti:
                                    http://www.guitex.org/home/it/forum/5-tex-e-latex/76860-manuale-tecnico-aggiornabile
                                    Buon TeX!
                                    R.

                                    Ti ringrazio per l’indicazione, in effetto ho trovato molti spunti interessanti.
                                    Avevo cercato anche io nel forum prima di formulare il mio quesito, ma non ci ero arrivato, forse anche perché le ricerche che comprendono “manuale” ti riportano frequentemente a quesiti riguardanti il manuale d’uso di LaTeX stesso.

                                    Nel caso possa interessare a qualcun altro, rimando a quanto ancora ho trovato in materia cercando in giro:
                                    http://tex.stackexchange.com/questions/3852/latex-template-for-a-technical-reference-manual-user-guide
                                    http://tex.stackexchange.com/questions/4500/writing-manpage-reference-manual-for-software-in-latex

                                    Ciao
                                    Umberto

                                  • #79290
                                    Up
                                    0
                                    Down
                                    ::

                                    OldClaudio” post=78408È ancora meglio dire kelvin, con la lettera minuscola, come si dice volt e non Volt, come si dice newton e non Newton. Norme ISO, non è una idea mia, ma lo vuole la grammatica si tratta di nomi comuni non di nomi propri anche se derivano da (co)gnomi propri.

                                    Almeno su questo sono preparato! Mi dispiace di essermi perso la parte sulle unità di misura nella Guida GuIT. Tuttavia, ho trovato informazioni utili anche nell’altra guida alla quale hai collaborato: saper comunicare. Ho capito bene, adesso, la differenza tra KiB e kB, ma concordo con @robitex che le abitudini secolari sono difficili da cambiare. Ci proverò, comunque! Grazie Claudio.

                                    Andrea

                                  • #79291
                                    Liverpool
                                    Partecipante
                                      Up
                                      0
                                      Down
                                      ::


                                      [OT]

                                      Spoiler

                                      logos” post=78396Fermo restando che sono piuttosto analfabeta riguardo alle norme ISO, quella dell’unità di misura KiB mi giunge veramente nuova. Da quanto tempo esiste questa dizione?

                                      Esiste ufficialmente dalla fine degli anni 90 come norma IEC (’98 o ’99). Era stata proposta dall’IDCNS (IUPAC) credo intorno al ’95 e su documenti non ufficiali, diciamo un anno prima. Il BIPM non ne parla nella 7a edizione del suo documento ufficiale (1998), mentre la cita a margine dell’8a (2006) incoraggiandone l’utilizzo.

                                      Tra i nomi delle unità, fa eccezione il grado Celsius.


                                      @OldClaudio
                                      , Umberto si riferiva al fatto che hai scritto “chilo byte” insieme a “KiB”. Comunicazione di servizio: ti ho scritto il riferimento bibliografico mancante nella conversazione sull’effetto transistore. Sinceramente quell’argomento l’ho trovato solo su due libri e non mi ha mai convinto pienamente (lo trovo un po’ troppo disinvolto).

                                      [/OT]

                                      Ciao

                                    • #79292
                                      OldClaudio
                                      Partecipante
                                        Up
                                        0
                                        Down
                                        ::

                                        Comunicazione di servizio: ti ho scritto il riferimento bibliografico mancante nella conversazione sull’effetto transistore. Sinceramente quell’argomento l’ho trovato solo su due libri e non mi ha mai convinto pienamente (lo trovo un po’ troppo disinvolto).

                                        Ti confesso che ho ricevuto il messaggio di servizio, ma sono impegnato in tali e tante cose che non ho avuto tempo di esaminarlo, né mi ricordo nemmeno più di cosa si trattasse. Devo andare a ripassare, perché la mia memoria non è più quella di un tempo.

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

                                    Go to top