RSS2HTML-PRO PHP Script Documentation
CONTENTS:
Introduction
Uses
Limitations
Use in Templates
Unique Item Link
Introduction:
-------------
RSS2HTML-PRO allow PHP code to be included in the template of RSS2HTML. This PHP code can be used to perform logic and processing that is not available in the free version of RSS2HTML.
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
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 familiar 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.
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.
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.