Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 2.38 KB

README.md

File metadata and controls

51 lines (33 loc) · 2.38 KB

ODI Open Data Licensing

This project contains the source and documentation for the Open Data Rights Statement (ODRS) vocabulary.

The ODRS vocabulary is designed to support the publication of machine-readable "rights statements" that describe:

  • Which license(s) apply to a dataset -- there may be several, covering both the data and the content
  • The preferred means of attributing the dataset
  • A copyright statement
  • Pointers to additional documentation

The vocabulary builds on previous work, particularly Dublin Core and the Creative Commons ccREL vocabulary.

The wiki has some background documentation

Feedback

If you have feedback on the vocabularly please submit an issue (or even a pull request). This will allow us to capture and organise issues, their discussion and resolution.

Project Structure

The project is organised as follows:

  • schema -- the original turtle source for the schema, and the markdown documentation and diagrams
  • examples -- example uses of the vocabulary for different kinds of datasets and a variety of vocabularies
  • guides -- markdown source for the publisher and re-user guides that describe how to publish and consume data using this vocabulary

Publishing the vocabulary

Note: this might change in future.

Currently the actual schema documentation is generated using dowl which is a Ruby command-line tool for generating simple documentation from RDFS and OWL schema.

The project Rakefile uses the tool to generate the documentation, which is then published to the ODI schema project for live hosting.

To publish the schema:

  1. git pull this project to local directory
  2. git pull the schemas project into parallel directory
  3. Ensure you have dowl installed, e.g.: sudo geml install dowl
  4. Make necessary changes to the schema or documentation
  5. Run rake publish this will generate the documentation into schemas/odrs
  6. Commit the updated docs into the schemas project, and git push

Pointers