$Id: readme.txt,v 1.7 2006/09/29 12:48:54 ohwada Exp $

=================================================
Version: 0.40
Date:   2006-09-10
Author: Kenichi OHWADA
URL:    http://linux2.ohwada.net/
Email:  webmaster@ohwada.net
=================================================

* main changes *
(1) happy_linux module
moved class function of RDF/RSS/ATOM genaretion into happy_linux module

(2) weblinks module
changed some, becuase prepares for the integration with weblinks module,

(3) RSS parse
(3-1) supported RSS without link tag
http://dev.xoops.org/modules/xfmod/tracker/index.php?func=detail&aid=4146&group_id=1300&atid=1356

(3-2) supported RSS which has twe or more enclosure tag

(3-2) supported RSS which has guid tag with non URL format.
for rssc_headline

(4) search
(4-1) show context in search result, 
corresponding to search module to be distributing in Amethyst Blue
http://www.suin.jp/

(4-2) highlight keywords in search result

(4-3) added fuzzy search (Japanese only)
http://linux.ohwada.jp/modules/newbb/viewtopic.php?topic_id=503&forum=9

(5) added page title
http://linux.ohwada.jp/modules/newbb/viewtopic.php?topic_id=494&forum=9

(6) added option to show content with html or not
http://linux2.ohwada.net/modules/newbb/viewtopic.php?topic_id=199&forum=5

(7) add "show blog" block

(8) added conf_valuetype field into config table

(9) supported stylesheet

(10) admin page
(10-1) show bread crumb in table manage.
(10-2) strengthened to ckeck parameter in table manage.
(10-3) show error message, if cannot parse RSS feed, when add new link.
(10-4) added to check overlapping RSS URL

(11) used session ticket class (XoopsGTicket)
reffer Perk's Tinyd module

(12) bug fixed
(12-1) 'blong link' jump always 'rssc' directory
http://dev.xoops.org/modules/xfmod/tracker/index.php?func=detail&aid=4145&group_id=1300&atid=1353

(12-2) Fatal error occured when can not parse RSS

(12-3) link of search result was not found


=================================================
Version: 0.30
Date:   2006-07-10
=================================================

* main changes *
(1) happy_linux module
happy_linux module was created as the common function,
ane independent from this RSS Center module.
Becuase prepares for the integration with weblinks module,
happy_linux module is necessary, to use this RSS center module. 

(2) rssc_headline module.
added cooperation feature with rssc_headline module.
rssc_headline is based on xoopsheadline,
modify to use RSS management function of RSSC module.

(3) supported podcast.
When there are enclosure tag in RSS feed, 
assume as podcast and display the link of podcast.

(4) added check to exist same link
check to exist link which has same RDF/RSS/ATOM URL, when admin will add new link.
show message which there are twe or more links which has same RDF/RSS/ATOM URL, 
when admin will modify link.

(5) displayed bread crumb.
(6) added an description in main page.
(7) changed the default value of command line (bin_refresh).
(8) saved image tag of RSS feed into link table.
(9) corrected the bug which pagenavi doesn't work in feed management.

It changed an innards roughly.
(1) added fileds for podcast into feed table.


* requirement *
happy_linux module is necessary.


* Notice *
I change almost all files. 
Although there are no big problem, but I think that there are any small problem. 
Welcome a bug report, a bug solution, and your hack, etc.


* TODO *
(1) Make the function which cooperates with weblinks module.
(2) Make the structure which shares a blacklist. 
(3) Add search result block
(4) Add the list of headlines link in admin page.


=================================================
Version: 0.20
Date:   2006-06-08
=================================================

* main changes *
1. Function for users 
(1) added single link view (single_link). 
(2) added single link view with UTF-8 encoding (single_link_utf8). 
(3) strengthened inspection of javascript at permission HTML tags. 
(4) changed from the debug mode to the usual mode, when an administrator views builded RSS.

(5) assigned site_tile and site_link for block templates.
http://linux.ohwada.jp/modules/newbb/viewtopic.php?topic_id=432&forum=9

2. Function for Administrators 
(1) abolished "feed registration". 
(2) added viewing builded RSS in debug mode. 
(3) added updating RSS feeds after registering and editing a link record. 

(4) assumed UTF-8 into default encoding, if cannot detect the encoding automatically.
http://dev.xoops.org/modules/xfmod/tracker/?func=detail&aid=3875&group_id=1300&atid=1353
http://linux2.ohwada.net/modules/newbb/viewtopic.php?viewmode=flat&topic_id=145&forum=5

(5) added icon which be view single link or single feed. 
(6) cut down the overhead in executing command line. 
handling DB directly, not to use XOOPS core files.

3. Implementation and internal structure 
(1) adopted "magpie RSS" for RSS parser. 
abolished selection of parsers, only use magpie RSS.
added some items to parse and view RSS in admin page.

(2) used object class after parsing RSS feeds. 
(3) changed to "serialize" function for saving channel and rows. 

4. PHP 5
(1) corrected following notices. 
Only variable references should be returned by reference

5. Language pack
(1)  Add French. 
http://linux2.ohwada.net/modules/newbb/viewtopic.php?topic_id=177&forum=5

6. Bug fixed
(1) BUG 3622: cannot modify blacklist
http://dev.xoops.org/modules/xfmod/tracker/index.php?func=detail&aid=3622&group_id=1300&atid=1353

(2) BUG 3864: suppress Notice Undefined offset: 0
http://dev.xoops.org/modules/xfmod/tracker/index.php?func=detail&aid=3864&group_id=1300&atid=1353


* Notice *
I change almost all files. 
Although there are no big problem, but I think that there are any small problem. 
Welcome a bug report, a bug solution, and your hack, etc.


* TODO *
(1) Make the sample which cooperates with other modules.
(2) Make the structure which shares a blacklist. 
(3) Add search result block
(4) Add the list of headlines link in admin page.


=================================================
Version: 0.11
Date:   2006-01-21
=================================================

* changes *
(1) add module number to block name
(2) add descent id order to record list
(3) change method to update record
(4) correct broken link of menu.php

=================================================
Version: 0.10
Date:   2006-01-01
=================================================

* Module Outline *
This module collects RDF/RSS/ATOM feeds from the registered sites, and stores in a database.
This module searchs feeds in database, and carries out the search results in RDF/RSS/ATOM form.

This module becomes independent from the RDF/RSS/ATOM function of WebLinks module,
and enhances more powerful.

This module aims the platform of RDF/RSS/ATOM feeds.
As an example of application, like a headline module, like the Web Service http://sf.livedoor.com/.

Now, it is the beta version. 
From now on, the specification and implementation may change sharply. 
Even if some problems come out, only those who can do somehow personally need to use. 
Welcome the proposal of specification or the example of application, a bug report, a bug solution, and your hack, etc.


* Main Function * 
1. Site Registration 
Enter A site name, site URL, URL of RDF/RSS/ATOM, cash time, etc.

2. RDF/RSS/ATOM Auto Discovery 
If a site corresponds to "RDF/RSS/ATOM Auto Discovery",
when you register the URL of a site,
this module will detect automatically the URL of RDF/RSS/ATOM, and register it. 

3. Blacklist 
If you register Blog Search Sites, such as http://sf.livedoor.com/,
this module may collect feeds which you dont desire. 
If you register the URL of undesirable site into a blacklist, 
this module will stop to collect feeds from this site.

4. How to collect RDF/RSS/ATOM feeds
This module supports three methods. 

4.1 Someone accesses by WEB browser. 
When someone accesses a simple headline page or block.
this module collects automatically RDF/RSS/ATOM feeds.
This module collects feeds form the only sites to show in the simple headline. 
A timeout may be carried out, if there are many sites to show in the simple headline. 

4.2  An administrator collects manually. 
This module supports "archive management" in admin page. 

4.3  Automatically in the command line mode. 
Look "setup of a command line".

5. XML Parser of RDF/RSS/ATOM feed
5.1  Character Code 
This module can correspond to many character codes. 
However, if there is no specification of a character code in XML format,
or XML use character code which PHP multi-byte function does not support,
this module may not parse it correctly.
Since PHP XML parser function support only US-ASCII or UTF-8,
this module converts another character code to UTF-8, and parses it.

5.2  Parser Selection 
According to XML form as RDF or RSS or ATOM,
this module will select XML parser automatically. 
Furthermore, this module support two or more parser,
you can select a favorite parser.
this module support the XOOPS core's RSS parser and this module's original parser.
The original parser can parse many items than XOOPS parser.

6. Show of RDF/RSS/ATOM feeds
(1) allow to use HTML tags, or not
You can choice to use HTML tags, or not, in Title and Content.
If you choise use HTML tags and Content contains Java Script, 
this module may sanitaize JS, and JS will become invalid. 

7. Processing of a deficient RDF/RSS/ATOM feeds 
(1) no title
If feed have no tile,
this module substituted by "---", and show it

(2) no date
If feed have no date, this feed may be shown always in the tail end.
This module substitute by present time, and store it to database.

(3) future date
If feed have future date, this feed may be shown  always in top line.
This module show feeds except more than 3 days future.

8. Server environment 
(1) This module corresponds to PHP allow_url_fopen is off. 

9. Import from other Module 
9.1 XoopsHeadline Module
This module can import the data from XoopsHeadline Module,
such as headline table. 

9.2 WebLinks Module
This module can import the data from WebLinks Module,
such as link table, feed table, and blacklist. 
A present, there is no cooperation function with RSSC and WebLinks.
You MUST continue to use WebLinks RSS/ATOM function.

10. Module Duplicate 
This module can be duplicated only by copying. 
It is the same function as TinyD module, etc. 
Currently prepared module name are "rssc" and "rssc0" . 
When you want touse another name,
please create necessary files in sql, templates, and images directory. 


* Installation *
(1) Unzip rssc.zip.
    The directory "rssc" will be made. 
(2) Install RSSC module in XOOPS admin page. 
(3) Click RSSC icon, and goto the management page of RSSC module. 
(4) In first time, some warning are displayed.
  (i) The config table is not initialized 
      Click save, and initialize. 
  (ii) Not writable the directory. 
       Permit to write in rssc/cache directory. 
(5) Confirm that "xoops.org" is registered by "Link List" 
(6) Execute "Refresh Archive" in "Archive Management"
(7) Click "Goto Module", and show the top page of RSSC module.
(8) The latest feeds is showing, it will be OK.
(9) If necessity, import data from XoopsHeadline module or WebLinks module. 

* setup of a command line *
This function is assumed to execute a command line periodically by Cron. 
Please delete bin directory, if unnecessary. 

(1) Goto admin page.
(2) Execute "Create Config File" in "Command Manage".
(3) Execute "Test to execute bin/refresh.php".

(4) Add the following to crontab. 
-----
22 3 * * * /usr/bin/php -q -f /home/***/html/modules/rssc/bin/refresh.php password 
-----
password is displayed "password" at "Command Config" in "Module Configration".


* TODO *
(1) In XML parser, add magpieRSS and PEAR RSS. 
(2) Make the structure which shares a blacklist. 
(3) Make the sample which cooperates with other modules.
(4) Add search result block
(5) show whith HTML tag ina headline. 
(6) Add the list of headlines link in admin page.

