You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 18, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: catalog.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ This section provides further guidance and explanation for implementing the agen
10
10
/Data Requirements
11
11
------------------
12
12
13
-
The Open Data Policy requires agencies to list and describe all agency data that *can* be made publicly available (i.e. there are no valid restrictions to release) in a publicly available open data catalog using the [Project Open Data metadata schema](/schema/). It further requires the catalog to be human-readable and machine-readable. This guidance describes to agencies steps for implementing this portion of the policy.
13
+
The Open Data Policy requires agencies to list and describe all agency data that *can* be made publicly available (i.e. there are no valid restrictions to release) in a publicly available open data catalog using the [Project Open Data metadata schema](/v1.1/schema/). It further requires the catalog to be human-readable and machine-readable. This guidance describes to agencies steps for implementing this portion of the policy.
14
14
15
15
Why this effort
16
16
---------------
@@ -26,12 +26,12 @@ Each agency will describe their existing datasets as they see fit using the belo
26
26
Machine-Readable Format
27
27
-----------------------
28
28
29
-
All information deemed "machine-readable" required in this policy must be described in the JSON file format, with the option of RDFa Lite and XML as well. See [this specification](/schema/) for the required schema. Agencies must post their files at agency.gov/data.json (and optionally at /data.html or data.xml as well). Additionally, the web page which reads and formats these files must be posted at /data/index.html (or /data.html). The files should be updated a minimum of monthly. It is our intent that future publications of Data.gov will simply crawl for all agency.gov/data.json to populate Data.gov.
29
+
All information deemed "machine-readable" required in this policy must be described in the JSON file format, with the option of RDFa Lite and XML as well. See the [Project Open Data metadata schema](/v1.1/schema/) for the required schema. Agencies must post their files at agency.gov/data.json (and optionally at /data.html or data.xml as well). Additionally, the web page which reads and formats these files must be posted at /data/index.html (or /data.html). The files should be updated a minimum of monthly. It is our intent that future publications of Data.gov will simply crawl for all agency.gov/data.json to populate Data.gov.
30
30
31
31
Implementing
32
32
------------
33
33
34
-
To fulfill the requirements of this memorandum, agencies should begin to describe datasets as a catalog using the vocabulary of the [Project Open Data metadata schema](/schema/). This catalog is to be published as a standalone JSON file at `agency.gov/data.json`. Agencies may optionally also publish it with RDFa Lite, either embedded within a HTML page which include human readable markups (e.g., `agency.gov/data.html`) or as an XML file (e.g., `agency.gov/data.xml`).
34
+
To fulfill the requirements of this memorandum, agencies should begin to describe datasets as a catalog using the vocabulary of the [Project Open Data metadata schema](/v1.1/schema/). This catalog is to be published as a standalone JSON file at `agency.gov/data.json`. Agencies may optionally also publish it with RDFa Lite, either embedded within a HTML page which include human readable markups (e.g., `agency.gov/data.html`) or as an XML file (e.g., `agency.gov/data.xml`).
35
35
36
36
### JSON
37
37
@@ -53,7 +53,7 @@ The JSON catalog files should only use UTF-8 character encoding.
53
53
Generating Machine-Readable Reporting Files
54
54
-------------------------------------------
55
55
56
-
Agencies must follow the provided [specification](/schema/). We have built a [catalog generator](http://project-open-data.github.com/catalog-generator/) to assist you in building your catalog and generating JSON, XML, or RDFa Lite files.
56
+
Agencies must follow the provided [Project Open Data metadata schema](/v1.1/schema/). For tools and resources to generate these files, see [metadata resources](/v1.1/metadata-resources).
57
57
58
58
59
59
Inclusion of the Public Data Listing as a Record
@@ -70,7 +70,7 @@ Agencies must have present a table/list of each dataset in the /data page. The
70
70
* Dataset description (description)
71
71
* URL to the dataset (accessURL or webService)
72
72
73
-
The page must be populated from the machine-readable catalog file (e.g. data.xml or data.json) following the [specification](/schema/) described above. Agencies are encouraged to add functionality to assist end-user discoverability. Additional functions might be sorting, filtering or paging to help make a more digestible list. Agencies are also encouraged to add more to the standard schema which might further assist end-user discoverability and usability (e.g. thumbnails).
73
+
The page must be populated from the machine-readable catalog file (e.g. data.xml or data.json) following the [Project Open Data metadata schema](/v1.1/schema/) described above. Agencies are encouraged to add functionality to assist end-user discoverability. Additional functions might be sorting, filtering or paging to help make a more digestible list. Agencies are also encouraged to add more to the standard schema which might further assist end-user discoverability and usability (e.g. thumbnails).
This section provides further background and resources to assist agencies in implementing the [Project Open Data metadata schema](/schema/).
9
+
This section provides further background and resources to assist agencies in implementing the [Project Open Data metadata schema](/v1.1/schema/).
10
10
11
11
In addition to template and sample files we also produce Project Open Data Metadata schema in JSON schema format. [JSON schema](http://json-schema.org/) describes a JSON data format. It can be used to automatically validate Data.json files and to generate forms for creating JSON.
0 commit comments