h1. DPLA Discovery
In the current 0.0.1 release, all that is given is a bare-bones search box with only a handful of options. Future versions are expected to include more advance searching/filtering and allow for a type of recommendation system without the need for the search box.
h2. Example Site (temporary)
h3. Step 1 - Request a DPLA API Key
Please follow the instructions to "request a DPLA API key,":http://dp.la/info/developers/codex/policies/ which you'll need for step 3.
h3. Step 2A - Local:
Clone this repository.
Place the JS and CSS files somewhere on your server to link to.
Add the following to your file updating the script references:
h3. Step 2B - Linked (evaluation purposes only!):
Add the following to a file:
h3. Step 3:
Add the following snippet of code referring to your search box. Insert the API key you received in Step 1 between quotes in place of @your DPLA [email protected]
h3. Step 4 (Accessibility Fallback Support)
Setup your page something like the following:
h3. Options and Examples
For options (such as page size adjustment or limiting to your institution) and further examples, please see the index.html file along with files under the "test" directory.
h2. Known Alpha Bugs
- Basic "Show More" functionality implemented. Still a tad buggy but works in the most basic case.
More coming soon! For now, feel free to fork and submit improvements. In addition, feel free to contact me with what might make this usable for your institute at [email protected]
Contributors are located in the file CONTRIBUTORS.md
Source code for base app from Freebase https://code.google.com/p/freebase-site/source/browse/#svn%2Ftrunk%2Fwww%2Flib%2Fsuggest