You are here

Home » API reference » Views OAI-PMH 6.2

README.txt in Views OAI-PMH 6.2

Same filename and directory in other branches
  1. 6 README.txt
  2. 7.3 README.txt
  3. 7 README.txt
  4. 7.2 README.txt
Views OAI-PMH
=============
 
This is a Views plug-in module which creates a OAI-PMH data provider using any 
fields which the Views module has access to.

It is configured to expose metadata in the following formats:
  Dublin Core (oai_dc)
  Learning Objects Metadata (oai_lom)
  Learning Resource Exchange (oai_lre)
  IMS Learning Objects Exchange (oai_ilox)

It can be extended to work with other OAI formats by modifying the file
includes/views_oai_pmh_metadata_type_definitions.inc. 

 
 Prerequisite software
 =====================
 
This module requires Views 3.x for both Drupal 6 and Drupal 7.  
 
 
 Using the "Views OAI-PMH" module
 ====================================
 
  1. Add a new "OAI-PMH" display to your view.
  2. Change its "Style/Format" to "OAI-PMH (auto)".
  3. Select your preferred "Row style" from the available options. To allow your
     OAI-PMH data provider to respond with any of the requested data types,
     choose the "Auto fields" option.
  4. Configure the Drupal-"field"-to-OAI-"element" mapping using the row style
     settings control - match up the Drupal fields in the left-hand column with
     the OAI elements in the right-hand column to create the mapping.
  5. Some metadata types create XML elements in the output that require certain
     attributes, such as language, to be specified. You can achieve this by
     mapping a Drupal field to an element labeled "(Attribute)". Sometimes you
     won't have this information available in your Drupal setup, in which case
     you can create a field of "Global > Custom Text", which you can map to the
     attribute as required.
  6. Give the view a path such as "oai" and save it.
  7. Optionally, you can test your repository by going to http://re.cs.uct.ac.za/ 
      and entering the full url and path (http://example.com/oai) in the 
     "Enter the OAI baseURL :" box and then clicking on 
     "Test the specified/selected baseURL" (on the right side of the page).
 
 
Default Views
=============

A default view called "biblio_oai" is provided as an example.  This view emulates the oai2 module.

File

README.txt
View source 
  1. Views OAI-PMH

  2. =============

  3.  

  4. This is a Views plug-in module which creates a OAI-PMH data provider using any 

  5. fields which the Views module has access to.

  6. 

  7. It is configured to expose metadata in the following formats:

  8.   Dublin Core (oai_dc)

  9.   Learning Objects Metadata (oai_lom)

  10.   Learning Resource Exchange (oai_lre)

  11.   IMS Learning Objects Exchange (oai_ilox)

  12. 

  13. It can be extended to work with other OAI formats by modifying the file

  14. includes/views_oai_pmh_metadata_type_definitions.inc. 

  15. 

  16.  

  17.  Prerequisite software

  18.  =====================

  19.  

  20. This module requires Views 3.x for both Drupal 6 and Drupal 7.  

  21.  

  22.  

  23.  Using the "Views OAI-PMH" module

  24.  ====================================

  25.  

  26.   1. Add a new "OAI-PMH" display to your view.

  27.   2. Change its "Style/Format" to "OAI-PMH (auto)".

  28.   3. Select your preferred "Row style" from the available options. To allow your

  29.      OAI-PMH data provider to respond with any of the requested data types,

  30.      choose the "Auto fields" option.

  31.   4. Configure the Drupal-"field"-to-OAI-"element" mapping using the row style

  32.      settings control - match up the Drupal fields in the left-hand column with

  33.      the OAI elements in the right-hand column to create the mapping.

  34.   5. Some metadata types create XML elements in the output that require certain

  35.      attributes, such as language, to be specified. You can achieve this by

  36.      mapping a Drupal field to an element labeled "(Attribute)". Sometimes you

  37.      won't have this information available in your Drupal setup, in which case

  38.      you can create a field of "Global > Custom Text", which you can map to the

  39.      attribute as required.

  40.   6. Give the view a path such as "oai" and save it.

  41.   7. Optionally, you can test your repository by going to http://re.cs.uct.ac.za/ 

  42.       and entering the full url and path (http://example.com/oai) in the 

  43.      "Enter the OAI baseURL :" box and then clicking on 

  44.      "Test the specified/selected baseURL" (on the right side of the page).

  45.  

  46.  

  47. Default Views

  48. =============

  49. 

  50. A default view called "biblio_oai" is provided as an example.  This view emulates the oai2 module.