Difference between revisions of "DiscoverEd Data"
| Line 18: | Line 18: | ||
== Integrating Open Education Search == | == Integrating Open Education Search == | ||
| − | Any site may include Open Education Search on their website by pointing to our CSE context definition. For example, the following block of HTML will produce a search box with the same semantics as Open Education Search. For more information on customizing the results format | + | Any site may include Open Education Search on their website by pointing to our CSE context definition. For example, the following block of HTML will produce a search box with the same semantics as Open Education Search. For more information on customizing the results format or hosting the results on your site, see the [http://google.com/coop/docs/cse/cref.html Linked CSE documentation] from Google. |
<code><pre> | <code><pre> | ||
| Line 34: | Line 34: | ||
== Customizing OE Search == | == Customizing OE Search == | ||
| − | Another re-use scenario is the | + | Another re-use scenario is the use of the dataset, with adjustments made to result weighting. We use labels for subject annotations, as well as annotating the source of the URL. For example, URLs received from [http://cnx.org Connexions] are labeled with <code>connexions</code>. Using these labels you can promote the results from your site while still maintaining the web-scale breadth of Open Education Search. |
| + | |||
| + | Weight adjustment requires publishing a context file which provides the basic definition of your search engine. Within this definition you can define a relative weighting for a label: | ||
<code><pre> | <code><pre> | ||
| − | <Label name=" | + | <Label name="connexions" mode="BOOST" weight="0.8"></Label> |
</pre></code> | </pre></code> | ||
| + | |||
| + | Additionally, your definition can refer to our lists of URL annotations: | ||
| + | |||
| + | <code><pre> | ||
| + | <Include type="Annotations" href="http://oercloud.creativecommons.org/api/posts/coop?p=0"/> | ||
| + | ... | ||
| + | </pre></code> | ||
| + | |||
| + | '''NB: We currently require the "p=n" query string to reduce processing load; we will be publishing a single annotation file you can include by October 15, 2007.''' | ||
== Additional Resources and Information == | == Additional Resources and Information == | ||
| + | |||
| + | * [http://oercloud.creativecommons.org/api/posts/coop_context Open Education Search CSE Context] | ||
| + | * [http://google.com/coop/docs/cse/cref.html Linked CSE documentation] | ||
Revision as of 14:33, 27 September 2007
Open Education Search is a project of ccLearn. You can find more information on the project at http://learn.creativecommons.org/projects/oesearch/.
This page documents ways in which developers may use the data gathered by the project for other purposes, including integration and customization.
Contents
Data Gathered
The Open Education Search (OES) project is a web-scale search of Open Educational Resources (OER). As such, it utilizes a web-wide index, promoting results which have been identified as OER. ccLearn is serving as an aggregation point for other organizations which have identified or produced OER. At this time we gather:
- URLs or URL patterns
- Subject annotations, sometimes called labels
We are not currently attempting to aggregate rich metadata sets.
The data gathered is currently available in a format suitable for use in a Google Custom Search Engine; ccLearn is committed to making it available in a "raw" format for further reuse.
Integrating Open Education Search
Any site may include Open Education Search on their website by pointing to our CSE context definition. For example, the following block of HTML will produce a search box with the same semantics as Open Education Search. For more information on customizing the results format or hosting the results on your site, see the Linked CSE documentation from Google.
<form id="cref" action="http://google.com/cse">
<input type="hidden" name="cref"
value="http://oercloud.creativecommons.org/api/posts_context"
/>
<input type="text" name="q" size="40" />
<input type="submit" name="sa" value="Search" />
</form>
<script type="text/javascript"
src="http://google.com/coop/cse/brand?form=cref"></script>
Customizing OE Search
Another re-use scenario is the use of the dataset, with adjustments made to result weighting. We use labels for subject annotations, as well as annotating the source of the URL. For example, URLs received from Connexions are labeled with connexions. Using these labels you can promote the results from your site while still maintaining the web-scale breadth of Open Education Search.
Weight adjustment requires publishing a context file which provides the basic definition of your search engine. Within this definition you can define a relative weighting for a label:
<Label name="connexions" mode="BOOST" weight="0.8"></Label>
Additionally, your definition can refer to our lists of URL annotations:
<Include type="Annotations" href="http://oercloud.creativecommons.org/api/posts/coop?p=0"/>
...
NB: We currently require the "p=n" query string to reduce processing load; we will be publishing a single annotation file you can include by October 15, 2007.
