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

Commit 506d428

Browse files
committed
Adds requirement css classes to schema order list
1 parent 66b8c05 commit 506d428

File tree

2 files changed

+115
-43
lines changed

2 files changed

+115
-43
lines changed

Diff for: assets/css/site.css

+65
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,71 @@ background-color : #e3e3e3;
207207

208208
#footer { padding: 40px 10px; }
209209

210+
ul.schema-fields,
211+
ul.schema-fields ul {
212+
list-style : none;
213+
padding : 0;
214+
margin : 0;
215+
}
216+
217+
ul.schema-fields li {
218+
padding-left: 1em;
219+
text-indent: -.7em;
220+
}
221+
222+
.schema-fields.requirements-key {
223+
float : right;
224+
border : 1px solid #ccc;
225+
padding : 1em;
226+
background-color : #f9f9f9;
227+
border-radius: 5px;
228+
}
229+
230+
.field-required:before {
231+
content: "● ";
232+
color : DarkRed;
233+
}
234+
235+
span.field-required {
236+
color : DarkRed;
237+
}
238+
239+
.field-required {
240+
font-weight : bold;
241+
}
242+
243+
.field-required-if-applicable:before,
244+
.field-required .field-required-if-applicable:before {
245+
content: "◎ ";
246+
color : DarkMagenta;
247+
}
248+
249+
span.field-required-if-applicable {
250+
color : DarkMagenta;
251+
}
252+
253+
254+
.field-required-if-applicable,
255+
.field-required .field-required-if-applicable {
256+
font-weight : normal;
257+
}
258+
259+
.field-optional:before,
260+
.field-required .field-optional:before,
261+
.field-required-if-applicable .field-optional:before {
262+
content: "◌ ";
263+
color : MidnightBlue;
264+
}
265+
266+
.field-optional:before,
267+
.field-required .field-optional,
268+
.field-required-if-applicable .field-optional {
269+
font-weight : normal;
270+
}
271+
272+
273+
274+
210275
/* icons */
211276
[class^="icon-"],
212277
[class*=" icon-"] {

Diff for: v1.1/schema.md

+50-43
Original file line numberDiff line numberDiff line change
@@ -138,51 +138,58 @@ Further Metadata Field Guidance
138138
-------------------------------
139139
Additional details for each field are provided here broken down into sections for the overarching [Catalog](#Catalog), each [dataset](#dataset), and each dataset's [distribution](#distribution).
140140

141+
{: .schema-fields .requirements-key}
142+
* Key
143+
* {: .field-required} Required
144+
* {: .field-required-if-applicable} Required if Applicable
145+
* {: .field-optional} Expanded (optional)
141146

147+
148+
{: .schema-fields}
142149
* Catalog
143-
* [conformsTo](#conformsTo)
144-
* [describedBy](#describedBy)
145-
* [dataset](#dataset)
146-
* [accessLevel](#accessLevel)
147-
* [accrualPeriodicity](#accrualPeriodicity)
148-
* [bureauCode](#bureauCode)
149-
* [conformsTo](#dataset-conformsTo)
150-
* [contactPoint](#contactPoint)
151-
* [fn](#contactPoint-fn)
152-
* [hasEmail](#contactPoint-hasEmail)
153-
* [dataQuality](#dataQuality)
154-
* [describedBy](#dataset-describedBy)
155-
* [describedByType](#dataset-describedByType)
156-
* [description](#description)
157-
* [distribution](#distribution)
158-
* [accessURL](#distribution-accessURL)
159-
* [conformsTo](#distribution-conformsTo)
160-
* [downloadURL](#distribution-downloadURL)
161-
* [describedBy](#distribution-describedBy)
162-
* [describedByType](#distribution-describedByType)
163-
* [description](#distribution-description)
164-
* [format](#distribution-format)
165-
* [mediaType](#distribution-mediaType)
166-
* [title](#title)
167-
* [identifier](#identifier)
168-
* [isPartOf](#isPartOf)
169-
* [issued](#issued)
170-
* [keyword](#keyword)
171-
* [landingPage](#landingPage)
172-
* [language](#language)
173-
* [license](#license)
174-
* [modified](#modified)
175-
* [primaryITInvestmentUII](#primaryITInvestmentUII)
176-
* [programCode](#programCode)
177-
* [publisher](#publisher)
178-
* [name](#publisher-name)
179-
* [subOrganizationOf](#publisher-subOrganizationOf)
180-
* [rights](#rights)
181-
* [spatial](#spatial)
182-
* [systemOfRecords](#systemOfRecords)
183-
* [temporal](#temporal)
184-
* [theme](#theme)
185-
* [title](#title)
150+
* {: .field-required}[conformsTo](#conformsTo)
151+
* {: .field-optional}[describedBy](#describedBy)
152+
* {: .field-required}[dataset](#dataset)
153+
* {: .field-required}[accessLevel](#accessLevel)
154+
* {: .field-optional}[accrualPeriodicity](#accrualPeriodicity)
155+
* {: .field-required}[bureauCode](#bureauCode)
156+
* {: .field-optional}[conformsTo](#dataset-conformsTo)
157+
* {: .field-required}[contactPoint](#contactPoint)
158+
* {: .field-required}[fn](#contactPoint-fn)
159+
* {: .field-required}[hasEmail](#contactPoint-hasEmail)
160+
* {: .field-required-if-applicable}[dataQuality](#dataQuality)
161+
* {: .field-optional}[describedBy](#dataset-describedBy)
162+
* {: .field-optional}[describedByType](#dataset-describedByType)
163+
* {: .field-required}[description](#description)
164+
* {: .field-required-if-applicable}[distribution](#distribution)
165+
* {: .field-optional}[accessURL](#distribution-accessURL)
166+
* {: .field-optional}[conformsTo](#distribution-conformsTo)
167+
* {: .field-required-if-applicable}[downloadURL](#distribution-downloadURL)
168+
* {: .field-optional}[describedBy](#distribution-describedBy)
169+
* {: .field-optional}[describedByType](#distribution-describedByType)
170+
* {: .field-optional}[description](#distribution-description)
171+
* {: .field-optional}[format](#distribution-format)
172+
* {: .field-required-if-applicable}[mediaType](#distribution-mediaType)
173+
* {: .field-optional}[title](#title)
174+
* {: .field-required}[identifier](#identifier)
175+
* {: .field-optional}[isPartOf](#isPartOf)
176+
* {: .field-optional}[issued](#issued)
177+
* {: .field-required}[keyword](#keyword)
178+
* {: .field-optional}[landingPage](#landingPage)
179+
* {: .field-optional}[language](#language)
180+
* {: .field-required-if-applicable}[license](#license)
181+
* {: .field-required}[modified](#modified)
182+
* {: .field-optional}[primaryITInvestmentUII](#primaryITInvestmentUII)
183+
* {: .field-required}[programCode](#programCode)
184+
* {: .field-required}[publisher](#publisher)
185+
* {: .field-required}[name](#publisher-name)
186+
* {: .field-optional}[subOrganizationOf](#publisher-subOrganizationOf)
187+
* {: .field-required-if-applicable}[rights](#rights)
188+
* {: .field-required-if-applicable}[spatial](#spatial)
189+
* {: .field-optional}[systemOfRecords](#systemOfRecords)
190+
* {: .field-required-if-applicable}[temporal](#temporal)
191+
* {: .field-optional}[theme](#theme)
192+
* {: .field-required}[title](#title)
186193

187194

188195
Catalog Fields {#Catalog}

0 commit comments

Comments
 (0)