.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" Standard preamble: .\" ======================================================================== .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" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "Refs 3pm" .TH Refs 3pm "2016-10-08" "perl v5.24.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .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"); }); \& \& # Warn about any changed references at the end. \& sgml(\*(Aqend\*(Aq, sub { $refs\->warn; }); \& \& # Look up the title from the last parse, if available. \& sgml(\*(Aq
\*(Aq, sub { \& my $element = shift; \& my $id = $element\->attribute(ID)\->value; \& my $title = $refs\->get("title:$id") || "[no title available]"; \& \& $current_div_id = $id; \& \& output "\e\esection{$title}\en\en"; \& }); \& \& \& # Save the title for the next parse. \& sgml(\*(Aq\*(Aq, sub { push_output(\*(Aqstring\*(Aq); }); \& sgml(\*(Aq\*(Aq, sub { \& my $title = pop_output(); \& my $id = $current_div_id; \& \& $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.