Module: Syndication::Syndication

Included in:
Channel
Defined in:
lib/syndication/syndication.rb

Overview

Mixin for RSS 1.0 syndication data (draft standard for RSS 1.0).

If you require 'syndication/syndication' these methods are added to the Syndication::Channel class.

Access methods are named after the XML elements, prefixed with sy_.

Instance Attribute Summary (collapse)

Instance Attribute Details

- (Object) sy_updatebase

Base date used to calculate publishing times. When combined with sy_updateperiod and sy_updatefrequency, the publishing schedule can be derived. Returned as a DateTime if possible, otherwise as a String.



32
33
34
 
# File 'lib/syndication/syndication.rb', line 32

def sy_updatebase
  @sy_updatebase
end

- (Object) sy_updatefrequency

Frequency of updates, in relation to sy_updateperiod. Indicates how many times in each sy_updateperiod the channel is updated. For example, sy_updateperiod = 'daily' and sy_updatefrequency = 4 means four times per day.



27
28
29
 
# File 'lib/syndication/syndication.rb', line 27

def sy_updatefrequency
  @sy_updatefrequency
end

- (Object) sy_updateperiod

The period over which the channel is updated. Allowed values are 'hourly', 'daily', 'weekly', 'monthly', 'yearly'. If omitted, 'daily' is assumed.



21
22
23
 
# File 'lib/syndication/syndication.rb', line 21

def sy_updateperiod
  @sy_updateperiod
end