[successivo] [precedente] [inizio] [fine] [indice generale] [indice ridotto] [violazione licenza] [translators] [docinfo] [indice analitico] [volume] [parte]

Capitolo 312.   Sgmltexi: installazione e utilizzo

Sgmltexi ⁽¹⁾ è un DTD e un sistema frontale per la composizione in Texinfo a partire da un formato SGML. L'idea alla base di Sgmltexi è quella di avere la possibilità di scrivere un documento Texinfo attraverso la semplificazione e la guida che può dare un sistema SGML.

All'interno di Sgmltexi, la gestione dei nodi di Texinfo può avvenire in modo automatico e trasparente, generando un menù Info unico nel nodo Top. I nomi dei nodi, quando sono generati automaticamente, usano stringhe del tipo «cap 1», «app A»,...

Sgmltexi ha uno schema preciso: ci possono essere una o più introduzioni iniziali; nella parte centrale c'è un corpo che può essere scomposto in vario modo; ci possono essere delle appendici; al termine possono apparire degli indici analitici. Il corpo è organizzato in capitoli, che possono essere raggruppati in parti ed eventualmente anche in tomi. In tal modo, si possono gestire facilmente anche documenti di grandi dimensioni.

312.1   Installazione di Sgmltexi

Sgmltexi è composto da due eseguibili Perl: sgmltexi e sgmltexi-sp2texi. Questi due file devono essere collocati in una directory in cui possono essere avviati senza bisogno di indicare il percorso; in pratica in una directory elencata all'interno della variabile di ambiente PATH.

Evidentemente, è necessario l'interprete Perl; precisamente questi programmi cercano il file /usr/bin/perl. Se il proprio sistema operativo è organizzato diversamente, è necessario intervenire modificando la prima riga dei due eseguibili:

#!/usr/bin/perl
...

Sgmltexi si aspetta di trovare alcuni file:

• /etc/sgmltexi/sgmltexi.cat

  il catalogo SGML di Sgmltexi;

• /etc/sgmltexi/sgmltexi.dcl

  la dichiarazione SGML di Sgmltexi;

• /etc/sgmltexi/sgmltexi.dtd

  il DTD di Sgmltexi;

• /etc/sgmltexi/entities/

  la directory contenente i file delle entità SGML standard.

Tutti questi file dovrebbero trovarsi esattamente dove previsto; in alternativa si devono realizzare almeno dei collegamenti per ricreare i percorsi stabiliti.

312.1.1   Gettext

I messaggi di Sgmltexi possono essere tradotti. Per installare i file PO già esistenti è necessario compilarli come nell'esempio seguente:

$ msgfmt -vvvv -o sgmltexi.mo it.po[Invio]

In questo esempio, il file it.po viene compilato generando il file sgmltexi.mo. Questo file può essere collocato in /usr/share/locale/it/LC_MESSAGES/, o in un'altra posizione analoga in base agli standard del proprio sistema operativo.

Se non è disponibile il modulo Perl-gettext, che serve a Sgmltexi per accedere alle traduzioni, è possibile eliminare il suo utilizzo e simulare la funzione di Gettext. In pratica si commentano le istruzioni seguenti:

# Non si vuole usare gettext.
#use POSIX;
#use Locale::gettext;
#setlocale (LC_MESSAGES, "");
#textdomain ("sgmltexi");

Inoltre, si tolgono i commenti dalla dichiarazione della funzione fittizia gettext(), come si vede qui:

sub gettext
{
    return $_[0];
}

312.1.2   Dipendenze

È il caso di riepilogare le dipendenze di Sgmltexi da altri applicativi:

• Perl

  dal momento che si tratta di un programma scritto in Perl, deve essere presente l'interprete relativo;

• SP o Jade

  per l'analisi SGML occorre il programma nsgmls che fa parte del pacchetto SP o anche del pacchetto Jade;

• Perl-gettext

  per accedere ai messaggi tradotti del programma, è necessario il modulo Perl-gettext, salva la possibilità di escluderne l'utilizzo come è già stato mostrato;

• TeX e Texinfo

  per arrivare a una composizione finale è necessario ovviamente disporre di Texinfo, che potrebbe già essere integrato nella propria distribuzione TeX (di solito si tratta di teTeX).

312.2   Come si usa il programma frontale

Una volta preparato il sorgente in formato Sgmltexi, bisogna utilizzare il programma sgmltexi per controllare l'elaborazione SGML e gli altri applicativi di composizione di Texinfo.

Di solito, la cosa migliore per iniziare lo studio di un sistema di composizione, è partire da un esempio banale, funzionante, che consenta di apprendere l'uso elementare degli strumenti relativi.

<!DOCTYPE Sgmltexi PUBLIC "-//GNU//DTD Sgmltexi//EN">
<sgmltexi lang="it">
<head>
    <admin>
        <setfilename content="esempio.info">
        <settitle content="Esempio">
    </admin>
    <titlepage>
        <title>Esempio</title>
        <subtitle>Un esempio per un documento in formato Sgmltexi</subtitle>
        <abstract>
            <p>Questo è solo un esempio di un documento scritto
            utilizzando Sgmltexi.</p>
        </abstract>
        <author>Pinco Pallino &lt;ppinco@dinkel.brot.dg&gt;</author>
        <legal>
            <copyright>Copyright &copy; 2000 Pinco Pallino</copyright>
            <license>
                <p>Permission is granted to copy, distribute and/or
                modify this document under the terms of the GNU Free
                Documentation License, Version 1.1 or any later version
                published by the Free Software Foundation; with no
                Invariant Sections, with no Front-Cover Texts, and with
                no Back-Cover Texts. A copy of the license is included
                in the section entitled "GNU Free Documentation
                License".</p>
            </license>
        </legal>
    </titlepage>
    <contents>
</head>
<body>
<h1>Esempio generale</h1>

<p>Questo è l'esempio tipico di un capitolo di Sgmltexi...</p>

<p>Non c'è molto da scrivere in questo caso...</p>

</body>
</sgmltexi>

Supponendo di avere installato correttamente Sgmltexi (e anche Texinfo), supponendo inoltre che il file si chiami prova.sgml, si possono usare i comandi seguenti:

• $ sgmltexi --sgml-check prova.sgml[Invio]

  per verificare la correttezza formale dell'SGML;

• $ sgmltexi --texi prova.sgml[Invio]

  per ottenere semplicemente il file prova.texinfo, in formato Texinfo;

• $ sgmltexi --info prova.sgml[Invio]

  per ottenere il file prova.info, in formato Info;

• $ sgmltexi --dvi prova.sgml[Invio]

  per ottenere il file prova.dvi, in formato DVI;

• $ sgmltexi --ps prova.sgml[Invio]

  per ottenere il file prova.ps, in formato PostScript;

• $ sgmltexi --pdf prova.sgml[Invio]

  per ottenere il file prova.pdf, in formato PDF;

• $ sgmltexi --html prova.sgml[Invio]

  per ottenere il file prova.html, in formato HTML;

• $ sgmltexi --xml prova.sgml[Invio]

  per ottenere il file prova.xml, in formato XML di Texinfo;

• $ sgmltexi --docbook prova.sgml[Invio]

  per ottenere il file prova.xml, in formato XML di Docbook.

La sintassi di sgmltexi è quella che si vede nello schema seguente:

sgmltexi [opzioni] sorgente_sgml

In generale, è bene che il nome del file sorgente in formato Sgmltexi abbia l'estensione standard .sgml.

--help

--version

--force

--number-sections

--clean

--verbose

--input-encoding=codifica

--sgml-include=entità_parametrica

--include=entità_parametrica

--paper=formato_composizione

--setchapternewpage={on\
  \|off|odd}

--footnotestyle={end|separate}

--headings={on|off|single\
  \|double|singleafter|doubleafter}

--sgml-syntax

--sgml-check

--sp

--texi

--texinfo

--dvi

--ps

--postscript

--pdf

--info

--text

--html

--xml

--docbook

• $ sgmltexi --sgml-syntax prova.sgml[Invio]

  Analizza la validità formale del sorgente prova.sgml.

• $ sgmltexi --ps prova.sgml[Invio]

  Genera un risultato in formato PostScript attraverso l'aiuto di texi2dvi e di dvips.

312.3   Riferimenti

• Daniele Giacomini, Sgmltexi

  <http://cdn.mirror.garr.it/mirrors/appuntilinux/software/>

• Gaetano Paolone, Sgmltexi, pacchetto GNU/Linux Debian

  <http://packages.debian.org/sgmltexi>

  <http://ftp.debian.org/debian/pool/main/s/sgmltexi/>

Appunti di informatica libera 2006.01.01 --- Copyright © 2000-2006 Daniele Giacomini -- <daniele (ad) swlibero·org>, <daniele·giacomini (ad) poste·it>

1) Sgmltexi   GNU GPL

Dovrebbe essere possibile fare riferimento a questa pagina anche con il nome sgmltexi_installazione_e_utilizzo.htm

[successivo] [precedente] [inizio] [fine] [indice generale] [indice ridotto] [violazione licenza] [translators] [docinfo] [indice analitico]