[catagits/Gitalist.git] / local-lib5 / man / man3 / XML::LibXML::Dtd.3pm

.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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 "XML::LibXML::Dtd 3"
.TH XML::LibXML::Dtd 3 "2009-10-07" "perl v5.8.7" "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"
XML::LibXML::Dtd \- XML::LibXML DTD Handling
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use XML::LibXML;
\&
\&  $dtd = XML::LibXML::Dtd\->new($public_id, $system_id);
\&  $dtd = XML::LibXML::Dtd\->parse_string($dtd_str);
\&  $publicId = $dtd\->getName();
\&  $publicId = $dtd\->publicId();
\&  $systemId = $dtd\->systemId();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class holds a \s-1DTD\s0. You may parse a \s-1DTD\s0 from either a string, or from an
external \s-1SYSTEM\s0 identifier.
.PP
No support is available as yet for parsing from a filehandle.
.PP
XML::LibXML::Dtd is a sub-class of XML::LibXML::Node, so all the methods available to nodes (particularly \fItoString()\fR) are available
to Dtd objects.
.SH "METHODS"
.IX Header "METHODS"
.IP "new" 4
.IX Item "new"
.Vb 1
\&  $dtd = XML::LibXML::Dtd\->new($public_id, $system_id);
.Ve
.Sp
Parse a \s-1DTD\s0 from the system identifier, and return a \s-1DTD\s0 object that you can
pass to \f(CW$doc\fR\->\fIis_valid()\fR or \f(CW$doc\fR\->\fIvalidate()\fR.
.Sp
.Vb 6
\&  my $dtd = XML::LibXML::Dtd\->new(
\&                        "SOME // Public / ID / 1.0",
\&                        "test.dtd"
\&                                  );
\&   my $doc = XML::LibXML\->new\->parse_file("test.xml");
\&   $doc\->validate($dtd);
.Ve
.IP "parse_string" 4
.IX Item "parse_string"
.Vb 1
\&  $dtd = XML::LibXML::Dtd\->parse_string($dtd_str);
.Ve
.Sp
The same as \fInew()\fR above, except you can parse a \s-1DTD\s0 from a string. Note that
parsing from string may fail if the \s-1DTD\s0 contains external parametric-entity
references with relative URLs.
.IP "getName" 4
.IX Item "getName"
.Vb 1
\&  $publicId = $dtd\->getName();
.Ve
.Sp
Returns the name of \s-1DTD\s0; i.e., the name immediately following the \s-1DOCTYPE\s0
keyword.
.IP "publicId" 4
.IX Item "publicId"
.Vb 1
\&  $publicId = $dtd\->publicId();
.Ve
.Sp
Returns the public identifier of the external subset.
.IP "systemId" 4
.IX Item "systemId"
.Vb 1
\&  $systemId = $dtd\->systemId();
.Ve
.Sp
Returns the system identifier of the external subset.
.SH "AUTHORS"
.IX Header "AUTHORS"
Matt Sergeant, 
Christian Glahn, 
Petr Pajas
.SH "VERSION"
.IX Header "VERSION"
1.70
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
2001\-2007, AxKit.com Ltd.
.PP
2002\-2006, Christian Glahn.
.PP
2006\-2009, Petr Pajas.
Commit	Line	Data
3fea05b9	1	.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
	2	.\"
	3	.\" Standard preamble:
	4	.\" ========================================================================
	5	.de Sp \" Vertical space (when we can't use .PP)
	6	.if t .sp .5v
	7	.if n .sp
	8	..
	9	.de Vb \" Begin verbatim text
	10	.ft CW
	11	.nf
	12	.ne \\$1
	13	..
	14	.de Ve \" End verbatim text
	15	.ft R
	16	.fi
	17	..
	18	.\" Set up some character translations and predefined strings. \*(-- will
	19	.\" give an unbreakable dash, \(PI will give pi, \(L" will give a left
	20	.\" double quote, and \(R" will give a right double quote. \(C+ will
	21	.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
	22	.\" therefore won't be available. \(C` and \(C' expand to `' in nroff,
	23	.\" nothing in troff, for use with C<>.
	24	.tr \(*W-
	25	.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
	26	.ie n \{\
	27	. ds -- \(*W-
	28	. ds PI pi
	29	. if (\n(.H=4u)&(1m=24u) .ds -- \(W\h'-12u'\(W\h'-12u'-\" diablo 10 pitch
	30	. if (\n(.H=4u)&(1m=20u) .ds -- \(W\h'-12u'\(W\h'-8u'-\" diablo 12 pitch
	31	. ds L" ""
	32	. ds R" ""
	33	. ds C` ""
	34	. ds C' ""
	35	'br\}
	36	.el\{\
	37	. ds -- \\|\(em\\|
	38	. ds PI \(*p
	39	. ds L" ``
	40	. ds R" ''
	41	'br\}
	42	.\"
	43	.\" Escape single quotes in literal strings from groff's Unicode transform.
	44	.ie \n(.g .ds Aq \(aq
	45	.el .ds Aq '
	46	.\"
	47	.\" If the F register is turned on, we'll generate index entries on stderr for
	48	.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
	49	.\" entries marked with X<> in POD. Of course, you'll have to process the
	50	.\" output yourself in some meaningful fashion.
	51	.ie \nF \{\
	52	. de IX
	53	. tm Index:\\$1\t\\n%\t"\\$2"
	54	..
	55	. nr % 0
	56	. rr F
	57	.\}
	58	.el \{\
	59	. de IX
	60	..
	61	.\}
	62	.\"
	63	.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
	64	.\" Fear. Run. Save yourself. No user-serviceable parts.
65	. \" fudge factors for nroff and troff
66	.if n \{\
67	. ds #H 0
68	. ds #V .8m
69	. ds #F .3m
70	. ds #[ \f1
71	. ds #] \fP
72	.\}
73	.if t \{\
74	. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75	. ds #V .6m
76	. ds #F 0
77	. ds #[ \&
78	. ds #] \&
79	.\}
80	. \" simple accents for nroff and troff
81	.if n \{\
82	. ds ' \&
83	. ds ` \&
84	. ds ^ \&
85	. ds , \&
86	. ds ~ ~
87	. ds /
88	.\}
89	.if t \{\
90	. ds ' \\k:\h'-(\\n(.wu8/10-\(#H)'\'\h"\|\\n:u"
91	. ds ` \\k:\h'-(\\n(.wu8/10-\(#H)'\`\h'\|\\n:u'
92	. ds ^ \\k:\h'-(\\n(.wu10/11-\(#H)'^\h'\|\\n:u'
93	. ds , \\k:\h'-(\\n(.wu*8/10)',\h'\|\\n:u'
94	. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'\|\\n:u'
95	. ds / \\k:\h'-(\\n(.wu8/10-\(#H)'\z\(sl\h'\|\\n:u'
96	.\}
97	. \" troff and (daisy-wheel) nroff accents
98	.ds : \\k:\h'-(\\n(.wu8/10-\(#H+.1m+\(#F)'\v'-\(#V'\z.\h'.2m+\(#F'.\h'\|\\n:u'\v'\(#V'
99	.ds 8 \h'\(#H'\(b\h'-\*(#H'
100	.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\(#H)/2u'\v'-.3n'\(#[\z\(de\v'.3n'\h'\|\\n:u'\*(#]
101	.ds d- \h'\(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\(#H'
102	.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'\|\\n:u'
103	.ds th \(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u2/3)'\s-1o\s+1\*(#]
104	.ds Th \(#[\s+2I\s-2\h'-\w'I'u3/5'\v'-.3m'o\v'.3m'\*(#]
105	.ds ae a\h'-(\w'a'u*4/10)'e
106	.ds Ae A\h'-(\w'A'u*4/10)'E
107	. \" corrections for vroff
108	.if v .ds ~ \\k:\h'-(\\n(.wu9/10-\(#H)'\s-2\u~\d\s+2\h'\|\\n:u'
109	.if v .ds ^ \\k:\h'-(\\n(.wu10/11-\(#H)'\v'-.4m'^\v'.4m'\h'\|\\n:u'
110	. \" for low resolution devices (crt and lpr)
111	.if \n(.H>23 .if \n(.V>19 \
112	\{\
113	. ds : e
114	. ds 8 ss
115	. ds o a
116	. ds d- d\h'-1'\(ga
117	. ds D- D\h'-1'\(hy
118	. ds th \o'bp'
119	. ds Th \o'LP'
120	. ds ae ae
121	. ds Ae AE
122	.\}
123	.rm #[ #] #H #V #F C
124	.\" ========================================================================
125	.\"
126	.IX Title "XML::LibXML::Dtd 3"
127	.TH XML::LibXML::Dtd 3 "2009-10-07" "perl v5.8.7" "User Contributed Perl Documentation"
128	.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129	.\" way too many mistakes in technical documents.
130	.if n .ad l
131	.nh
132	.SH "NAME"
133	XML::LibXML::Dtd \- XML::LibXML DTD Handling
134	.SH "SYNOPSIS"
135	.IX Header "SYNOPSIS"
136	.Vb 1
137	\& use XML::LibXML;
138	\&
139	\& $dtd = XML::LibXML::Dtd\->new($public_id, $system_id);
140	\& $dtd = XML::LibXML::Dtd\->parse_string($dtd_str);
141	\& $publicId = $dtd\->getName();
142	\& $publicId = $dtd\->publicId();
143	\& $systemId = $dtd\->systemId();
144	.Ve
145	.SH "DESCRIPTION"
146	.IX Header "DESCRIPTION"
147	This class holds a \s-1DTD\s0. You may parse a \s-1DTD\s0 from either a string, or from an
148	external \s-1SYSTEM\s0 identifier.
149	.PP
150	No support is available as yet for parsing from a filehandle.
151	.PP
152	XML::LibXML::Dtd is a sub-class of XML::LibXML::Node, so all the methods available to nodes (particularly \fItoString()\fR) are available
153	to Dtd objects.
154	.SH "METHODS"
155	.IX Header "METHODS"
156	.IP "new" 4
157	.IX Item "new"
158	.Vb 1
159	\& $dtd = XML::LibXML::Dtd\->new($public_id, $system_id);
160	.Ve
161	.Sp
162	Parse a \s-1DTD\s0 from the system identifier, and return a \s-1DTD\s0 object that you can
163	pass to \f(CW$doc\fR\->\fIis_valid()\fR or \f(CW$doc\fR\->\fIvalidate()\fR.
164	.Sp
165	.Vb 6
166	\& my $dtd = XML::LibXML::Dtd\->new(
167	\& "SOME // Public / ID / 1.0",
168	\& "test.dtd"
169	\& );
170	\& my $doc = XML::LibXML\->new\->parse_file("test.xml");
171	\& $doc\->validate($dtd);
172	.Ve
173	.IP "parse_string" 4
174	.IX Item "parse_string"
175	.Vb 1
176	\& $dtd = XML::LibXML::Dtd\->parse_string($dtd_str);
177	.Ve
178	.Sp
179	The same as \fInew()\fR above, except you can parse a \s-1DTD\s0 from a string. Note that
180	parsing from string may fail if the \s-1DTD\s0 contains external parametric-entity
181	references with relative URLs.
182	.IP "getName" 4
183	.IX Item "getName"
184	.Vb 1
185	\& $publicId = $dtd\->getName();
186	.Ve
187	.Sp
188	Returns the name of \s-1DTD\s0; i.e., the name immediately following the \s-1DOCTYPE\s0
189	keyword.
190	.IP "publicId" 4
191	.IX Item "publicId"
192	.Vb 1
193	\& $publicId = $dtd\->publicId();
194	.Ve
195	.Sp
196	Returns the public identifier of the external subset.
197	.IP "systemId" 4
198	.IX Item "systemId"
199	.Vb 1
200	\& $systemId = $dtd\->systemId();
201	.Ve
202	.Sp
203	Returns the system identifier of the external subset.
204	.SH "AUTHORS"
205	.IX Header "AUTHORS"
206	Matt Sergeant,
207	Christian Glahn,
208	Petr Pajas
209	.SH "VERSION"
210	.IX Header "VERSION"
211	1.70
212	.SH "COPYRIGHT"
213	.IX Header "COPYRIGHT"
214	2001\-2007, AxKit.com Ltd.
215	.PP
216	2002\-2006, Christian Glahn.
217	.PP
218	2006\-2009, Petr Pajas.