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
Copy file name to clipboardExpand all lines: content/collections/reference/metadata.en.md
+30-71Lines changed: 30 additions & 71 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,39 +5,45 @@ weight: 1
5
5
6
6
# Collection metadata
7
7
8
-
A collection is defined by the following metadata.
8
+
This reference documentation details all available metadata fields that can be specified in a collection's metadata file.
9
9
10
-
## Required fields
10
+
## Fields
11
11
12
-
{{< configOption name="name" type="string" description="Display name of the collection (max 3 words)" example="Platform Governance Archive" >}}
12
+
{{< configOption name="id" type="string" description="Unique identifier derived from name (acronyms, dash-separated)" example="pga" required=true >}}
13
13
14
-
{{< configOption name="id" type="string" description="Unique identifier derived from name (acronyms, dash-separated)" example="pga" >}}
14
+
{{< configOption name="name" type="string" description="Display name of the collection (max 3 words)" example="Platform Governance Archive" required=true >}}
15
15
16
-
{{< configOption name="tagline" type="string" description="Concise description of collection topic" example="Largest global social media" >}}
16
+
{{< configOption name="tagline" type="string" description="Concise description of collection topic" example="Major global social media services" required=true >}}
17
17
18
-
{{< configOption name="languages" type="Array of strings" description="[ISO 639 language codes](https://en.wikipedia.org/wiki/ISO_639) allowed in collection" example="[en, fr, de]" >}}
18
+
{{< configOption name="languages" type="Array of strings" description="[ISO 639 language codes](https://en.wikipedia.org/wiki/ISO_639) allowed in collection" example="[en, fr, de]" required=true >}}
19
19
20
-
{{< configOption name="jurisdictions" type="Array of strings" description="[ISO 3166-2 country codes](https://en.wikipedia.org/wiki/ISO_3166-2) for covered jurisdictions" example="[EU]" >}}
20
+
{{< configOption name="jurisdictions" type="Array of strings" description="[ISO 3166-2 country codes](https://en.wikipedia.org/wiki/ISO_3166-2) for covered jurisdictions" example="[EU]" required=true >}}
21
21
22
-
## Additional fields
22
+
{{< configOption name="description" type="string" description="Detailed description of the collection" example=`The **Platform Governance Archive** (PGA) collection tracks the terms of major global social media services.
23
23
24
-
{{< configOption name="description" type="string" description="Detailed context beyond tagline" example="Comprehensive collection of terms of service from major global social media platforms." >}}
24
+
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).
25
25
26
-
{{< configOption name="dataset" type="url" description="URL to released versions dataset" example="https://github.com/OpenTermsArchive/demo-versions/releases" >}}
26
+
This initiative offers researchers, journalists and citizens the tools to analyze how platforms structure and regulate communication and interaction in our societies.
27
27
28
-
{{< configOption name="declarations" type="url" description="URL to declarations repository" example="https://github.com/OpenTermsArchive/demo-declarations" >}}
28
+
It also aims to promote greater transparency and accountability of these powerful digital services.` >}}
29
+
30
+
{{< configOption name="dataset" type="url" description="URL to released versions dataset" example="https://github.com/OpenTermsArchive/pga-versions/releases" >}}
29
31
30
-
{{< configOption name="versions" type="url" description="URL to versions repository" example="https://github.com/OpenTermsArchive/demo-versions" >}}
32
+
{{< configOption name="declarations" type="url" description="URL to declarations repository" example="https://github.com/OpenTermsArchive/pga-declarations" >}}
31
33
32
-
{{< configOption name="snapshots" type="url" description="URL to snapshots repository" example="https://github.com/OpenTermsArchive/demo-snapshots" >}}
34
+
{{< configOption name="versions" type="url" description="URL to versions repository" example="https://github.com/OpenTermsArchive/pga-versions" >}}
33
35
34
-
{{< configOption name="logo" type="url" description="URL to the collection's logo. Optimized PNG transparent image (min width 240px)" example="https://opentermsarchive.org/images/collections/demo.png" >}}
36
+
{{< configOption name="snapshots" type="url" description="URL to snapshots repository" example="https://github.com/OpenTermsArchive/pga-snapshots" >}}
35
37
36
-
{{< configOption name="donation" type="url" description="URL to donation page" example="https://opencollective.com/opentermsarchive" >}}
38
+
{{< configOption name="logo" type="url" description="URL to the collection's logo. Optimized PNG transparent image (min width 240px)" example="https://opentermsarchive.org/images/collections/pga.png" >}}
37
39
38
-
{{< configOption name="trackingPeriods" type="array of tracking periods objects" description="see [Tracking periods](#tracking-periods) section" >}}
40
+
{{< configOption name="donations" type="url" description="URL to the donations page" example="https://opencollective.com/opentermsarchive" >}}
{{< configOption name="trackingPeriods" type="array of tracking periods objects" description="Tracking periods object, see [Tracking periods](#tracking-periods) section" >}}
43
+
44
+
{{< configOption name="governance" type="array of entity objects" description="Entity object, see [Entity](#entity) section" >}}
45
+
46
+
---
41
47
42
48
### Tracking periods
43
49
@@ -49,65 +55,18 @@ A collection is defined by the following metadata.
49
55
50
56
{{< configOption name="serverLocation" type="string" description="The geographic location of the tracking server (city name, ISO 3166-2 country code)" example="London, GB" >}}
51
57
52
-
### Governance
53
-
54
-
{{< configOption name="hosts" type="Array of organizations objects" description="Organizations hosting the collection" >}}
55
-
56
-
{{< configOption name="administrators" type="Array of organizations objects" description="Organizations managing the collection" >}}
57
-
58
-
{{< configOption name="curators" type="Array of organizations objects" description="Organizations curating the content" >}}
59
-
60
-
{{< configOption name="maintainers" type="Array of organizations objects" description="Organizations maintaining the technical aspects" >}}
{{< configOption name="roles" type="string" description="Roles of the entity within the governance" allowedValues="host, administrator, curator, maintainer, sponsor" >}}
69
+
70
+
---
71
+
72
+
As an example, see the [complete metadata file](https://github.com/OpenTermsArchive/demo-declarations/blob/main/metadata.yml) of the [Demo collection](https://github.com/OpenTermsArchive/demo-declarations).
0 commit comments