Author: as
Date: Mon Oct 8 13:53:14 2007
New Revision: 6383
Log:
- Added a small tutorial and a list of supported RFCs.
# Still a draft.
Added:
trunk/Feed/docs/rfcs.txt (with props)
trunk/Feed/docs/tutorial/
trunk/Feed/docs/tutorial.txt (with props)
trunk/Feed/docs/tutorial/tutorial_autoload.php
- copied, changed from r6377, trunk/Feed/docs/tutorial_autoload.php
Removed:
trunk/Feed/docs/tutorial_autoload.php
Added: trunk/Feed/docs/rfcs.txt
==============================================================================
--- trunk/Feed/docs/rfcs.txt (added)
+++ trunk/Feed/docs/rfcs.txt [iso-8859-1] Mon Oct 8 13:53:14 2007
@@ -1,0 +1,37 @@
+Feed RFCs
+---------
+
+This document lists the various feed types and modules supported by the Feed
+component, and the related specifications documents and RFCs.
+
+
+Feed types
+==========
+
+1. `RSS 1.0`__
+2. `RSS 2.0`__
+3. `ATOM`__ (RFC 4287)
+
+__ http://web.resource.org/rss/1.0/spec
+__ http://www.rssboard.org/rss-specification
+__ http://atompub.org/rfc4287.html
+
+
+Modules
+=======
+
+1. `Content`__
+2. `DublinCore`__
+
+__ http://web.resource.org/rss/1.0/modules/content/
+__ http://web.resource.org/rss/1.0/modules/dc/
+
+
+
+..
+ Local Variables:
+ mode: rst
+ fill-column: 79
+ End:
+ vim: et syn=rst tw=79
+
Propchange: trunk/Feed/docs/rfcs.txt
------------------------------------------------------------------------------
svn:eol-style = native
Added: trunk/Feed/docs/tutorial.txt
==============================================================================
--- trunk/Feed/docs/tutorial.txt (added)
+++ trunk/Feed/docs/tutorial.txt [iso-8859-1] Mon Oct 8 13:53:14 2007
@@ -1,0 +1,38 @@
+eZ Components - Feed
+~~~~~~~~~~~~~~~~~~~~
+
+.. contents:: Table of Contents
+
+Introduction
+============
+
+Description
+-----------
+
+The purpose of the Feed component is to handle parsing and creating RSS and
+ATOM feeds.
+
+
+Class overview
+==============
+
+An overview of the most important classes in the Feed component.
+
+
+Base classes
+------------
+
+ezcFeed
+ Defines a feed object of a specified type. Can be created from scratch or
+ from an existing XML document (with autodetection of type). One or more
+ feed modules can be added to the feed object. It can be generated into an XML
+ document.
+
+
+
+..
+ Local Variables:
+ mode: rst
+ fill-column: 79
+ End:
+ vim: et syn=rst tw=79 nocin
Propchange: trunk/Feed/docs/tutorial.txt
------------------------------------------------------------------------------
svn:eol-style = native
Copied: trunk/Feed/docs/tutorial/tutorial_autoload.php (from r6377,
trunk/Feed/docs/tutorial_autoload.php)
==============================================================================
--- trunk/Feed/docs/tutorial_autoload.php [iso-8859-1] (original)
+++ trunk/Feed/docs/tutorial/tutorial_autoload.php [iso-8859-1] Mon Oct 8
13:53:14 2007
@@ -4,8 +4,8 @@
switch ( $dirParts[count( $dirParts ) - 3] )
{
case 'doc': require_once 'ezc/Base/base.php'; break; // pear
- case 'trunk': require_once "$dir/../../Base/src/base.php"; break; // svn
- default: require_once "$dir/../../Base/src/base.php"; break; // bundle
+ case 'trunk': require_once "$dir/../../../Base/src/base.php"; break; // svn
+ default: require_once "$dir/../../../Base/src/base.php"; break; // bundle
}
/**
--
svn-components mailing list
[email protected]
http://lists.ez.no/mailman/listinfo/svn-components
