public
Description: Allows site developers to easily leverage the awesome power of Wikipedia’s articles.
Homepage: http://thecodetrain.co.uk/code/wikislurp/
Clone URL: git://github.com/NeilCrosby/wikislurp.git
Click here to lend your support to: wikislurp and make a donation at www.pledgie.com !
NeilCrosby (author)
Wed Dec 31 07:00:00 -0800 2008
commit  e8f6e51d7fe26881a1876d71ba054fab7a0084f4
tree    b3cd34d0d2cb695f49202abf2ef16392f82530cd
parent  da1e8cc31f48a4fac712c52adfa3836838785265
name age message
file .gitignore Wed Dec 31 06:54:28 -0800 2008 Moved from giternal to git submodules [NeilCrosby]
file .gitmodules Wed Dec 31 06:54:28 -0800 2008 Moved from giternal to git submodules [NeilCrosby]
file .htaccess Tue Nov 25 00:10:10 -0800 2008 Made example.php forbidden by default [NeilCrosby]
file LICENSE Tue Oct 28 09:59:45 -0700 2008 Initial text for LICENSE and README files. [NeilCrosby]
file README.Markdown Wed Dec 31 06:54:28 -0800 2008 Moved from giternal to git submodules [NeilCrosby]
directory classes/ Wed Dec 31 07:00:00 -0800 2008 Updated curlcall path [NeilCrosby]
directory client/ Tue Nov 18 10:54:27 -0800 2008 Added code to actually do things [NeilCrosby]
directory config/ Wed Dec 31 06:54:28 -0800 2008 Moved from giternal to git submodules [NeilCrosby]
file example.php Thu Dec 11 01:02:09 -0800 2008 Can now pass timeout parameter [NeilCrosby]
directory externals/ Wed Dec 31 06:54:28 -0800 2008 Moved from giternal to git submodules [NeilCrosby]
file index.php Thu Nov 20 11:01:26 -0800 2008 Removed done TODO [NeilCrosby]
README.Markdown

WikiSlurp

WikiSlurp is a project designed to allow site developers to easily leverage the awesome power of Wikipiedia's articles.

WikiSlurp is used as a web service that queries Wikipedia to return, in HTML format, portions of articles about a given subject. It's designed to be slotted into any webserver able to run PHP5, even those on shared hosting accounts. All requests to external services are heavily cached by default, with the actual cache time used being able to be changed by the site owner via the config file.

WikiSlurp is very much alpha software at present. I'm using it on Is Neil Annoyed By and The Ten Word Review though, so it is usable. If you have any comments, feature requests or patches please give them to me. I'm all ears.

Point releases are available for download from The Code Train, and the current development code is always available from the GitHub Repository.

Setup and Use

You'll need to set up a couple of keys to be able to get WikiSlurp to work. Both keys are set in the config/config.php file, which you can create from the config/config.php.example file.

The first is the SECRET key. This is what you use as your secret in the URL to call WikiSlurp. You can make this whatever you like, but you must set it otherwise WikiSlurp will bail out with an error.

The second key that needs to be set is the SEARCH_API_KEY. This is a Yahoo! BOSS API key, that you can get by signing up to Yahoo! BOSS (free, pretty easy to do). BOSS is used to find the Wikipedia articles that we slurp.

WikiSlurp comes with an example.php file that you can use to test the system and make sure that things are happening in the way you expect. In order to use the example.php file, you'll need to uncomment the line in the .htaccess file that forbids its use on production systems.

Git Submodules

After you have clone the repository, you'll need to run the following to pull in all the submodules:

git submodule init
git submodule update
cd externals/curlcall
git submodule init
git submodule update