File: README

package info (click to toggle)
libsgmls-perl 1.03ii-20
  • links: PTS
  • area: main
  • in suites: woody
  • size: 632 kB
  • ctags: 152
  • sloc: perl: 1,557; lisp: 262; makefile: 161
file content (105 lines) | stat: -rw-r--r-- 3,201 bytes parent folder | download | duplicates (8)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
	   SGMLS.PM: A PERL5 CLASS LIBRARY FOR USE WITH THE
		       SGMLS AND NSGMLS PARSERS

			     Version 1.03ii


			   David Megginson,
			 University of Ottawa


[This is the fourth public release.  See "CHANGES", below, for a
summary of the most important changes since version 1.02.  For
detailed changes, see ChangeLog and DOC/ChangeLog; for known bugs, see
BUGS.]


This distribution contains SGMLS.pm, a perl5 class library for parsing
the output from James Clark's SGMLS and NSGMLS parsers.  This is a
free package, but it is _not_ Public-Domain software -- please see the
file COPYING in this directory for the terms of use.

Full documentation is available in SGML format the DOC directory, and
in Postscript, LaTeX, and HTML format in the various subdirectories of
the DOC directory.  Documentation in POD format is also included
within each of the modules, and once they are installed, you can view
them with perldoc (SGMLS, SGMLS::Ouptut, or SGMLS::Refs) -- there is
no POD documentation in sgmlspl yet.

Take a look in the elisp/ subdirectory for a special package for Gnu
Emacs -- it will allow you to run (n)sgmls and sgmlspl from within an
Emacs buffer containing an SGML file, displaying the output (LaTeX,
for example) in another Emacs buffer.

I have included a Unix Makefile for installing the package on Unix and
Unix-like systems.  Make any necessary changes at the top of the
Makefile, then type

  make install

to install the perl5 scripts on your system.  If you want to test the
installation, change to the DOC subdirectory, read the comments at the
top of the make file there, then type

  make clean; make all

to regenerate the LaTeX and HTML documentation using the scripts which
you have just installed (you will have to have the SGMLS or NSGMLS
parser, the Docbook 2.2.1 DTD and SGML declaration, and the ISOpub and
ISOnum entity sets available on your system -- copies are included in
the DOC/Extras subdirectory).  You may also type

  make dvi

or

  make ps

to produce DVI or Postscript versions of the documentation for
printing.


** nb: Effective with v.1.02, SGMLS.pm supports the new output from
NSGMLS 0.4.13 with the -h option.


CHANGES

There have been some major changes since version 1.02.  File handles
passed as arguments to SGMLS::new should be qualified in the correct
package now.  The Output.pm module has been moved, so you should now
type

  use SGMLS::Output;

instead of

  use Output;

in all of your scripts.  There is also a new package, SGMLS::Refs, to
maintain a database of forward references from one processing pass to
another, like the LaTeX .aux files.  Once you have installed SGMLS.pm,
you can type

  perldoc SGMLS::Refs

at the shell prompt for more information, or you can read the new
section in the SGML documentation for sgmlspl.  All of the
documentation for this package is available online through my home
page, listed below.

As mentioned above, there is also a convenient package for Gnu Emacs
19 in the elisp/ directory.


Enjoy!

David Megginson


EMAIL: dmeggins@aix1.uottawa.ca
WWW: http://www.uottawa.ca/~dmeggins
Canada Post: Department of English,
             University of Ottawa,
             Ottawa, CANADA