Skip to content

Commit 033b45b

Browse files
NdpntNdpnt
committed
Update metadata reference
1 parent 8393fe7 commit 033b45b

File tree

2 files changed

+82
-69
lines changed

2 files changed

+82
-69
lines changed

‎content/collections/reference/metadata.md

+81-68
Original file line numberDiff line numberDiff line change
@@ -17,174 +17,187 @@ As an example, see the [complete metadata file](https://github.com/OpenTermsArch
1717
name="id"
1818
type="string"
1919
description="Unique identifier derived from name (acronyms, dash-separated)."
20-
example="`pga`"
20+
example="pga"
2121
required=true
2222
>}}
2323
2424
{{< configOption
2525
name="name"
2626
type="string"
27-
description="Display name of the collection (max 3 words)."
28-
example="`Platform Governance Archive`"
27+
description="Display name of the collection."
28+
example="Platform Governance Archive"
2929
required=true
3030
>}}
3131
3232
{{< configOption
3333
name="tagline"
3434
type="string"
3535
description="Concise description of collection topic."
36-
example="`Major global social media services`"
36+
example="Major global social media services"
3737
required=true
3838
>}}
3939
4040
{{< configOption
4141
name="languages"
42-
type="Array of strings"
43-
description="[ISO 639 language codes](https://en.wikipedia.org/wiki/ISO_639) allowed in collection."
44-
example="`[en, fr, de]`"
42+
type="array of strings"
43+
description="List of [ISO 639-1 (two-letter)](https://en.wikipedia.org/wiki/ISO_639) language codes representing languages allowed in the collection."
44+
example="[en, fr, de]"
4545
required=true
4646
>}}
4747
4848
{{< configOption
4949
name="jurisdictions"
50-
type="Array of strings"
51-
description="[ISO 3166-2 country codes](https://en.wikipedia.org/wiki/ISO_3166-2) for covered jurisdictions."
52-
example="`[EU]`"
50+
type="array of strings"
51+
description="List of [ISO 3166-2 country codes](https://en.wikipedia.org/wiki/ISO_3166-2) representing jurisdictions covered by the collection."
52+
example="[EU]"
5353
required=true
5454
>}}
5555
5656
{{< configOption
5757
name="description"
5858
type="string"
59-
description="Detailed description of the collection."
59+
description="Detailed description of the collection"
6060
example=`The **Platform Governance Archive** (PGA) collection tracks the terms of major global social media services.
6161

6262
This data is maintained and analysed by the [Platform Governance Archive](https://www.platformgovernancearchive.org/) at the Universität Bremen's [Center for Media Communication and Information Research (ZeMKI)](https://www.uni-bremen.de/zemki).
6363

6464
This initiative offers researchers, journalists and citizens the tools to analyze how platforms structure and regulate communication and interaction in our societies.
6565

66-
It also aims to promote greater transparency and accountability of these powerful digital services.`
66+
It also aims to promote greater transparency and accountability of these powerful digital services.
67+
`
68+
required=false
6769
>}}
68-
70+
6971
{{< configOption
7072
name="dataset"
71-
type="url"
72-
description="URL to released versions dataset."
73-
example="`https://github.com/OpenTermsArchive/pga-versions/releases`"
73+
type="uri"
74+
description="URL to the dataset releases."
75+
example="https://github.com/OpenTermsArchive/pga-versions/releases"
76+
required=false
7477
>}}
7578
7679
{{< configOption
7780
name="declarations"
78-
type="url"
79-
description="URL to declarations repository."
80-
example="`https://github.com/OpenTermsArchive/pga-declarations`"
81+
type="uri"
82+
description="URL to the declarations repository."
83+
example="https://github.com/OpenTermsArchive/pga-declarations"
84+
required=false
8185
>}}
8286
8387
{{< configOption
8488
name="versions"
85-
type="url"
86-
description="URL to versions repository."
87-
example="`https://github.com/OpenTermsArchive/pga-versions`"
89+
type="uri"
90+
description="URL to the versions repository."
91+
example="https://github.com/OpenTermsArchive/pga-versions"
92+
required=false
8893
>}}
8994
9095
{{< configOption
9196
name="snapshots"
92-
type="url"
93-
description="URL to snapshots repository."
94-
example="`https://github.com/OpenTermsArchive/pga-snapshots`"
97+
type="uri"
98+
description="URL to the snapshots repository."
99+
example="https://github.com/OpenTermsArchive/pga-snapshots"
100+
required=false
95101
>}}
96102
97103
{{< configOption
98-
name="logo"
99-
type="url"
100-
description="URL to the collection's logo. Optimized PNG transparent image (min width 240px)."
101-
example="`https://opentermsarchive.org/images/collections/pga.png`"
104+
name="donations"
105+
type="uri"
106+
description="URL to the donations page."
107+
example="https://opencollective.com/opentermsarchive"
108+
required=false
102109
>}}
103110
104111
{{< configOption
105-
name="donations"
106-
type="url"
107-
description="URL to the donations page."
108-
example="`https://opencollective.com/opentermsarchive`"
112+
name="logo"
113+
type="uri"
114+
description="URL to the collection's logo. Optimized PNG transparent image (min width 240px)."
115+
required=false
109116
>}}
110117
111118
{{< configOption
112119
name="trackingPeriods"
113-
type="array of tracking periods objects"
114-
description="Tracking periods object, see [Tracking periods](#tracking-periods) section."
120+
type="array of objects"
121+
description="trackingPeriods object, see [TrackingPeriods](#trackingperiods) section."
122+
required=false
115123
>}}
116124
117125
{{< configOption
118126
name="governance"
119-
type="array of entity objects"
120-
description="Entity object, see [Entity](#entity) section."
127+
type="object"
128+
description="Map of organizations involved in the collection's governance, with organization names as keys governance object, see [Governance](#governance) section."
129+
required=false
130+
>}}
131+
132+
{{< configOption
133+
name="i18n"
134+
type="object"
135+
description="Internationalization of any of the Metadata properties (except i18n itself) for different language codes"
136+
required=false
121137
>}}
122138
123139
---
124140

125-
### Tracking periods
141+
### TrackingPeriods
126142

127143
{{< configOption
128144
name="startDate"
129145
type="date"
130-
description="The date when tracking started (ISO 8601 format: YYYY-MM-DD)."
131-
example="`2023-01-01`"
146+
description="The date when tracking started for this period (ISO 8601 format YYYY-MM-DD)."
147+
example="2023-01-01"
132148
required=true
133149
>}}
134150
135-
{{< configOption
136-
name="endDate"
137-
type="date"
138-
description="The date when tracking ended or will end. If not specified, tracking is ongoing."
139-
example="`2024-12-31`"
140-
>}}
141-
142151
{{< configOption
143152
name="schedule"
144-
type="string"
153+
type="cron-expression"
145154
description="A [cron expression](https://en.wikipedia.org/wiki/Cron#Cron_expression) that defines the tracking frequency."
146-
example="`0 0 * * *`"
155+
example="0 0 * * *"
147156
required=true
148157
>}}
149158
150159
{{< configOption
151160
name="serverLocation"
152161
type="string"
153162
description="The geographic location of the tracking server (city name, ISO 3166-2 country code)."
154-
example="`London, GB`"
163+
example="London, GB"
155164
required=true
156165
>}}
157166
158-
---
159-
160-
### Entity
161-
162167
{{< configOption
163-
name="name"
164-
type="string"
165-
description="Name of the organization."
166-
example="`Open Terms Archive`"
167-
required=true
168+
name="endDate"
169+
type="date"
170+
description="The date when tracking ended for this period (ISO 8601 format YYYY-MM-DD). If not specified, tracking is ongoing."
171+
example="2023-12-01"
172+
required=false
168173
>}}
169174
175+
176+
---
177+
178+
### Governance
179+
170180
{{< configOption
171181
name="url"
172-
type="url"
173-
description="Website URL of the organization."
174-
example="`https://opentermsarchive.org/`"
182+
type="uri"
183+
description="URL to the entity's website"
184+
example="https://opentermsarchive.org/"
185+
required=false
175186
>}}
176187
177188
{{< configOption
178189
name="logo"
179-
type="url"
180-
description="URL to the organization's logo. Optimized PNG transparent image (min width 240px)."
181-
example="`https://opentermsarchive.org/images/logo/logo-open-terms-archive-black.png`"
190+
type="uri"
191+
description="URL to the entity's logo. Optimized PNG transparent image (min width 240px)."
192+
example="https://opentermsarchive.org/images/logo/logo-open-terms-archive-black.png"
193+
required=false
182194
>}}
183195
184196
{{< configOption
185197
name="roles"
186-
type="string"
187-
description="Roles of the entity within the governance, see [collection governance]({{< relref \"collections/reference/governance\" >}})."
198+
type="array of strings"
199+
description="Roles of the entity within the governance, see [collection governance](https://docs.opentermsarchive.org/collections/reference/governance/)"
188200
allowedValues="`host`, `administrator`, `curator`, `maintainer`, `sponsor`"
189-
required=true
201+
example="[host, administrator]"
202+
required=false
190203
>}}

‎themes/opentermsarchive/layouts/shortcodes/configOption.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<div class="config-option-default"><span>Default:</span>{{ .Get "default" | markdownify}}</div>
1313
{{ end }}
1414
{{ if .Get "example" }}
15-
<div class="config-option-example"><span>Example:</span>{{ .Get "example" | markdownify }}</div>
15+
<div class="config-option-example"><span>Example:</span><code>{{ .Get "example" | markdownify }}</code></div>
1616
{{ end }}
1717
{{ if .Get "allowedValues" }}
1818
<div class="config-option-allowed-values"><span>Allowed values:</span>{{ .Get "allowedValues" | markdownify }}</div>

0 commit comments

Comments
 (0)