Skip to content
This repository was archived by the owner on Jun 18, 2024. It is now read-only.

Commit b0a4934

Browse files
committed
More consistent formatting for field references
1 parent e3e2da8 commit b0a4934

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

Diff for: v1.1/schema.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ Dataset Fields {#Dataset}
275275
**Cardinality** | (1,1)
276276
**Required** | Yes, always
277277
**Accepted Values** | vCard object
278-
**Usage Notes** | This is a container for two fields that together make up the contact information for the dataset. **contactPoint** should always contain both the person's appropriately formatted full name (**fn**) and email (**hasEmail**).
278+
**Usage Notes** | This is a container for two fields that together make up the contact information for the dataset. `contactPoint` should always contain both the person's appropriately formatted full name (`fn`) and email (`hasEmail`).
279279
**Example** | See below
280280

281281
~~~
@@ -291,7 +291,7 @@ Dataset Fields {#Dataset}
291291
**Cardinality** | (1,1)
292292
**Required** | Yes, always
293293
**Accepted Values** | String
294-
**Usage Notes** | This should include included with **hasEmail** as part of a record's **contactPoint** (see above example).
294+
**Usage Notes** | This should include included with `hasEmail` as part of a record's `contactPoint` (see above example).
295295
**Example** | `{"fn": "Jane Doe"}`
296296

297297
{: .table .table-striped .child-field #contactPoint-hasEmail}
@@ -300,7 +300,7 @@ Dataset Fields {#Dataset}
300300
**Cardinality** | (1,1)
301301
**Required** | Yes, always
302302
**Accepted Values** | String
303-
**Usage Notes** | This should be formatted per vCard specifications (see example below) and included with **fn** as part of a record's **contactPoint** (see above example).
303+
**Usage Notes** | This should be formatted per vCard specifications (see example below) and included with `fn` as part of a record's `contactPoint` (see above example).
304304
**Example** | `{"hasEmail": "mailto:[email protected]"}`
305305

306306
{: .table .table-striped #dataQuality}
@@ -343,9 +343,9 @@ Dataset Fields {#Dataset}
343343
**Field [#](#distribution){: .permalink}** | **distribution**
344344
----- | -----
345345
**Cardinality** | (0,n)
346-
**Required** | Yes, if the dataset has an **accessURL** or **downloadURL**.
346+
**Required** | Yes, if the dataset has an `accessURL` or `downloadURL`.
347347
**Accepted Values** | Array of Objects
348-
**Usage Notes** | This is a container for one or multiple `distribution` objects which group together the fields: **accessURL**, **conformsTo**, **downloadURL**, **describedBy**, **describedByType**, **description**, **format**, **mediaType**, and **title**.
348+
**Usage Notes** | This is a container for one or multiple `distribution` objects which group together the fields: `accessURL`, `conformsTo`, `downloadURL`, `describedBy`, `describedByType`, `description`, `format`, `mediaType`, and `title`.
349349
**Example** | See below
350350

351351
~~~
@@ -407,7 +407,7 @@ Dataset Fields {#Dataset}
407407
**Cardinality** | (0,1)
408408
**Required** | Yes, if the file is available for public download.
409409
**Accepted Values** | String (URL)
410-
**Usage Notes** | This must be the **direct** download URL. Other means of accessing the dataset should be expressed using **accessURL**. This should always be accompanied by **mediaType**.
410+
**Usage Notes** | This must be the `direct` download URL. Other means of accessing the dataset should be expressed using `accessURL`. This should always be accompanied by `mediaType`.
411411
**Example** | `{"downloadURL":"http://www.agency.gov/vegetables/listofvegetables.csv"}`
412412

413413
{: .table .table-striped .child-field #distribution-describedBy}
@@ -452,7 +452,7 @@ Dataset Fields {#Dataset}
452452
**Cardinality** | (0,1)
453453
**Required** | Yes, if the file is available for public download.
454454
**Accepted Values** | String
455-
**Usage Notes** | This must describe the exact files available at **downloadURL** using a media type ([IANA Media Type](http://www.iana.org/assignments/media-types) also known as [MIME Type](http://en.wikipedia.org/wiki/Internet_media_type)). _[Also note [Office Open XML MIME types](http://blogs.msdn.com/b/vsofficedeveloper/archive/2008/05/08/office-2007-open-xml-mime-types.aspx)]_
455+
**Usage Notes** | This must describe the exact files available at `downloadURL` using a media type ([IANA Media Type](http://www.iana.org/assignments/media-types) also known as [MIME Type](http://en.wikipedia.org/wiki/Internet_media_type)). _[Also note [Office Open XML MIME types](http://blogs.msdn.com/b/vsofficedeveloper/archive/2008/05/08/office-2007-open-xml-mime-types.aspx)]_
456456
**Example** | `{"mediaType":"application/csv"}`
457457

458458
{: .table .table-striped .child-field #distribution-title}
@@ -534,7 +534,7 @@ Dataset Fields {#Dataset}
534534
**Cardinality** | (1,1)
535535
**Required** | Yes, always
536536
**Accepted Values** | ISO 8601 Date
537-
**Usage Notes** | Dates should be [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) of highest resolution. In other words, as much of YYYY-MM-DDThh:mm:ss.sTZD as is relevant to this dataset. If this file is brand-new, enter the **issued** date here as well. If there is a need to reflect that the dataset is continually updated, ISO 8601 formatting can account for this [with repeating intervals](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals). For instance, `R/P1D` for daily, `R/P2W` for every two weeks, and `R/PT5M` for every five minutes.
537+
**Usage Notes** | Dates should be [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) of highest resolution. In other words, as much of YYYY-MM-DDThh:mm:ss.sTZD as is relevant to this dataset. If this file is brand-new, enter the `issued` date here as well. If there is a need to reflect that the dataset is continually updated, ISO 8601 formatting can account for this [with repeating intervals](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals). For instance, `R/P1D` for daily, `R/P2W` for every two weeks, and `R/PT5M` for every five minutes.
538538
+**Example** | `{"modified":"2012-01-15"}` or `{"modified":"R/P1D"}
539539

540540
{: .table .table-striped #primaryITInvestmentUII}
@@ -611,7 +611,7 @@ Dataset Fields {#Dataset}
611611
**Field [#](#rights){: .permalink}** | **rights**
612612
----- | -----
613613
**Cardinality** | (0,1)
614-
**Required** | Yes, if accessLevel is "restricted public" or "non-public"
614+
**Required** | Yes, if `accessLevel` is "restricted public" or "non-public"
615615
**Accepted Values** | String
616616
**Usage Notes** | This may include information regarding access or restrictions based on privacy, security, or other policies. This should also serve as an explanation for the selected “accessLevel” including instructions for how to access a restricted file, if applicable, or explanation for why a “non-public” or “restricted public” data asset is not “public,” if applicable. If the dataset can be made available through a website indirectly, use `accessURL` for the URL that provides such access.
617617
**Example** | `{"rights":"This dataset contains Personally Identifiable Information and could not be released for public access."}`

0 commit comments

Comments
 (0)