[CMF-checkins] CVS: CMF - Syndication-Tool_Overview.stx:1.1 Syndication-Tool_Policies.stx:1.1 Syndication-Tool_Properties.stx:1.1 Syndication-Tool_Reporting.stx:1.1
andrew@digicool.com
andrew@digicool.com
Fri, 18 May 2001 17:29:49 -0400 (EDT)
Update of /cvs-repository/CMF/CMFDefault/help
In directory korak.digicool.com:/tmp/cvs-serv26027/help
Added Files:
Syndication-Tool_Overview.stx Syndication-Tool_Policies.stx
Syndication-Tool_Properties.stx Syndication-Tool_Reporting.stx
Log Message:
*SyndicationTool/SyndicationInfo object for enabling and
configuring Syndication services in the CMF.
DTML for the ZMI configuration, DTML Methods for configuartion
via the CMF, added help for CMFDefault and related files to the
help for Syndication.
--- Added File Syndication-Tool_Overview.stx in package CMF ---
SyndicationTool - Overview: CMF Syndication Overview.
Description
The SyndicationTool allows for sitewide syndication of content in folders
(or folder-like objects which support the synContentValues interface).
Currently on the SyndicationTool the following features are present:
1. Enable/disable sitewide syndication.
2. Override my Syndicaiton Element defaults on the Properties
management form.
Once sitewide syndication has been enabled, the Syndication action on
folders is enabled, allowing syndication for a specific folder to be
enabled. This is to protect calling the RSS dtml method on folder
contents one wishes to remain non-syndicated. A 'syndication_information'
object is set on the folder which acts as the 'propertysheet' for over-
riding sitewide defaults for each particular syndication instance.
In the next revision of the SyndicationTool, the following features are
being planned:
1. Reimplementation of the manner properties are called on the
SyndicationTool class and instance, as well as on the 'syndication-
information' object. A getElementProperty method will handle generic
grabing of properties.
2. Adding the ability to addElementProperties, to allow for easily
enabling additional XML namespaces to be incorporated on an instance
without requiring reimplementation of the SyndicationTool.
3. Default sitewide properties for the dublin core module support.
4. Sitewide enabling/disabling override switches for the supported
XML namespace module default values.
5. Sitewide/Folder level content filtering of content returned back
in the itemRSS DTML method to allow for selective content returned
for the syndication.
6. Sort Order setting. Allow the setting of how the content is sorted
in the syndication.
7. Add switch to disallow acquisition to disable sub-folder syndication
within an existing syndicated folder.
8. Other features are possible as users give feedback on the
Syndication implementation.
--- Added File Syndication-Tool_Policies.stx in package CMF ---
SyndicationTool - Policies: Manage the policies of a Site's Syndication Instance.
Description
View and manage the prolicies of a sitewide syndication instance.
Controls
'Allow-Override' -- Each of the properties configureable from the Properties
management form will have an override switch on the policies management form.
This is currently unavailable and will be incorporated into the 1.1 release
of the SyndicationTool.
--- Added File Syndication-Tool_Properties.stx in package CMF ---
SyndicationTool - Properties: Manage the properties of a Site's Syndication Instance.
Description
View and manage the properties of a sitewide syndication instance.
Controls
'Enable/Disable Syndication' -- Turns enables/disables sitewide syndication.
All methods check whether site syndication is enabled to ensure a sitewide policy
is enforceable.
'Syndication Module' -- The RSS sy XMLNS is supported in this tool by default.
The following properties are editable on the tool for sitewide configuring of each
of the elements of the syndication module. In this release, they are over-rideable;
these will be configurable in version 1.1 to enable a sitewide policy.
'UpdatePeriod' -- Describes the period over which the channel format is updated.
Acceptable values are: hourly, daily, weekly, monthly, yearly.
If omitted, daily is assumed.
'UpdateFrequency' -- Used to describe the frequency of updates in relation to the
update period. A positive integer indicates how many times in that period the channel
is updated. For example, an updatePeriod of daily, and an updateFrequency of 2
indicates the channel format is updated twice daily.
If omitted a value of 1 is assumed
'UpdateBase' -- Defines a base date to be used in concert with updatePeriod and
updateFrequency to calculate the publishing schedule. By default the sitewide
date is the DateTime of the tool initialization. The UpdateBase in the RSS XML
takes this DateTime object and sringify's it through DateTime.HTML4()
The date format takes the form: yyyy-mm-ddThh:mm
'Max Items' -- Defines the max number of items which are included in the syndication.
The RSS Specification recommends this not exceed 15, which is the default.
'DublinCore Module' -- The RSS dc XMLNS is supported in this tool by default.
The sitewide properties will be editable on the tool for sitewide configuring of each
of the elements of the dublin core module. In this release, they are over-rideable;
these will be configurable in version 1.1 to enable a sitewide policy.
--- Added File Syndication-Tool_Reporting.stx in package CMF ---
SyndicationTool - Overview: CMF Syndication Reporting Facility.
Description
The SyndicationTool Reporting Facility is planned to be added to
the next release of the Syndication services for the CMF.
I hope to have generated enough feedback from users who might have
definate ideas which would make a good foundation as a default
suite of reports. The plan is not to be all inclusive, but to
provide a mechanism to generate interesting SiteAdmin data regarding
the use of Syndication within their sites.