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

Revision 175, 6.3 KB (checked in by liq, 14 years ago)

liliq's feed syndication mod 1.5

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