Difference between revisions of "Hack Fest 2010"

From Jon's Wiki
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
== PHP Hackfest Cheat Sheet ==
+
The 2010 PHP Hackfest Cheat Sheet!
  
=== Mahara ===
+
== Mahara Project ==
 +
 
 +
=== Plan ===
 +
 
 +
To integate [http://status.net/ Status Net], the open-source "host-your-own" Twitter, into [http://mahara.org Mahara], an open source e-portfolio system.
 +
 
 +
;First Step: A block to follow a twitter tag.
 +
 
 +
=== Useful Links ===
  
 
* [http://gitorious.org/mahara/mahara Downloading Mahara]
 
* [http://gitorious.org/mahara/mahara Downloading Mahara]
Line 7: Line 15:
 
* [http://wiki.mahara.org/Developer_Area/Coding_guidelines Mahara Coding Guidelines]
 
* [http://wiki.mahara.org/Developer_Area/Coding_guidelines Mahara Coding Guidelines]
  
=== Moodle ===
+
* [http://dev.twitter.com/doc Twitter API]
* [http://git.moodle.org/gw?p=moodle.git;a=summary Downloading Moodle]
+
 
* [http://docs.moodle.org/en/Administrator_documentation Installing Moodle]
+
== Moodle Project ==
* [http://docs.moodle.org/en/Development:Coding_style Moodle Coding Guidelines]
+
 
 +
=== Plan ===
 +
 
 +
To get Moodle (open-source learning management system) working with Koha (open-source integrated library system).
 +
 
 +
;First Step: Let's start by extending the Moodle [http://cvs.moodle.org/contrib/plugins/blocks/extsearch/ External Search block] to query a Koha library system and display the returned records of Koha books.
 +
 
 +
=== Koha Search ===
  
== Koha Search ==
+
# Here's a Koha already set up we can use - no Koha set up required (phew!):
# Here's a Koha already set up we can use - http://opac.koha.workbuffer.org:9998/
+
#* http://opac.koha.workbuffer.org:9998/
# Koha uses an open standard from the US [http://loc.gov Library of Congress] called [http://www.loc.gov/standards/sru/ SRU] - Search/Retrieval by URL.
+
# Koha uses an open standard from the [http://loc.gov Library of Congress] called [http://www.loc.gov/standards/sru/ SRU] - Search/Retrieval by URL.
# Using the [http://www.loc.gov/z3950/agency/ Z39.50] [http://explain.z3950.org/ Explain] protocol, we can "self-discover" the Koha catalog search interface, by parsing the XML returned from
+
# Using the [http://www.loc.gov/z3950/agency/ Z39.50] [http://explain.z3950.org/ Explain] protocol, we can "self-discover" the Koha catalog search interface:
#* http://opac.koha.workbuffer.org:9998/?version=1.1&operation=explain
+
#* [http://opac.koha.workbuffer.org:9998/?version=1.1&operation=explain http://opac.koha.workbuffer.org:9998/?version=1.1&'''operation=explain''']
# using the <database> element, we can construct a search URL:
+
# by parsing the XML response, we can use the <database> element (in this case, ''"biblios"'') to construct a search URL:
#* http://opac.koha.workbuffer.org:9998/biblios?version=1.1&operation=searchRetrieve&query=fish
+
#* [http://opac.koha.workbuffer.org:9998/biblios?version=1.1&operation=searchRetrieve&query=fish http://opac.koha.workbuffer.org:9998/'''biblios'''?version=1.1&'''operation=searchRetrieve&query=fish''']
 
#which will return the number of results:
 
#which will return the number of results:
 
#* <zs:numberOfRecords>178</zs:numberOfRecords>
 
#* <zs:numberOfRecords>178</zs:numberOfRecords>
 
# Then we can grab (e.g.) records 5 and 6, in Dublin Core, like this:
 
# Then we can grab (e.g.) records 5 and 6, in Dublin Core, like this:
#* http://opac.koha.workbuffer.org:9998/biblios?version=1.1&operation=searchRetrieve&query=fish&startRecord=5&maximumRecords=2&recordSchema=dc
+
#* [http://opac.koha.workbuffer.org:9998/biblios?version=1.1&operation=searchRetrieve&query=fish&startRecord=5&maximumRecords=2&recordSchema=dc http://opac.koha.workbuffer.org:9998/biblios?version=1.1&operation=searchRetrieve&query=fish'''&startRecord=5&maximumRecords=2&recordSchema=dc''']
  
 
=== Useful Links ===
 
=== Useful Links ===
* [http://dev.twitter.com/doc Twitter API]
+
 
 +
* [http://git.moodle.org/gw?p=moodle.git;a=summary Downloading Moodle]
 +
* [http://docs.moodle.org/en/Administrator_documentation Installing Moodle]
 +
* [http://docs.moodle.org/en/Development:Coding_style Moodle Coding Guidelines]
 +
 
 
* [http://cvs.moodle.org/contrib/plugins/blocks/extsearch/ Moodle External Search block]
 
* [http://cvs.moodle.org/contrib/plugins/blocks/extsearch/ Moodle External Search block]
 
* [http://koha-community.org/ Koha Integrated Library System]
 
* [http://koha-community.org/ Koha Integrated Library System]

Latest revision as of 22:52, 23 July 2010

The 2010 PHP Hackfest Cheat Sheet!

Mahara Project

Plan

To integate Status Net, the open-source "host-your-own" Twitter, into Mahara, an open source e-portfolio system.

First Step
A block to follow a twitter tag.

Useful Links

Moodle Project

Plan

To get Moodle (open-source learning management system) working with Koha (open-source integrated library system).

First Step
Let's start by extending the Moodle External Search block to query a Koha library system and display the returned records of Koha books.

Koha Search

  1. Here's a Koha already set up we can use - no Koha set up required (phew!):
  2. Koha uses an open standard from the Library of Congress called SRU - Search/Retrieval by URL.
  3. Using the Z39.50 Explain protocol, we can "self-discover" the Koha catalog search interface:
  4. by parsing the XML response, we can use the <database> element (in this case, "biblios") to construct a search URL:
  5. which will return the number of results:
    • <zs:numberOfRecords>178</zs:numberOfRecords>
  6. Then we can grab (e.g.) records 5 and 6, in Dublin Core, like this:

Useful Links