This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
public:metadata [2020/01/29 16:40] admin created |
public:metadata [2021/09/27 13:53] (current) admin [SmartDublin metadata template] |
||
---|---|---|---|
Line 4: | Line 4: | ||
* Editors | * Editors | ||
- | * Contributors willing to add content to the SD Database | + | * Contributors willing to add content to the SmartDublin Data Portal |
==== What this guide teaches ==== | ==== What this guide teaches ==== | ||
Line 15: | Line 15: | ||
Metadata is data that describes data. | Metadata is data that describes data. | ||
+ | |||
Imagine you received a parcel. | Imagine you received a parcel. | ||
- | |||
Without having to tear the wrapping paper and open the box, a label on the outside can tell you what's in the parcel. | Without having to tear the wrapping paper and open the box, a label on the outside can tell you what's in the parcel. | ||
- | + | A carefully wrapped parcel without a label might add excitement for the recipient, but data without metadata is not usable. Data is simply numbers and figures. Data doesn’t mean anything without a description, metadata. | |
- | A carefully wrapped parcel without a label might add excitement for the recipient, but data without a metadata is not usable. Data is simply number and figures. Data doesn’t mean anything without a description, metadata. | + | |
For CKAN purposes, data is published in units called “datasets”. A dataset is a parcel of data - for example, it could be the crime statistics for a region, the spending figures for a government department, temperature readings from various weather stations or a reference document. | For CKAN purposes, data is published in units called “datasets”. A dataset is a parcel of data - for example, it could be the crime statistics for a region, the spending figures for a government department, temperature readings from various weather stations or a reference document. | ||
Line 25: | Line 24: | ||
A dataset contains two things: | A dataset contains two things: | ||
- | * A metadata that describe information about the data. For example, the title and publisher, date, what formats it is available in, what license it is released under, etc. | + | * Metadata that describes information about the data. For example, the title and publisher, date, what formats it is available in, what license it is released under, etc. |
* A number of “resources”, which hold the data itself. CKAN does not mind what format the data is in. A resource can be a CSV or Excel spreadsheet, XML file, PDF document, image file, linked data in RDF format, etc. CKAN can store the resource internally, or store it simply as a link, the resource itself being elsewhere on the web. A dataset can contain any number of resources. For example, different resources might contain the data for different years, or they might contain the same data in different formats. | * A number of “resources”, which hold the data itself. CKAN does not mind what format the data is in. A resource can be a CSV or Excel spreadsheet, XML file, PDF document, image file, linked data in RDF format, etc. CKAN can store the resource internally, or store it simply as a link, the resource itself being elsewhere on the web. A dataset can contain any number of resources. For example, different resources might contain the data for different years, or they might contain the same data in different formats. | ||
- | Example: [[https://data.smartdublin.ie/dataset/dcc-mixed-dry-recyclables Mixed dry recyclables]] | + | Example: [[https://data.smartdublin.ie/dataset/disabled-parking-spaces]] |
- | + | {{ :public:disabled_parking.png?400 |}} | |
- | {{ :public:metadata_1.png?600 |}} | + | |
Metadata provides important context about an informational asset’s source and manner of creation, as well as in what applications or environments the asset is relevant. | Metadata provides important context about an informational asset’s source and manner of creation, as well as in what applications or environments the asset is relevant. | ||
Line 43: | Line 41: | ||
===== Guidelines for creating accurate metadata ===== | ===== Guidelines for creating accurate metadata ===== | ||
- | Information is often imperfect, whether it is produced by members of the Open Development Network or by others. Details may be missing, badly defined, or even completely wrong. Sometimes it is possible to improve the quality of the information by contacting its source. But even even then, problems may remain. | + | Information is often imperfect, whether it is produced by members of the SmartDublin team or by others. Details may be missing, badly defined, or even completely wrong. Sometimes it is possible to improve the quality of the information by contacting its source. But even even then, problems may remain. |
**How may we create an accurate and useful metadata when the information it is describing might be flawed?** | **How may we create an accurate and useful metadata when the information it is describing might be flawed?** | ||
- | We aim to produce, to the best of our ability, an accurate metadata by describing the extent of our knowledge about the asset/resource. A good metadata should clearly state what is known about the resource and what is not known or problematic. Metadata changes when the asset itself or knowledge about its condition changes. | + | We aim to produce, to the best of our ability, accurate metadata by describing the extent of our knowledge the asset/resource. Good metadata should clearly state what is known about the resource and what is not known or problematic. Metadata changes when the asset itself or knowledge about its condition changes. |
If information is missing or inconsistent, describe the known inconsistencies or gaps instead of disregarding the resource. Mention any steps being taken to address these issues, along with an expected timeline. | If information is missing or inconsistent, describe the known inconsistencies or gaps instead of disregarding the resource. Mention any steps being taken to address these issues, along with an expected timeline. | ||
- | ==== Open Development Platform metadata templates ==== | + | ==== Dublinked metadata template ==== |
- | For each different type of data, there are specific terms that relate to that type of data. On the Datahub 4 different types of datasets, each requires its own metadata template, are currently stored/administered: | + | For each different type of data, there are specific terms that relate to that type of data. On the Datahub 1 type of dataset is currently stored/administered: |
* Dataset (both spatial and non-spatial) | * Dataset (both spatial and non-spatial) | ||
- | * Library records | ||
- | * Law records | ||
- | * Agreement records (for contracts) | ||
- | These metadata templates were developed by adapting and enhancing the standard CKAN's metadata template. Each template contains metadata fields common for all dataset types on CKAN and a set of fields that are only applicable to the dataset type. For example, metadata about a research report (Library records) will have information about author(s) and publishers (s); metadata for laws and policies (Law records) will instead have information about the drafting agency, issuing agency, and promulgation date etc. | + | This metadata template was developed by adapting and enhancing the standard CKAN's metadata template. |
- | The templates below outline information that should be included and offer instruction for each metadata field. | + | The template below outlines information that should be included and offers instruction for each metadata field. |
==== Metadata for dataset (both spatial and non-spatial) ==== | ==== Metadata for dataset (both spatial and non-spatial) ==== | ||
Line 69: | Line 64: | ||
- | ==== Metadata template for library publications ==== | ||
- | |||
- | [[public:library_metadata|public:library_metadata]] | ||
- | |||
- | |||
- | ==== Metadata template for law and policy documents ==== | ||
- | |||
- | [[public:laws_metadata|public:laws_metadata]] | ||
- | |||
- | |||
- | ==== Metadata for agreement documents (contracts) ==== | ||
- | |||
- | [[public:agreement_metadata|public:agreement_metadata]] | ||
- | |||
Other metadata fields exposed by the CKAN API: | Other metadata fields exposed by the CKAN API: |