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

Commit f796bcb

Browse files
committed
Merge pull request #302 from philipashlock/schema-permalinks
Schema permalinks
2 parents a60af72 + 2a65472 commit f796bcb

File tree

4 files changed

+44
-31
lines changed

4 files changed

+44
-31
lines changed

Diff for: .gitignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
.DS_Store
2-
_site
2+
_site
3+
.ruby-version

Diff for: _includes/header.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111

1212
<title>{{ site.title }}</title>
1313

14-
<link rel="stylesheet" href="{{ site.root_url }}/assets/css/bootstrap.css">
15-
<link rel="stylesheet" href="{{ site.root_url }}/assets/css/site.css">
14+
<link rel="stylesheet" href="/assets/css/bootstrap.css">
15+
<link rel="stylesheet" href="/assets/css/site.css">
1616

1717
{% capture edit_url %}{{ site.prose_url }}#{{ site.org_name }}/{{ site.repo_name }}/edit/{{ site.branch }}/{{ page.filename }}{% endcapture %}
1818
</head>

Diff for: assets/css/site.css

+12
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,19 @@ background-color : #e3e3e3;
174174
}
175175

176176

177+
.schema table th a,
178+
.schema table th a:hover {
179+
text-decoration : none;
180+
color : #000;
181+
}
182+
183+
.schema table th a.permalink {
184+
color : #BFBFBF;
185+
}
177186

187+
.schema table th a.permalink:hover {
188+
color : #E74338;
189+
}
178190

179191

180192
#footer { padding: 40px 10px; }

Diff for: schema.md

+28-28
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Further Metadata Field Guidance (alphabetical by field)
103103
-------------------------------
104104

105105
{: .table .table-striped}
106-
**Field** | **accessLevel**
106+
**Field <a class="permalink" href="#accessLevel">#</a>** | **<a name="accessLevel">accessLevel</a>**
107107
----- | -----
108108
**Cardinality** | (1,1)
109109
**Required** | Yes, always
@@ -112,7 +112,7 @@ Further Metadata Field Guidance (alphabetical by field)
112112
**Example** | `{"accessLevel":"public"}`
113113

114114
{: .table .table-striped}
115-
**Field** | **accessLevelComment**
115+
**Field <a class="permalink" href="#accessLevelComment">#</a>** | **<a name="accessLevelComment">accessLevelComment</a>**
116116
----- | -----
117117
**Cardinality** | (0,1)
118118
**Required** | Yes, if accessLevel is "restricted public" or "non-public"
@@ -121,7 +121,7 @@ Further Metadata Field Guidance (alphabetical by field)
121121
**Example** | `{"accessLevelComment":"This dataset contains Personally Identifiable Information and could not be released for public access. A statistical analysis of the data contained herein, stripped of all personal identifiers, is available at http://another.website.gov/dataset."}`
122122

123123
{: .table .table-striped}
124-
**Field** | **accessURL**
124+
**Field <a class="permalink" href="#accessURL">#</a>** | **<a name="accessURL">accessURL</a>**
125125
----- | -----
126126
**Cardinality** | (0,1)
127127
**Required** | Yes, if the file is available for public download.
@@ -130,7 +130,7 @@ Further Metadata Field Guidance (alphabetical by field)
130130
**Example** | `{"accessURL":"http://www.agency.gov/vegetables/listofvegetables.csv"}`
131131

132132
{: .table .table-striped}
133-
**Field** | **accrualPeriodicity**
133+
**Field <a class="permalink" href="#accrualPeriodicity">#</a>** | **<a name="accrualPeriodicity">accrualPeriodicity</a>**
134134
----- | -----
135135
**Cardinality** | (0,1)
136136
**Required** | No
@@ -139,7 +139,7 @@ Further Metadata Field Guidance (alphabetical by field)
139139
**Example** | `{"accrualPeriodicity":"Annual"}`
140140

141141
{: .table .table-striped}
142-
**Field** | **bureauCode**
142+
**Field <a class="permalink" href="#bureauCode">#</a>** | **<a name="bureauCode">bureauCode</a>**
143143
----- | -----
144144
**Cardinality** | (0,n)
145145
**Required** | Yes, for United States Federal Government agencies
@@ -148,7 +148,7 @@ Further Metadata Field Guidance (alphabetical by field)
148148
**Example** | The Office of the Solicitor (86) at the Department of the Interior (010) would be: `{"bureauCode":["010:86"]}`. If a second bureau was also responsible, the format like this: `{"bureauCode":["010:86","010:04"]}`.
149149

150150
{: .table .table-striped}
151-
**Field** | **contactPoint**
151+
**Field <a class="permalink" href="#contactPoint">#</a>** | **<a name="contactPoint">contactPoint</a>**
152152
----- | -----
153153
**Cardinality** | (1,1)
154154
**Required** | Yes, always
@@ -157,7 +157,7 @@ Further Metadata Field Guidance (alphabetical by field)
157157
**Example** | `{"contactPoint":"John Brown"}`
158158

159159
{: .table .table-striped}
160-
**Field** | **dataDictionary**
160+
**Field <a class="permalink" href="#dataDictionary">#</a>** | **<a name="dataDictionary">dataDictionary</a>**
161161
----- | -----
162162
**Cardinality** | (0,1)
163163
**Required** | No (Documentation that is not specifically a data dictionary belongs in "references")
@@ -166,7 +166,7 @@ Further Metadata Field Guidance (alphabetical by field)
166166
**Example** | `{"dataDictionary":"http://www.agency.gov/vegetables/dictionary.html"}`
167167

168168
{: .table .table-striped}
169-
**Field** | **dataQuality**
169+
**Field <a class="permalink" href="#dataQuality">#</a>** | **<a name="dataQuality">dataQuality</a>**
170170
----- | -----
171171
**Cardinality** | (0,1)
172172
**Required** | No
@@ -175,7 +175,7 @@ Further Metadata Field Guidance (alphabetical by field)
175175
**Example** | `{"dataQuality":true}`
176176

177177
{: .table .table-striped}
178-
**Field** | **description**
178+
**Field <a class="permalink" href="#description">#</a>** | **<a name="description">description</a>**
179179
----- | -----
180180
**Cardinality** | (1,1)
181181
**Required** | Yes, always
@@ -184,7 +184,7 @@ Further Metadata Field Guidance (alphabetical by field)
184184
**Example** | `{"description":"This dataset contains a list of vegetables, including nutrition information and seasonality. Includes details on tomatoes, which are really fruit but considered a vegetable in this dataset."}`
185185

186186
{: .table .table-striped}
187-
**Field** | **distribution**
187+
**Field <a class="permalink" href="#distribution">#</a>** | **<a name="distribution">distribution</a>**
188188
----- | -----
189189
**Cardinality** | (0,n)
190190
**Required** | No
@@ -207,7 +207,7 @@ Further Metadata Field Guidance (alphabetical by field)
207207
]
208208
209209
{: .table .table-striped}
210-
**Field** | **format**
210+
**Field <a class="permalink" href="#format">#</a>** | **<a name="format">format</a>**
211211
----- | -----
212212
**Cardinality** | (0,1)
213213
**Required** | Yes, if the file is available for public download.
@@ -216,7 +216,7 @@ Further Metadata Field Guidance (alphabetical by field)
216216
**Example** | `{"format":"application/json"}`
217217

218218
{: .table .table-striped}
219-
**Field** | **identifier**
219+
**Field <a class="permalink" href="#identifier">#</a>** | **<a name="identifier">identifier</a>**
220220
----- | -----
221221
**Cardinality** | (1,1)
222222
**Required** | Yes, always
@@ -225,7 +225,7 @@ Further Metadata Field Guidance (alphabetical by field)
225225
**Example** | `{"identifier":"1344"}`
226226

227227
{: .table .table-striped}
228-
**Field** | **issued**
228+
**Field <a class="permalink" href="#issued">#</a>** | **<a name="issued">issued</a>**
229229
----- | -----
230230
**Cardinality** | (0,1)
231231
**Required** | No
@@ -234,7 +234,7 @@ Further Metadata Field Guidance (alphabetical by field)
234234
**Example** | `{"issued":"2001-01-15"}`
235235

236236
{: .table .table-striped}
237-
**Field** | **keyword**
237+
**Field <a class="permalink" href="#keyword">#</a>** | **<a name="keyword">keyword</a>**
238238
----- | -----
239239
**Cardinality** | (1,n)
240240
**Required** | Yes, always
@@ -243,7 +243,7 @@ Further Metadata Field Guidance (alphabetical by field)
243243
**Example** | `{"keyword":["vegetables","veggies","greens","leafy","spinach","kale","nutrition"]}`
244244

245245
{: .table .table-striped}
246-
**Field** | **landingPage**
246+
**Field <a class="permalink" href="#landingPage">#</a>** | **<a name="landingPage">landingPage</a>**
247247
----- | -----
248248
**Cardinality** | (0,1)
249249
**Required** | No
@@ -252,7 +252,7 @@ Further Metadata Field Guidance (alphabetical by field)
252252
**Example** | `{"landingPage":"http://www.agency.gov/vegetables"}`
253253

254254
{: .table .table-striped}
255-
**Field** | **language**
255+
**Field <a class="permalink" href="#language">#</a>** | **<a name="language">language</a>**
256256
----- | -----
257257
**Cardinality** | (0,n)
258258
**Required** | No
@@ -261,7 +261,7 @@ Further Metadata Field Guidance (alphabetical by field)
261261
**Example** | `{"language":["en-US"]}` or if multiple languages, `{"language":["es-MX","wo","nv","en-US"]}`
262262

263263
{: .table .table-striped}
264-
**Field** | **license**
264+
**Field <a class="permalink" href="#license">#</a>** | **<a name="license">license</a>**
265265
----- | -----
266266
**Cardinality** | (0,1)
267267
**Required** | No
@@ -270,7 +270,7 @@ Further Metadata Field Guidance (alphabetical by field)
270270
**Example** | `{"license":""}`
271271

272272
{: .table .table-striped}
273-
**Field** | **mbox**
273+
**Field <a class="permalink" href="#mbox">#</a>** | **<a name="mbox">mbox</a>**
274274
----- | -----
275275
**Cardinality** | (1,1)
276276
**Required** | Yes, always
@@ -279,7 +279,7 @@ Further Metadata Field Guidance (alphabetical by field)
279279
**Example** | `{"mbox":"[email protected]"}`
280280

281281
{: .table .table-striped}
282-
**Field** | **modified**
282+
**Field <a class="permalink" href="#modified">#</a>** | **<a name="modified">modified</a>**
283283
----- | -----
284284
**Cardinality** | (1,1)
285285
**Required** | Yes, always
@@ -290,7 +290,7 @@ If there is a need to reflect that the dataset is continually updated, ISO 8601
290290
**Example** | `{"modified":"2012-01-15"}` or `{"modified":"P1D"}`
291291

292292
{: .table .table-striped}
293-
**Field** | **PrimaryITInvestmentUII**
293+
**Field <a class="permalink" href="#PrimaryITInvestmentUII">#</a>** | **<a name="PrimaryITInvestmentUII">PrimaryITInvestmentUII</a>**
294294
----- | -----
295295
**Cardinality** | (0,1)
296296
**Required** | No
@@ -299,7 +299,7 @@ If there is a need to reflect that the dataset is continually updated, ISO 8601
299299
**Example** | `{"PrimaryITInvestmentUII":"023-000000001"}`
300300

301301
{: .table .table-striped}
302-
**Field** | **programCode**
302+
**Field <a class="permalink" href="#programCode">#</a>** | **<a name="programCode">programCode</a>**
303303
----- | -----
304304
**Cardinality** | (0,n)
305305
**Required** | Yes, for United States Federal Government Agencies
@@ -308,7 +308,7 @@ If there is a need to reflect that the dataset is continually updated, ISO 8601
308308
**Example** | `{"programCode":["015:001"]}` or if multiple programs, `{"programCode":["015:001","015:002"]}`
309309

310310
{: .table .table-striped}
311-
**Field** | **publisher**
311+
**Field <a class="permalink" href="#publisher">#</a>** | **<a name="publisher">publisher</a>**
312312
----- | -----
313313
**Cardinality** | (1,1)
314314
**Required** | Yes, always
@@ -317,7 +317,7 @@ If there is a need to reflect that the dataset is continually updated, ISO 8601
317317
**Example** | `{"publisher":"U.S. Department of Education"}`
318318

319319
{: .table .table-striped}
320-
**Field** | **references**
320+
**Field <a class="permalink" href="#references">#</a>** | **<a name="references">references</a>**
321321
----- | -----
322322
**Cardinality** | (0,n)
323323
**Required** | No
@@ -326,7 +326,7 @@ If there is a need to reflect that the dataset is continually updated, ISO 8601
326326
**Example** | `{"references":["http://www.agency.gov/legumes/legumes_data_documentation.html"]}` or if multiple URLs, `{"references":["http://www.agency.gov/legumes/legumes_data_documentation.html","http://www.agency.gov/fruits/fruit_data_documentation.html"]}`
327327

328328
{: .table .table-striped}
329-
**Field** | **spatial**
329+
**Field <a class="permalink" href="#spatial">#</a>** | **<a name="spatial">spatial</a>**
330330
----- | -----
331331
**Cardinality** | (0,1)
332332
**Required** | Yes, if the dataset is spatial
@@ -335,7 +335,7 @@ If there is a need to reflect that the dataset is continually updated, ISO 8601
335335
**Example** | `{"spatial":"Lincoln, Nebraska"}`
336336

337337
{: .table .table-striped}
338-
**Field** | **temporal**
338+
**Field <a class="permalink" href="#temporal">#</a>** | **<a name="temporal">temporal</a>**
339339
----- | -----
340340
**Cardinality** | (0,1)
341341
**Required** | Yes, if applicable
@@ -348,7 +348,7 @@ Updated every 5 minutes beginning on February 15, 2010 would be represented as:
348348
**Example** | `{"temporal":"2000-01-15T00:45:00Z/2010-01-15T00:06:00Z"}` or `{"temporal":"R/2000-01-15T00:45:00Z/P1W"}`
349349

350350
{: .table .table-striped}
351-
**Field** | **theme**
351+
**Field <a class="permalink" href="#theme">#</a>** | **<a name="theme">theme</a>**
352352
----- | -----
353353
**Cardinality** | (0,n)
354354
**Required** | No
@@ -357,7 +357,7 @@ Updated every 5 minutes beginning on February 15, 2010 would be represented as:
357357
**Examples** | `{"theme":["vegetables"]}` or if multiple categories, `{"theme":["vegetables","produce"]}`
358358

359359
{: .table .table-striped}
360-
**Field** | **title**
360+
**Field <a class="permalink" href="#title">#</a>** | **<a name="title">title</a>**
361361
----- | -----
362362
**Cardinality** | (1,1)
363363
**Required** | Yes, always
@@ -366,7 +366,7 @@ Updated every 5 minutes beginning on February 15, 2010 would be represented as:
366366
**Example** | `{"title":"Types of Vegetables"}`
367367

368368
{: .table .table-striped}
369-
**Field** | **webService**
369+
**Field <a class="permalink" href="#webService">#</a>** | **<a name="webService">webService</a>**
370370
----- | -----
371371
**Cardinality** | (0,1)
372372
**Required** | Yes, if the dataset has an API

0 commit comments

Comments
 (0)