rss2html-pro-docs.txt

for news RSS to HTML as ASP

RSS2HTML-Pro v3.x PHP Script Documentation

CONTENTS:
  Introduction
  Install
  Uses
  Limitations
  Unique Item Link
  Use in Templates
  Examples
  XML Namespaces and New Tags


Introduction:
-------------

RSS2HTML-Pro adds three new features to the free version of RSS2HTML:
- Allows user written PHP code to be included in the RSS2HTML template file to do advanced processing
- Allows the creation of a special link back to the same feed that displays only the one item the link is for
- Expands RSS2HTML to process and support the iTunes(R) and TrackBack namespaces.


Install:
-------------

To install RSS2HTML-Pro copy all of the .php files in rss2html-pro.zip to your web server to the same directory as rss2html.php


Uses:
-----

- Filter the items displayed by words or phrases
- Filter the display of items by time or date ranges
- Modify the contents of the RSS Feed
- Create a link to an item in the RSS Feed that displays on its own page
- Include iTunes(R) Podcast fields or TrackBack URLs in the output


Limitations:
-------------

PHP is a programming language (http://www.php.net/manual/en/introduction.php) that can be used on webservers.  As such, to use the features of RSS2HTML-Pro you will need to know how to program in PHP, or be fimilar with programming and able to learn PHP.

RSS2HTML-Pro does not support the short PHP tags, for reasons noted on http://us3.php.net/manual/en/language.basic-syntax.php.  Only the "<?php ?>" and "<?= ?>" PHP tags are supported. 


Unique Item Link:
-----------------

RSS2HTML-Pro provides the capability to create a link that points to a specific item, allowing just that item to be displayed.  This is done by placing ~~~ItemUniqueLinkWithTemplate=X~~~ into the template.  A link to the item will be created using the template 'X'.  This can be used to create a web page for the item showing more information than what was show on the page with all the items from the feed.


Use in Templates:
-----------------

RSS2HTML does the substitutions into the template of the RSS feed values into the special ~~~X~~~ place holders in the template.  After the whole feed has been parsed and the output of RSS2HTML is complete, it is then passed to the RSS2HTML-Pro module for parsing.  Since the result of replacing the ~~~X~~~ place holders produce raw strings, they must be placed inside of quotation marks for use in PHP.  To prevent an quotation marks in the RSS feed values causing problems, RSS2HTML-Pro converts all quotation marks to the special value of ~~~QUOTE~~~ before processing.  Then after processing all ~~~QUOTE~~~s are converted back to quotation marks.


Examples:
---------

Included in rss2html-pro.zip is a file, rss2html-pro-examples.txt, that has an ever expanding set of example code.  Some of the examples are very simple, with others are very complex.


XML Namespaces and New Tags:
----------------------------

RSS2HTML-Pro adds the capability for processing XML Namespaces and using the values in your template files.  The first three supported XML Namespaces are iTunes(R), TrackBack and Dublin Core.  To enable the use of the extensions copy the file FeedForAll_parse_Extensions.inc.php and the FeedForAll_parse_*.inc.php files for the extensions you want to use into the same directory as FeedForAll_rss2html_pro.php and rss2html.php.  The following tags are added:

~~~FeediTunesSubtitle~~~
~~~FeediTunesSummary~~~
~~~FeediTunesCategory~~~
~~~FeediTunesSubCategory~~~
~~~FeediTunesKeywords~~~
~~~FeediTunesAuthor~~~
~~~FeediTunesOwnerEmail~~~
~~~FeediTunesOwnerName~~~
~~~FeediTunesImage~~~
~~~FeediTunesExplicit~~~
~~~FeediTunesBlocked~~~
~~~ItemiTunesSubtitle~~~
~~~ItemiTunesSummary~~~
~~~ItemiTunesDuration~~~
~~~ItemiTunesKeywords~~~
~~~ItemiTunesAuthor~~~
~~~ItemiTunesExplicit~~~
~~~ItemiTunesBlocked~~~

~~~ItemTrackBackPing~~~
~~~ItemTrackBackAbout~~~

~~~ItemDCTitle~~~
~~~ItemDCDescription~~~
~~~ItemDCDate~~~
~~~ItemDCSubject~~~
~~~ItemDCCreator~~~
~~~ItemDCPublisher~~~
~~~ItemDCContributor~~~
~~~ItemDCLanguage~~~
~~~ItemDCRights~~~
~~~ItemDCType~~~
~~~ItemDCFormat~~~
~~~ItemDCIdentifier~~~
~~~ItemDCSource~~~
~~~ItemDCRelation~~~
~~~ItemDCCoverage~~~


Copyright 2006-2007 NotePage, Inc. All rights reserved

$Id: rss2html-pro-docs.txt,v 3.0 2007/04/16 14:23:03 housley Exp $