Skip to content

Open Data Dataset HTML Data

Cedric Jean-Marie edited this page May 24, 2013 · 3 revisions

Open Data Dataset HTML Data - Implementation guide draft

Business example: Open Data Portal Dataset Details Page

Here's the context, I want to mark up the ceremony data my department has on its site:

data: HTML data mark-up

<!doctype html>
<html>
<head>
<title>title</title>
</head>
<body>

	<section vocab="http://schema.org/" typeof="DataCatalog">
		<h1 property="name">Title of Dataset</h1>
		<div property="description">
			Description of Dataset.
		</div>
	</section>
	<section>
		<p>Licence: <a href="http://link.to.licence">Open Government Licence - Canada</a></p>
	</section>
    
	<section>
		<h2>Data and Resources</h2>
		<table>
			<thead>
				<tr>
					<th>Resource Name</th>
					<th>Format</th>
					<th>Language</th>
					<th>Link</th>
				</tr>
			</thead>
          
			<tr typeof="Dataset"> 
				<td>
					<span class="empty" property="name">Name of resource/data</span>
				</td>
				<td>
					CSV
				</td>
				<td property="inLanguage">
					English
				</td>
				<td>
					<a property="distribution" href="http://link.to.resource" target="_blank">Download</a>
				</td>
			</tr>
			<tr typeof="Dataset"> 
				<td>
					<span class="empty" property="name">Name of resource/data</span>
				</td>
				<td>
					CSV
				</td>
				<td property="inLanguage">
					French
				</td>
				<td>
					<a property="distribution" href="http://link.to.resource" target="_blank">Download</a>
				</td>
			</tr>
		</table>
	</section>
    
	<section>
		<h2>Additional Information</h2>
      
		<ul>
			<li>Openness rating: ***</li>
			<li>Frequency: As Needed</li>
		</ul>
      
		<h2>Developer Tools</h2>
		<ul>
			<li>The information on this page (the dataset metadata) is also available in JSON format<br/>
			<a href="http://link.to.json.format">Link to JSON format</a></li>
			<li>Read more about this site's API: <a href="http://docs.ckan.org">About the API</a></li>
		</ul>
	</section>

	<section>
		<h2>Geographic Information</h2>
		<p typeof="GeoShape"> <span property="name">Name of Location</span>
			<span property="polygon">
				POLYGON -133.2375260000000026 63.4294859999999971, -133.2364230000000020 63.4474269999999976,
					-133.1963450000000080 63.4469270000000023, -133.1974730000000022 63.4289869999999993, 
					-133.2375260000000026 63.4294859999999971
			</span>
		</p>

	</section>      
    
	<section>
		<h2> Comments</h2>
		<ul>
			<li><a href="http://link.to.comments">Comment</a></li>
		</ul>
	</section>

	<aside>
		<h3>Have your say</h3>
		<ul>
			<li>*****</li>
			<li><a href="http://link.tocomments">Comments: (1)</a></li>
		</ul>
		<h3>About this Dataset</h3>
		<ul>
			<li>Publisher:Organization Name</li>
			<li>Keywords:
				<ul>
					<li><a href="#">Geomatics</a></li>
					<li><a href="#">Geographic data</a></li>
					<li><a href="#">Photography</a></li>
					<li><a href="#">Aerial photography</a></li>
					<li><a href="#">Imagery and basemaps</a></li>
				</ul>
			</li>      
			<li>Date Published:1969-12-31</li>
			<li>Date Modified:</li>
			<li>Homepage URL:<a href="#">Program Page</a></li>
		</ul>
	</aside>

</body>
</html>

Specific rules for each element:

description

<span property="description">Corner Brook, Newfoundland & Labrador City Hall</span><br>

General instructions for completing

A free-text description of the location of the event. If the location is a government building or if the building has an official name, the official name of the building must be used.

TBS Policy

Namespace

streetAddress

<span property="streetAddress">5, rue Park Street</span>,<br>

General instructions for completing Complete street address location.

For guidance, suggest following Canada Post Addressing Guidelines.

http://www.canadapost.ca/tools/pg/manual/pgaddress-e.asp

TBS Policy

Namespace

addressLocality

<span property="addressLocality">Corner Brook</span>,<br>

General instructions for completing

Complete city or town address location.

For guidance, suggest following Canada Post Addressing Guidelines.

http://www.canadapost.ca/tools/pg/manual/pgaddress-e.asp

TBS Policy

Standard on Metadata mandates using abbreviations for geographic locations.

Namespace

Use NRCan Geographical Names controlled vocabulary.

addressRegion

<span property="addressRegion">Newfoundland and Labrador</span><br>

General instructions for completing

Complete province or territory address location.

For guidance, suggest following Canada Post Addressing Guidelines.

http://www.canadapost.ca/tools/pg/manual/pgaddress-e.asp

TBS Policy

Standard on Metadata mandates using abbreviations for geographic locations.

Namespace

Use NRCan Geographical Names controlled vocabulary.

startDate

<time property="startDate" datetime="2012-12-07T15:00:00-04:00">
	Date: 2012-12-07<br>
	Time: 3:00 p.m.<br>
</time>

General instructions for completing

ISO 8601 date time such as 2012-12-07T15:00:00-04:00 representing December 7th 2012 at 15:00:00 with a time zone definition of -4 GMT ( EST )

TBS Policy

Namespace, if applicable

duration

<time property="duration" datetime="PT3H00M">3h</time><br>

General instructions for completing

Namespace

Clone this wiki locally