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
* fix: switched yaml references to yml
* switched from spinal-case to camelCase
* fix: switch to plurals instead of List in keys
* fix: fixed typos
* feat: Added repo info in README
* feat: Converted settings file to italian
* feat: added Italian README and Italian index page
Copy file name to clipboardExpand all lines: _docs/en/schema.md
+28-26Lines changed: 28 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,6 @@
1
-
[< Back to version 0.1](index.html) -- this file is part of the [`publiccode.yml` specification](http://w3id.org/publiccode/).
2
-
3
1
# The main schema
4
2
5
-
This document the description of the schema of
6
-
`publiccode.yml`.
3
+
This document represents the description of the `publiccode.yml` schema.
7
4
8
5
## Structure
9
6
@@ -15,35 +12,38 @@ sense in specific countries, such as declaring compliance with local
15
12
laws or regulations. The provided extension mechanism is the usage
16
13
of country-specific sections.
17
14
18
-
All country-specific sections are contained in a section named with the two-letter lowercase [ISO 3166-1 alpha-2 country code](https://it.wikipedia.org/wiki/ISO_3166-1_alpha-2).
19
-
For instance `spid` is a property for Italian software declaring whether the software is integrated with the Italian Public Identification System.
15
+
All country-specific extensions are contained in a section named with the
This key specifies the version to which the current `publiccode.yml`
46
-
adheres to, for forward compatibility. Current version is `0.1`.
46
+
adheres to, for forward compatibility.
47
47
48
48
### Key `name`
49
49
@@ -108,7 +108,7 @@ specified repositories.
108
108
### Key `softwareVersion`
109
109
110
110
* Type: string
111
-
* Presence: mandatory
111
+
* Presence: optional
112
112
* Example: `"1.0"`, `"dev"`
113
113
114
114
This key contains the latest stable version number of the software.
@@ -131,12 +131,12 @@ and thus the version number is present.
131
131
132
132
### Key `logo`
133
133
134
-
* Type: string (path to file)
134
+
* Type: string (relative path to file or absolute URL)
135
135
* Presence: optional
136
136
* Acceptable formats: SVG, SVGZ, PNG
137
137
* Example: `img/logo.svg`
138
138
139
-
This key contains the logo of the software. Logos should be in vector
139
+
This key contains the path to the logo of the software. Logos should be in vector
140
140
format; raster formats are only allowed as a fallback. In this case, they should be transparent PNGs, minimum 1000px of
141
141
width.
142
142
@@ -291,17 +291,17 @@ This section contains a general description of the software. Parsers
291
291
can use this section for instance to create a web page describing
292
292
the software.
293
293
294
-
**Note** Since all the strings contained in this section are user-visible and written in a specific language, you **must** specify the language you are editing the text in (using [ISO 639-2](https://en.wikipedia.org/wiki/ISO_639-2) alpha-3 codes) by creating a section with that name.
294
+
**Note** Since all the strings contained in this section are user-visible and written in a specific language, you **must** specify the language you are editing the text in (using [ISO 639-2](https://en.wikipedia.org/wiki/ISO_639-2) alpha-3 codes) by creating a sub-section with that name.
295
295
296
296
An example for English:
297
-
```.yaml
297
+
```.yml
298
298
description:
299
299
eng:
300
300
shortDescription: ...
301
301
longDescription: ...
302
302
```
303
303
304
-
In the following part of the document, all keys are assumed to be in a section with the name of the language (we will note this with `[lang]`).
304
+
In the following part of the document, all keys are assumed to be in a sub-section with the name of the language (we will note this with `[lang]`).
305
305
306
306
**Note:** It is mandatory to have *at least* one language in this section. All other languages are optional.
307
307
@@ -413,7 +413,7 @@ Each tag must be in Unicode lowercase, and should not contain
413
413
any Unicode whitespace character. The suggested character to
414
414
separate multiple words is `-` (single dash).
415
415
416
-
### Key `description/[lang]/featureList`
416
+
### Key `description/[lang]/features`
417
417
418
418
* Type: array of strings
419
419
* Presence: mandatory (for at least one language)
@@ -461,6 +461,9 @@ be hosted on a video sharing website that supports the
461
461
[oEmbed](https://oembed.com) standard; popular options are YouTube and
462
462
Vimeo.
463
463
464
+
Since videos are an integral part of the documentation, it is recommended to
465
+
publish them with an open license.
466
+
464
467
### Key `description/[lang]/awards`
465
468
466
469
* Type: array of strings
@@ -576,7 +579,8 @@ This section provides an overview of the localization features of the software.
576
579
* Type: boolean
577
580
* Presence: mandatory
578
581
579
-
If `yes`, the software has infrastructure in place or is otherwise designed to be multilingual. It does not need to be available in more than one language.
582
+
If `yes`, the software has infrastructure in place or is otherwise designed to
583
+
be multilingual. It does not need to be available in more than one language.
580
584
581
585
## Key `localisation/availableLanguages`
582
586
@@ -585,8 +589,6 @@ If `yes`, the software has infrastructure in place or is otherwise designed to b
585
589
586
590
If present, this is the list of languages in which the software is available. Of course, this list will contain at least one language.
587
591
588
-
See also: https://en.wikipedia.org/wiki/ISO_639-2
589
-
590
592
### Section `dependsOn`
591
593
592
594
This section provides an overview on the system-level dependencies
@@ -638,15 +640,15 @@ A `dependency` is a complex object. The properties are the following:
638
640
It is of course possible to use the various keys to specify a complex compatibility matrix.
639
641
640
642
*Ex. 1*
641
-
```.yaml
643
+
```.yml
642
644
- name: PostgreSQL
643
645
version: 3.2
644
646
optional: yes
645
647
```
646
648
This snippet marks an optional dependency on PostgreSQL exactly version 3.2.
0 commit comments