local-lib5/man/man3/XML::LibXML::PI.3pm

   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(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/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(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/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'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/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(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/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::PI 3"
 127 .TH XML::LibXML::PI 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::PI \- XML::LibXML Processing Instructions
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 .Vb 3
 137 \&  use XML::LibXML;
 138 \&  # Only methods specific to Processing Instruction nodes are listed here,
 139 \&  # see XML::LibXML::Node manpage for other methods
 140 \&
 141 \&  $pinode\->setData( $data_string );
 142 \&  $pinode\->setData( name=>string_value [...] );
 143 .Ve
 144 .SH "DESCRIPTION"
 145 .IX Header "DESCRIPTION"
 146 Processing instructions are implemented with XML::LibXML with read and write
 147 access. The \s-1PI\s0 data is the \s-1PI\s0 without the \s-1PI\s0 target (as specified in \s-1XML\s0 1.0
 148 [17]) as a string. This string can be accessed with getData as implemented in XML::LibXML::Node.
 149 .PP
 150 The write access is aware about the fact, that many processing instructions
 151 have attribute like data. Therefore \fIsetData()\fR provides besides the \s-1DOM\s0 spec
 152 conform Interface to pass a set of named parameter. So the code segment
 153 .PP
 154 .Vb 3
 155 \&  my $pi = $dom\->createProcessingInstruction("abc");
 156 \&  $pi\->setData(foo=>\*(Aqbar\*(Aq, foobar=>\*(Aqfoobar\*(Aq);
 157 \&  $dom\->appendChild( $pi );
 158 .Ve
 159 .PP
 160 will result the following \s-1PI\s0 in the \s-1DOM:\s0
 161 .PP
 162 .Vb 1
 163 \&  <?abc foo="bar" foobar="foobar"?>
 164 .Ve
 165 .PP
 166 Which is how it is specified in the \s-1DOM\s0 specification. This three step
 167 interface creates temporary a node in perl space. This can be avoided while
 168 using the \fIinsertProcessingInstruction()\fR method. Instead of the three calls
 169 described above, the call
 170 .PP
 171 .Vb 1
 172 \&  $dom\->insertProcessingInstruction("abc",\*(Aqfoo="bar" foobar="foobar"\*(Aq);
 173 .Ve
 174 .PP
 175 will have the same result as above.
 176 .PP
 177 XML::LibXML::PI's implementation of \fIsetData()\fR documented below differs a bit from the the
 178 standard version as available in XML::LibXML::Node:
 179 .IP "setData" 4
 180 .IX Item "setData"
 181 .Vb 2
 182 \&  $pinode\->setData( $data_string );
 183 \&  $pinode\->setData( name=>string_value [...] );
 184 .Ve
 185 .Sp
 186 This method allows to change the content data of a \s-1PI\s0. Additionally to the
 187 interface specified for \s-1DOM\s0 Level2, the method provides a named parameter
 188 interface to set the data. This parameter list is converted into a string
 189 before it is appended to the \s-1PI\s0.
 190 .SH "AUTHORS"
 191 .IX Header "AUTHORS"
 192 Matt Sergeant,
 193 Christian Glahn,
 194 Petr Pajas
 195 .SH "VERSION"
 196 .IX Header "VERSION"
 197 1.70
 198 .SH "COPYRIGHT"
 199 .IX Header "COPYRIGHT"
 200 2001\-2007, AxKit.com Ltd.
 201 .PP
 202 2002\-2006, Christian Glahn.
 203 .PP
 204 2006\-2009, Petr Pajas.