local-lib5/man/man3/DateTime::Format::W3CDTF.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 "DateTime::Format::W3CDTF 3"
 127 .TH DateTime::Format::W3CDTF 3 "2009-11-01" "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 DateTime::Format::W3CDTF \- Parse and format W3CDTF datetime strings
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 .Vb 1
 137 \&  use DateTime::Format::W3CDTF;
 138 \&
 139 \&  my $w3c = DateTime::Format::W3CDTF\->new;
 140 \&  my $dt = $w3c\->parse_datetime( \*(Aq2003\-02\-15T13:50:05\-05:00\*(Aq );
 141 \&
 142 \&  # 2003\-02\-15T13:50:05\-05:00
 143 \&  $w3c\->format_datetime($dt);
 144 .Ve
 145 .SH "DESCRIPTION"
 146 .IX Header "DESCRIPTION"
 147 This module understands the W3CDTF date/time format, an \s-1ISO\s0 8601 profile,
 148 defined at http://www.w3.org/TR/NOTE\-datetime.  This format as the native
 149 date format of \s-1RSS\s0 1.0.
 150 .PP
 151 It can be used to parse these formats in order to create the appropriate
 152 objects.
 153 .SH "METHODS"
 154 .IX Header "METHODS"
 155 This \s-1API\s0 is currently experimental and may change in the future.
 156 .IP "\(bu" 4
 157 parse_datetime($string)
 158 .Sp
 159 Given a W3CDTF datetime string, this method will return a new
 160 \&\f(CW\*(C`DateTime\*(C'\fR object.
 161 .Sp
 162 If given an improperly formatted string, this method may die.
 163 .IP "\(bu" 4
 164 format_datetime($datetime)
 165 .Sp
 166 Given a \f(CW\*(C`DateTime\*(C'\fR object, this methods returns a W3CDTF datetime
 167 string.
 168 .Sp
 169 \&\s-1NOTE:\s0 As of version 0.4, format_datetime no longer attempts to truncate
 170 datetimes without a time component.  This is due to the fact that \f(CW\*(C`DateTime\*(C'\fR
 171 doesn't distinguish between a date with no time component, and midnight.
 172 .IP "\(bu" 4
 173 format_date($datetime)
 174 .Sp
 175 Given a \f(CW\*(C`DateTime\*(C'\fR object, return a W3CDTF datetime string without the time component.
 176 .SH "SUPPORT"
 177 .IX Header "SUPPORT"
 178 Support for this module is provided via the datetime@perl.org email
 179 list. See http://datetime.perl.org/?MailingList for details.
 180 .PP
 181 Please submit bugs to the \s-1CPAN\s0 \s-1RT\s0 system at
 182 http://rt.cpan.org/NoAuth/ReportBug.html?Queue=datetime\-format\-w3cdtf or via
 183 email at bug\-datetime\-format\-w3cdtf@rt.cpan.org.
 184 .SH "AUTHOR"
 185 .IX Header "AUTHOR"
 186 Dave Rolsky <autarch@urth.org>
 187 .SH "CREDITS"
 188 .IX Header "CREDITS"
 189 This module was originally created by Kellan Elliott-McCrea
 190 <kellan@protest.net>.
 191 .PP
 192 This module was inspired by DateTime::Format::ICal
 193 .SH "COPYRIGHT"
 194 .IX Header "COPYRIGHT"
 195 Copyright (c) 2009 David Rolsky.  All rights reserved.  This
 196 program is free software; you can redistribute it and/or modify it
 197 under the same terms as Perl itself.
 198 .PP
 199 Copyright (c) 2003 Kellan Elliott-McCrea
 200 .PP
 201 Portions of the code in this distribution are derived from other
 202 works.  Please see the \s-1CREDITS\s0 file for more details.
 203 .PP
 204 The full text of the license can be found in the \s-1LICENSE\s0 file included
 205 with this module.
 206 .SH "SEE ALSO"
 207 .IX Header "SEE ALSO"
 208 datetime@perl.org mailing list
 209 .PP
 210 http://datetime.perl.org/