TIVI-153: add as dependency for iputils
[profile/ivi/perl-SGMLSpm.git] / DOC / HTML / sgmlspl / definition.html
1 <HTML>
2 <HEAD>
3 <TITLE>What is sgmlspl?</TITLE>
4 </HEAD>
5 <BODY>
6
7 <P><B>Links</B>: <A HREF=installation.html>Next</A> <A HREF=terms.html>Previous</A> <A HREF=sgmlspl.html>Up</A> <A HREF=sgmlspl.html>Top</A></P>
8
9 <H1>What is <A HREF=sgmlspl.html><TT>sgmlspl</TT></A>?</H1>
10
11 <P><A HREF=sgmlspl.html><TT>sgmlspl</TT></A> is a sample application distributed with the
12 <A HREF="../SGMLSpm/sgmlspm.html"><TT>SGMLS.pm</TT></A> <A HREF="http://www.metronet.com/0/perlinfo/perl5/manual/perl.html"><TT>perl5</TT></A> class library -- you can use it to convert
13 <A HREF="http://www.sil.org/sgml/sgml.html"><B>SGML</B></A> documents to other formats by providing a <A HREF=specs.html><I>specification file</I></A>
14 detailing exactly how you want to handle each element, external data
15 entity, subdocument entity, CDATA string, record end, SDATA string,
16 and processing instruction.  <A HREF=sgmlspl.html><TT>sgmlspl</TT></A> also uses the <A HREF=output.html><TT>SGMLS::Output</TT></A>
17 library (included in this distribution) to allow you to redirect or
18 capture output.</P>
19
20 <P>To use <A HREF=sgmlspl.html><TT>sgmlspl</TT></A>, you simply prepare a specification file
21 containing regular <A HREF="http://www.metronet.com/0/perlinfo/perl5/manual/perl.html"><TT>perl5</TT></A> code.  If your <A HREF="http://www.sil.org/sgml/sgml.html"><B>SGML</B></A> document were named
22 <TT>doc.sgml</TT>, your <A HREF=sgmlspl.html><TT>sgmlspl</TT></A> specification file
23 were named, <TT>spec.pl</TT>, and the name of your new
24 file were <TT>doc.latex</TT>, then you could use the
25 following command in a Unix shell to convert your <A HREF="http://www.sil.org/sgml/sgml.html"><B>SGML</B></A> document:</P>
26
27 <P>
28 <PRE>sgmls doc.sgml | sgmlspl spec.pl > doc.latex</PRE>
29 </P>
30 <P><A HREF=sgmlspl.html><TT>sgmlspl</TT></A> will pass any additional arguments on to the specification
31 file, which can process them in the regular <A HREF="http://www.metronet.com/0/perlinfo/perl5/manual/perl.html"><TT>perl5</TT></A> fashion.  The
32 specification files used to convert this manual --
33 <TT>tolatex.pl</TT> and <TT>tohtml.pl</TT>
34 -- are available with the <A HREF="../SGMLSpm/sgmlspm.html"><TT>SGMLS.pm</TT></A> distribution.</P>
35
36
37 <P><B>Links</B>: <A HREF=installation.html>Next</A> <A HREF=terms.html>Previous</A> <A HREF=sgmlspl.html>Up</A> <A HREF=sgmlspl.html>Top</A></P>
38
39
40 <ADDRESS>David Megginson <A HREF="mailto:dmeggins@aix1.uottawa.ca">&lt;dmeggins@aix1.uottawa.ca&gt;</A></ADDRESS>
41 </BODY>
42 </HTML>