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

Revision 152, 4.5 KB (checked in by liq, 14 years ago)

liq's feed syndication mod 1.3

Line 
1        //////
2//////  //////
3//////  liq's feed syndication mod v1.3
4////////////
5////////////
6////////////
7////////////
8
9
10
11//INSTALLATION:
12
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.
18
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");
23
24
25
26//FILES:
27
28feed.php <- prints out all kills of the actual week in rss format.
29
30feed_fetcher.php <- contains the actual xml parser class.
31
32admin_feed.php <- is the interface to feed_fetcher.php. lets you define feeds of other killboards and import kills.
33
34
35
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
41
42-> clicking the 'fetch' button will get all kills of the actual week.
43
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.
61
62
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
97
98//v1.1
99
100feed.php:
101- now lets you also grab losses, not only kills.
102- will give out only the kills where the request-board-owner (corp or alliance) is victim,
103or in case of losses, the involved. this should speed things up significantly.
104- included a check for Last_Kill_ID so it starts to output kill data only after
105that ID to remove redundancy when fetching a feed more than once.
106
107feed_fetcher.php:
108- included getConfig and setConfig call functions to guarantee backwards compatiblity with older killboard version that miss those functions.
109- included calls to the killboards comment function so you can add predefined comments to autoparsed kills aka. "post your losses noob".
110
111admin_feed.php:
112- made the number of feeds user selectable
113- more detailed descriptions
114- option for verbose mode (lets you show/hide errormessages from imported killmails)
115- option to automatically enter a comment with the autoparsed kill
116- option to get kills instead of losses
117- added backwards compatibility to exi's v1.0 mod
118
119
120
121cheers
122//liquidism
Note: See TracBrowser for help on using the browser.