.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Refs 3pm"
.TH Refs 3pm "2004-02-22" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
SGMLS::Refs \- Forward reference handling
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use SGMLS::Refs;
.Ve
.PP
To create a new reference-manager object using the file \*(L"foo.refs\*(R":
.PP
.Vb 1
\&  my $refs = new SGMLS::Refs("foo.refs");
.Ve
.PP
To create a new reference-manager object using the file \*(L"foo.refs\*(R" and
logging changes to the file \*(L"foo.log\*(R":
.PP
.Vb 1
\&  my $refs = new SGMLS::Refs("foo.refs","foo.log");
.Ve
.PP
To record a reference:
.PP
.Vb 1
\&  $refs\->put("document title",$title);
.Ve
.PP
To retrieve a reference:
.PP
.Vb 1
\&  $title = $refs\->get("document title");
.Ve
.PP
To return the number of references changed since the last run:
.PP
.Vb 1
\&  $num = $refs\->changed;
.Ve
.PP
To print a LaTeX-like warning if any references have changed:
.PP
.Vb 1
\&  $refs\->warn;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This library can be used together with the \fB\s-1SGMLS\s0\fR package to keep
track of forward references from one run to another, like the \fBLaTeX\fR
\&\f(CW\*(C`.aux\*(C'\fR files.  Each reference manager is an object which reads and
then rewrites a file of perl source, with the file name provided by
the caller.
.PP
Example:
.PP
.Vb 2
\&  # Start up the reference manager before the parse.
\&  sgml(\(aqstart\(aq, sub { $refs = new SGMLS::Refs("foo.refs"); });
.Ve
.PP
.Vb 2
\&  # Warn about any changed references at the end.
\&  sgml(\(aqend\(aq, sub { $refs\->warn; });
.Ve
.PP
.Vb 5
\&  # Look up the title from the last parse, if available.
\&  sgml(\(aq<div>\(aq, sub { 
\&    my $element = shift;
\&    my $id = $element\->attribute(ID)\->value;
\&    my $title = $refs\->get("title:$id") || "[no title available]";
.Ve
.PP
.Vb 1
\&    $current_div_id = $id;
.Ve
.PP
.Vb 2
\&    output "\e\esection{$title}\en\en";
\&  });
.Ve
.PP
.Vb 5
\&  # Save the title for the next parse.
\&  sgml(\(aq<head>\(aq, sub { push_output(\(aqstring\(aq); });
\&  sgml(\(aq</head>\(aq, sub {
\&    my $title = pop_output();
\&    my $id = $current_div_id;
.Ve
.PP
.Vb 2
\&    $refs\->put("title:$id",$title);
\&  });
.Ve
.SH "AUTHOR AND COPYRIGHT"
.IX Header "AUTHOR AND COPYRIGHT"
Copyright 1994 and 1995 by David Megginson,
\&\f(CW\*(C`dmeggins@aix1.uottawa.ca\*(C'\fR.  Distributed under the terms of the Gnu
General Public License (version 2, 1991) \*(-- see the file \f(CW\*(C`COPYING\*(C'\fR
which is included in the \fB\s-1SGMLS\s0.pm\fR distribution.
.SH "SEE ALSO:"
.IX Header "SEE ALSO:"
\&\s-1SGMLS\s0, SGMLS::Output.