WP OpenData

Description

This plugin turns your WordPress website into an open data library. By using the dataset post type you can manage descriptions and meta information about open datasets.
It is also possible to add descriptions of projects and apps that are using the datasets.

Available languages

• English by oxyva.nl
• Dutch by oxyva.nl

Templates

In order to include datasets and projects in your theme you have three options.

1: Enable content filter

When enabling the content filter options in the WP OpenData settings the metadata is printed above the actual content of either a dataset or a project, and a list of (related) projects is printed at the bottom of a dataset.

2: Create your own templates/create a child theme

If you want to customize the template for datasets and project you need to modify your template for the custom post types dataset and project. To do so visit these pages to read more about templates for custom post types:

• Post Type Templates – WordPress Codex
• Template Hierarchy – WordPress Codex
• Child Themes – WordPress Codex

For example, to create a single dataset page you have to create a template file called single-dataset.php.

You can use the following functions in your template:

• wp_opendata_entry_meta_dataset(): prints the post entry meta data for a dataset. For example: “This project was posted on April 26, 2013”.
• wp_opendata_entry_meta_project(): prints the post entry meta data for a project.
• wp_opendata_dataset_meta(): prints the meta data of a dataset in an HTML definition list. This list contains for example the licenses, URL, categories and tags. When the current post is not of type dataset nothing will be printed.
• wp_opendata_project_meta(): prints the meta data of a project in an HTML definition list. When the current post is not of type project nothing will be printed.
• wp_opendata_meta(): prints the metadata of either a project or a dataset.
• wp_opendata_next_post($format = '%link »', $link = '%title', $post_type = ''): prints the next (alphabetically ordered) dataset or project. Change the $post_type parameter to dataset or project.
• wp_opendata_previous_post($format = '%link »', $link = '%title', $post_type = ''): prints the previous (alphabetically ordered) dataset or project. Change the $post_type parameter to dataset or project.
• wp_opendata_get_dataset_project_list: get an array containing name and url elements of projects that are using the current dataset. Returns null when no projects are found.
• wp_opendata_dataset_project_list(): prints an HTML list element containing projects that are using the current dataset.

In order to view an example open the single-dataset.php and content-dataset.php file in wp-content/plugins/wp-opendata/templates/.

3: Edit existing templates of your theme

Caution: it is advised to use this option only if you have developed the theme yourself. When updating a third-party theme changes made to the template files might be lost.

In order to print the meta information of a dataset or a project add the following line in the single.php template file:

<?php wp_opendata_meta(); ?>

The following code can be used to print a list of (related) projects for a dataset (h2 header with an unsorted list):

<?php wp_opendata_dataset_project_list(); ?>

When the current post is not of type dataset or project nothing will be printed. Make sure the content filter options are turned off in the WP OpenData settings, else the metadata is shown twice.

Disclaimer

The authors are not responsible for the use of the third-party plugins mentioned in this document. We have not validated the code of these plugins, and are not responsible for any harm done to your WordPress installation by these plugins.
Use them at your own risk.