local-lib5/man/man3/XML::OPML::SimpleGen.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::OPML::SimpleGen 3"
 127 .TH XML::OPML::SimpleGen 3 "2008-02-08" "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::OPML::SimpleGen \- create OPML using XML::Simple
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 .Vb 1
 137 \&    require XML::OPML::SimpleGen;
 138 \&
 139 \&    my $opml = new XML::OPML::SimpleGen();
 140 \&
 141 \&    $opml\->head(
 142 \&             title => \*(AqFIFFS Subscriptions\*(Aq,
 143 \&           );
 144 \&
 145 \&    $opml\->insert_outline(
 146 \&        group => \*(Aqnews\*(Aq,  # groups will be auto generated
 147 \&        text =>  \*(Aqsome feed\*(Aq,
 148 \&        xmlUrl => \*(Aqhttp://www.somepage.org/feed.xml\*(Aq,
 149 \&    );
 150 \&
 151 \&    # insert_outline and add_outline are the same
 152 \&
 153 \&    $opml\->add_group( text => \*(AqmyGroup\*(Aq ); # explicitly create groups
 154 \&
 155 \&    print $opml\->to_string;
 156 \&
 157 \&    $opml\->save(\*(Aqsomefile.opml\*(Aq);
 158 \&
 159 \&    $opml\->xml_options( $hashref ); # XML::Simple compatible options
 160 \&
 161 \&    # See XML::OPML\*(Aqs synopsis for more knowledge
 162 .Ve
 163 .SH "DESCRIPTION"
 164 .IX Header "DESCRIPTION"
 165 XML::OPML::SimpleGen lets you simply generate \s-1OPML\s0 documents
 166 without having too much to worry about.
 167 It is a drop-in replacement for \s-1XML::OPML\s0
 168 in regards of generation.
 169 As this module uses XML::Simple it is rather
 170 generous in regards of attribute or element names.
 171 .SH "COMMON METHODS"
 172 .IX Header "COMMON METHODS"
 173 .IP "new( key => value )" 4
 174 .IX Item "new( key => value )"
 175 Creates a new XML::OPML::SimpleGen instance. All key values will be
 176 used as attributes for the <atom> element. The only thing you might
 177 want to use here is the version => '1.1', which is default anyway.
 178 .IP "head( key => value )" 4
 179 .IX Item "head( key => value )"
 180 \&\s-1XML::OPML\s0 compatible head method to change header values.
 181 .IP "id ( )" 4
 182 .IX Item "id ( )"
 183 Returns (and increments) a counter.
 184 .IP "add_group ( text => 'name' )" 4
 185 .IX Item "add_group ( text => 'name' )"
 186 Method to explicitly create a group which can hold multiple outline
 187 elements.
 188 .IP "insert_outline ( key => value )" 4
 189 .IX Item "insert_outline ( key => value )"
 190 \&\s-1XML::OPML\s0 compatible method to add an outline element. See
 191 \&\s-1XML::OPML\s0 for details. The group key is used to put elements in a
 192 certain group. Non existent groups will be created automagically.
 193 .IP "add_outline ( key => value )" 4
 194 .IX Item "add_outline ( key => value )"
 195 Alias to insert_outline for \s-1XML::OPML\s0 compatibility.
 196 .IP "as_string" 4
 197 .IX Item "as_string"
 198 Returns the given \s-1OPML\s0 \s-1XML\s0 data as a string
 199 .ie n .IP "save ( $filename )" 4
 200 .el .IP "save ( \f(CW$filename\fR )" 4
 201 .IX Item "save ( $filename )"
 202 Saves the \s-1OPML\s0 data to a file
 203 .SH "ADVANCED METHODS"
 204 .IX Header "ADVANCED METHODS"
 205 .ie n .IP "xml_options ( $hashref )" 4
 206 .el .IP "xml_options ( \f(CW$hashref\fR )" 4
 207 .IX Item "xml_options ( $hashref )"
 208 \&\f(CW$hashref\fR may contain any XML::Simple options.
 209 .ie n .IP "outline ( $hashref )" 4
 210 .el .IP "outline ( \f(CW$hashref\fR )" 4
 211 .IX Item "outline ( $hashref )"
 212 The outline method defines the 'template' for any new outline
 213 element. You can preset key value pairs here to be used
 214 in all outline elements that will be generated by XML::OPML::SimpleGen.
 215 .ie n .IP "group ( $hashref )" 4
 216 .el .IP "group ( \f(CW$hashref\fR )" 4
 217 .IX Item "group ( $hashref )"
 218 This method is similar to outline, it defines the template for a
 219 grouping outline element.
 220 .SH "AUTHOR"
 221 .IX Header "AUTHOR"
 222 Marcus Thiesen, \f(CW\*(C`<marcus@thiesen.org>\*(C'\fR
 223 .SH "BUGS"
 224 .IX Header "BUGS"
 225 Please report any bugs or feature requests to
 226 \&\f(CW\*(C`bug\-xml\-opml\-simlegen@rt.cpan.org\*(C'\fR, or through the web interface at
 227 <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=XML\-OPML\-SimleGen>.
 228 I will be notified, and then you'll automatically be notified of progress on
 229 your bug as I make changes.
 230 .SH "SEE ALSO"
 231 .IX Header "SEE ALSO"
 232 \&\s-1XML::OPML\s0 XML::Simple
 233 .SH "COPYRIGHT & LICENSE"
 234 .IX Header "COPYRIGHT & LICENSE"
 235 Copyright 2005\-2007 Marcus Thiesen, All Rights Reserved.
 236 .PP
 237 This program is free software; you can redistribute it and/or modify it
 238 under the same terms as Perl itself.
 239 .SH "CVS"
 240 .IX Header "CVS"
 241 \&\f(CW$Id:\fR SimpleGen.pm,v 1.9 2008/02/08 10:33:43 stephenca Exp $