Show
Ignore:
Timestamp:
12/13/06 17:22:00 (16 years ago)
Author:
liq
Message:

liq's feed syndication mod 1.3

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • dev/mods/feed_syndication/readme.txt

    r148 r152  
    1  
    2 // liq's feed syndication mod v1.1 
     1        ////// 
     2//////  ////// 
     3//////  liq's feed syndication mod v1.3 
     4//////////// 
     5//////////// 
     6//////////// 
     7//////////// 
    38 
    49 
    510 
    6 //installation: 
     11//INSTALLATION: 
    712 
    8 1. put all the files in your /common directory. 
     131. create directory mods/feed 
     142. put the files settings.php and feed_fetcher.php in /mods/feed_syndication directory. 
     153. put feed.php in your /common directory 
     163. login as admin and enable the feed-mod in 'Mods' 
     174. wee. youre done. 
    918 
    10 2. add the following line to admin_menu.php: 
    11 $menubox->addOption( "Feeds", "?a=admin_feed" ); 
    12  
    13 3. youre done. 
     19additionally you can add the following line to common/admin_menu.php for direct access: 
     20$menubox->addOption( "Feeds", "?a=settings_feed_syndication" ); 
     21or if you use eve-dev kilboard version 1.2.0 and above (using smarty templates): 
     22$menubox->addOption("link", "Feeds", "?a=settings_feed_syndication"); 
    1423 
    1524 
    16 //files 
     25 
     26//FILES: 
    1727 
    1828feed.php <- prints out all kills of the actual week in rss format. 
    … …  
    2333 
    2434 
    25 //notes 
    2635 
    27 -> enter feed urls in the format 'http://killboard.eve-d2.com/?a=feed' into the admin interface. 
    28 click 'save' to save your changes before you 'fetch' new kills. 
     36//NOTES: 
     37 
     38-> enter feed urls in the format: http://killboard.eve-d2.com/?a=feed 
     39 
     40-> a list of known feeds can be found here: http://www.eve-dev.net/e107_plugins/forum/forum_viewtopic.php?1896 
    2941 
    3042-> clicking the 'fetch' button will get all kills of the actual week. 
    3143 
    32 -> ticking the 'grab-ALL-mails-box' will grab ALL kills! be careful with this option! 
    33 ** it can take several minutes or even hours to have all the kills parsed and added to your database ** 
    34 ** be patient. don't close your browser, don't reload. you only need to use this ONCE in a lifetime ** 
     44-> ticking the 'grab-ALL-mails-box' will grab the kills of ALL weeks (iteration from week #1 through to week #52)! 
     45** be careful with this option! it can take several minutes or even hours to have all the kills parsed and added to your database ** 
     46** be patient. don't close your browser, don't reload. you only need to use this ONCE to initialize a feed connection. 
     47after initializing, weekly updates are totally sufficient to keep your board uptodate ** 
     48 
     49-> by default their kills aka. your losses get fetched unless you tick the 'get kills' 
     50option in which case their losses aka. your kills get fetched 
     51 
     52-> GZip compression is enabled by default because the board automatically 
     53checks and decides if a fetched stream supports GZip compression - if not it uses regular html/rss output. 
     54 
     55-> if you are running a master killboard (eg. to supply and share killdata with other killboards) edit settings.php and set 'MASTER' to 1. 
     56the board will then even fetch kills not related to the alliance or corp ID you set in the killboards config.php. 
     57leave this option untouched if youre running a normal killboard for your corp or alliance - it will just slow things down. 
     58 
     59-> the feed is not supposed to be human readable so ffs dont complain about the formatting, 
     60for human readable rss output use the rss mod ( /?a=rss ) instead. 
    3561 
    3662 
    37 //changes 
     63 
     64//VERSION CHANGES: 
     65 
     66//v1.3 
     67 
     68feed.php: 
     69- added support for GZip compressed output 
     70- minor code cleanups 
     71 
     72feed_fetcher.php: 
     73- converted to a mod 
     74- added support for getting GZip compressed feeds and a fallback if the feed is uncompressed 
     75- changed the text in auto-comment to only show the remote killboards url and not the  
     76complete path with all passed variables, making it more readable 
     77 
     78admin_feed.php / settings.php 
     79- converted to a mod  
     80- renamed to settings.php 
     81- added option to fetch streams with Gzip compression - enabled by default 
     82- added support for master killboards whose only purpose is to collect and share kill data, see notes 
     83 
     84 
     85//v1.2 
     86 
     87feed.php: 
     88- added output of feed's version number 
     89 
     90feed_fetcher.php: 
     91- none 
     92 
     93admin_feed.php 
     94- rearranged options to be inline with other admin settings pages 
     95- added checkboxes to enable / disable fetching specific feed urls 
     96 
    3897 
    3998//v1.1 
    … …  
    50109- included calls to the killboards comment function so you can add predefined comments to autoparsed kills aka. "post your losses noob". 
    51110 
    52 admin_feed.php 
     111admin_feed.php: 
    53112- made the number of feeds user selectable 
    54113- more detailed descriptions 
    … …  
    56115- option to automatically enter a comment with the autoparsed kill 
    57116- option to get kills instead of losses 
     117- added backwards compatibility to exi's v1.0 mod 
    58118 
    59119