root/dev/mods/feed_syndication/readme.txt @ 170

Revision 170, 5.7 KB (checked in by liq, 14 years ago)

fliq's feed syndication mod 1.4

RevLine 
[152]1        //////
2//////  //////
[170]3//////  liq's feed syndication mod v1.4
[152]4////////////
5////////////
6////////////
7////////////
[148]8
9
10
[152]11//INSTALLATION:
[148]12
[170]13### --> STANDALONE version:
141. put all files in your /common directory
15
162. add the following line to common/admin_menu.php:
17$menubox->addOption( "Feeds", "?a=admin_feed" );
18or if you use eve-dev kilboard version 1.2.0 and above (using smarty templates):
19$menubox->addOption("link", "Feeds", "?a=admin_feed");
20
213. wee. youre done.
22
234. you can access the feed interface now via the menubox in admin menu
24
25
26### --> MOD version:
[152]271. create directory mods/feed
[170]28
[152]292. put the files settings.php and feed_fetcher.php in /mods/feed_syndication directory.
[170]30
[152]313. put feed.php in your /common directory
[170]32
[152]333. login as admin and enable the feed-mod in 'Mods'
[170]34
[152]354. wee. youre done.
[148]36
[170]375. click 'Settings' in the 'Mods' menu to access the feed interface
38
[152]39additionally you can add the following line to common/admin_menu.php for direct access:
[170]40$menubox->addOption( "Feeds", "?a=settings_feed" );
[152]41or if you use eve-dev kilboard version 1.2.0 and above (using smarty templates):
[170]42$menubox->addOption("link", "Feeds", "?a=settings_feed");
[148]43
44
45
[152]46//FILES:
[148]47
48feed.php <- prints out all kills of the actual week in rss format.
49
50feed_fetcher.php <- contains the actual xml parser class.
51
52admin_feed.php <- is the interface to feed_fetcher.php. lets you define feeds of other killboards and import kills.
53
54
55
[152]56//NOTES:
[148]57
[152]58-> enter feed urls in the format: http://killboard.eve-d2.com/?a=feed
59
[170]60-> a list of known feeds can be found here: http://myeve.eve-online.com/ingameboard.asp?a=topic&threadID=443506&page=1#2
[152]61
[170]62-> your actual week is automatically selected in the first and last week boxes.
[148]63
[170]64-> clicking the 'fetch' button will by default get all kills of the actual week unless you select a different timeframe.
[148]65
[170]66-> selecting a timeframe with the first and last week boxes lets the fetcher get all mails of this timeframe.
67** be careful with this option! it can take several minutes or even hours to have all
68the kills parsed and added to your database, especially if you select a really long timeframe **
69** be patient. don't close your browser, don't reload. after doing a full fetch first, weekly updates are totally sufficient to keep your board uptodate **
70
71
[152]72-> by default their kills aka. your losses get fetched unless you tick the 'get kills'
73option in which case their losses aka. your kills get fetched
[148]74
[152]75-> GZip compression is enabled by default because the board automatically
76checks and decides if a fetched stream supports GZip compression - if not it uses regular html/rss output.
[148]77
[170]78
[152]79-> if you are running a master killboard (eg. to supply and share killdata with other killboards) edit settings.php and set 'MASTER' to 1.
80the board will then even fetch kills not related to the alliance or corp ID you set in the killboards config.php.
[170]81leave this option untouched if youre running a normal killboard for your corp or alliance - it will just slow things down and
82wont work for you without modifications to the parser class.
[152]83
[170]84-> the feed is not supposed to be human readable so ffs dont complain about the formatting.
[152]85for human readable rss output use the rss mod ( /?a=rss ) instead.
86
87
88
89//VERSION CHANGES:
90
[170]91
92//v1.4
93
94feed.php:
95- added selection of the year to output
96- added support for friend<->friend killboard fetching
97- minor code cleanups
98- other stuff i forgot
99
100feed_fetcher.php:
101- added a fix for the memory exhaustion bug some boards had (check if your php is running in php-safe-mode. if so, disable it)
102- improved verbose output
103
104admin_feed.php / settings.php
105- replaced the grab-all switch with an advanced range selection system by week and year
106- added support for friend<->friend killboard fetching
107- minor code cleanups
108- other stuff i forgot
109
110
[152]111//v1.3
112
113feed.php:
114- added support for GZip compressed output
115- minor code cleanups
116
117feed_fetcher.php:
118- converted to a mod
119- added support for getting GZip compressed feeds and a fallback if the feed is uncompressed
120- changed the text in auto-comment to only show the remote killboards url and not the
121complete path with all passed variables, making it more readable
122
123admin_feed.php / settings.php
124- converted to a mod
125- renamed to settings.php
126- added option to fetch streams with Gzip compression - enabled by default
127- added support for master killboards whose only purpose is to collect and share kill data, see notes
128
129
130//v1.2
131
132feed.php:
133- added output of feed's version number
134
135feed_fetcher.php:
136- none
137
138admin_feed.php
139- rearranged options to be inline with other admin settings pages
140- added checkboxes to enable / disable fetching specific feed urls
141
142
[148]143//v1.1
144
145feed.php:
146- now lets you also grab losses, not only kills.
147- will give out only the kills where the request-board-owner (corp or alliance) is victim,
148or in case of losses, the involved. this should speed things up significantly.
149- included a check for Last_Kill_ID so it starts to output kill data only after
150that ID to remove redundancy when fetching a feed more than once.
151
152feed_fetcher.php:
153- included getConfig and setConfig call functions to guarantee backwards compatiblity with older killboard version that miss those functions.
154- included calls to the killboards comment function so you can add predefined comments to autoparsed kills aka. "post your losses noob".
155
[152]156admin_feed.php:
[148]157- made the number of feeds user selectable
158- more detailed descriptions
159- option for verbose mode (lets you show/hide errormessages from imported killmails)
160- option to automatically enter a comment with the autoparsed kill
161- option to get kills instead of losses
[152]162- added backwards compatibility to exi's v1.0 mod
[148]163
164
165
166cheers
167//liquidism
Note: See TracBrowser for help on using the browser.