.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "DocBookParser 3pm"
.TH DocBookParser 3pm 2025-09-28 "Lire 2.1.1" "LogReport's Lire 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
Lire::XMLParser \- Base DocBook parser.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    package MyParser;
\&
\&    use base qw/ Lire::XMLParser /;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This package contains a Lire::XMLParser DocBook parser. It defines the
relevant \f(CW\*(C`_start\*(C'\fR, \f(CW\*(C`_end\*(C'\fR and \f(CW\*(C`_char\*(C'\fR methods for the DocBook
subset used by Lire. All defined handlers have the form
\&\f(CW\*(C`dbk_\fR\f(CIname\fR\f(CW_start\*(C'\fR, \f(CW\*(C`dbk_\fR\f(CIname\fR\f(CW_end\*(C'\fR and \f(CW\*(C`dbk_\fR\f(CIname\fR\f(CW_char\*(C'\fR (when
the element accepts PCDATA content).
.PP
Its base functionality is to collect the DocBook markup for later use.
It will subclassed most of the time.
.SH "CLIENT METHODS"
.IX Header "CLIENT METHODS"
.SS \fBdbk_init()\fP
.IX Subsection "dbk_init()"
Subclasses should call this method whenever the state of the DocBook
parse should start. This is called from the \fBparse_start()\fR method when
the parser is used standalone.
.SS \fBdbk_string()\fP
.IX Subsection "dbk_string()"
Returns the DocBook XML accumulated by the parser. This is returned
from \fBparse_end()\fR method when used standalone.
.SH "XML SPECIFICATIONS METHODS IMPLEMENTATION"
.IX Header "XML SPECIFICATIONS METHODS IMPLEMENTATION"
.SS \fBnamespaces()\fP
.IX Subsection "namespaces()"
DocBook doesn\*(Aqt use namespace, so this method returns an empty hash reference.
.SS \fBelements_spec()\fP
.IX Subsection "elements_spec()"
Returns the elements specification for the DocBook subset supported by
Lire.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.Vb 2
\& Lire::XMLParser(3pm), Lire::ReportParser::AsciiDocBookFormatter(3pm),
\& Lire::ReportParser::HtmlDocBookFormatter(3pm)
.Ve
.SH AUTHOR
.IX Header "AUTHOR"
.Vb 1
\&  Francis J. Lacoste <flacoste@logreport.org>
.Ve
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR DocBookParser.pm,v 1.4 2006/07/23 13:16:29 vanbaal Exp $
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2004 Stichting LogReport Foundation LogReport@LogReport.org
.PP
This file is part of Lire.
.PP
Lire is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program (see COPYING); if not, check with
http://www.gnu.org/copyleft/gpl.html.