.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .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. | will give a .\" real vertical bar. \*(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-|\(bv\*(Tr .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\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" 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 "Net::Delicious::Config 3" .TH Net::Delicious::Config 3 "2008-01-13" "perl v5.8.8" "User Contributed Perl Documentation" .SH "NAME" Net::Delicious::Config \- config handler for Net::Delicious. .Sh "SYNOPSIS" .IX Subsection "SYNOPSIS" Config handler for Net::Delicious. .SH "DESCRIPTION" .IX Header "DESCRIPTION" Internally, Net::Delicious uses an \*(L"ini\*(R" style Config::Simple object to keep track of its various settings. These include user credentials, endpoints as well as \s-1API\s0 request and response parameters. .PP While there is no expectation that a user will ever need to change anything than their basic login information, it is possible to override any of the default configuration options. If, you know, you're in to that kind of thing. .PP The only caveat is that in order to override default configuaration for request and response properties you will need to pass the Net::Delicious object constructor a Config::Simple object or the path to a valid \*(L"ini\*(R" style config file. (Arguments passed to the constructor as a hash reference are assumed to be part of the default \fBdelicious\fR configs.) .PP It is important to remember that these config options, and definitions, are not meant to be a complete web services description nor do they play one on \s-1TV\s0. They are some bare-bones glue to allow users the ability to define their own settings in the event that this package falls out of sync with the \s-1API\s0 or they've dreampt up some wacky project that uses Net::Delicious. .SH "DEFAULT CONFIGS" .IX Header "DEFAULT CONFIGS" These are outlined in the \s-1POD\s0 for the Net::Delicious object constructor. They are basically anything define in the \fB[delicious]\fR block. .PP Default \s-1API\s0 response configs are defined in Net::Delicious::Constants::Config::DELICIOUS_CFG_STD. .SH "API CALL CONFIGS" .IX Header "API CALL CONFIGS" \&\s-1API\s0 call configs are the set of allowable parameters that may be sent to del.icio.us with a given method call along with flags to indicate whether an argument is required or needs some special magic \s-1DWIM\s0 munging. .PP The basic syntax for block names is the string \fBdelicious\fR, the lower-case name of the \&\s-1API\s0 class (posts, user, etc.) followed by the lower-case name of the method all joined by underbars. .PP The basic syntax for block arguments is the name of the \s-1API\s0 parameter followed by a single string containing multiple options separated by semi\-colons. As of this writing, there aren't very many options. The first is the string \fBrequired\fR if (drumroll) the parameter is required. The only other recognized option is the string \fBno\fR which will tell the argument parser to \&\s-1DWIM\s0 if the user passes boolean true or false. .PP For example : .PP .Vb 8 \& [delicious_posts_add] \& url="required" \& description="" \& extended="" \& tags="" \& dt="" \& shared=";no" \& replace=";no" .Ve .PP If a method class is nested, the syntax requires that all \fB/\fR strings be replaced by underbars. For example \fBtags/bundles/set\fR is defined as : .PP .Vb 3 \& [delicious_tags_bundles_set] \& bundle="required" \& tags="required" .Ve .PP Default \s-1API\s0 response configs are defined in Net::Delicious::Constants::Config::DELICIOUS_CFG_API. .SH "API RESPONSE CONFIGS" .IX Header "API RESPONSE CONFIGS" \&\s-1API\s0 response configs define the properties that are expected to be returned in a given method call and mapped to object methods. .PP As of this writings, all properites are defined in the \fBdelicious_properties\fR block. .PP The basic syntax for block arguments is the lower-case name of the Net::Delicious object class followed by a comma-separated list of properties/methods. Unless already defined in their parent package, \*(L"get\*(R" methods for each property will be automagically created. .PP .Vb 7 \& [delicious_properties] \& date="tag,date,count,user" \& post="description,extended,href,time,parent,tag,others,shared" \& bundle="name,tag" \& user="name" \& subscriptions="user,tag" \& tag="tag,count" .Ve .PP Default \s-1API\s0 response configs are defined in Net::Delicious::Constants::Config::DELICIOUS_CFG_PROPERTIES. .SH "VERSION" .IX Header "VERSION" 1.11 .SH "DATE" .IX Header "DATE" $Date: 2007/03/25 15:32:25 $ .SH "AUTHOR" .IX Header "AUTHOR" Aaron Straup Cope .SH "LICENSE" .IX Header "LICENSE" Copyright (c) 2004\-2007 Aaron Straup Cope. All rights reserved. .PP This is free software, you may use it and distribute it under the same terms as Perl itself.