@@ -130,6 +130,52 @@ the repository, or it can be an absolute URL pointing to the logo in raw
130130version. In both cases, the file must reside inside the same repository where
131131the ``publiccode.yml `` file is stored.
132132
133+ Key ``monochromeLogo `` (*deprecated *)
134+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
135+
136+ - Type: string (path to file)
137+ - Presence: optional
138+ - Acceptable formats: SVG, SVGZ, PNG
139+ - Example: ``"img/logo-mono.svg" ``
140+
141+ A monochromatic (black) logo. The logo should be in vector format;
142+ raster formats are only allowed as a fallback. In this case, they should
143+ be transparent PNGs, minimum 1000px of width.
144+ The key value can be the relative path to the file starting from the root of
145+ the repository, or it can be an absolute URL pointing to the logo in raw
146+ version. In both cases, the file must reside inside the same repository where
147+ the ``publiccode.yml `` file is stored.
148+
149+ Key ``inputTypes `` (*deprecated *)
150+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
151+
152+ - Type: array of enumerated strings
153+ - Presence: optional
154+ - Values: as per RFC 6838
155+ - Example: ``"text/plain" ``
156+
157+ A list of Media Types (MIME Types) as mandated in `RFC
158+ 6838 <https://tools.ietf.org/html/rfc6838> `__ which the application can
159+ handle as input.
160+
161+ In case the software does not support any input, you can skip this field
162+ or use ``application/x.empty ``.
163+
164+ Key ``outputTypes `` (*deprecated *)
165+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
166+
167+ - Type: array of enumerated strings
168+ - Presence: optional
169+ - Values: as per RFC 6838
170+ - Example: ``"text/plain" ``
171+
172+ A list of Media Types (MIME Types) as mandated in `RFC
173+ 6838 <https://tools.ietf.org/html/rfc6838> `__ which the application can
174+ handle as output.
175+
176+ In case the software does not support any output, you can skip this
177+ field or use ``application/x.empty ``.
178+
133179Key ``platforms ``
134180~~~~~~~~~~~~~~~~~
135181
@@ -329,8 +375,8 @@ Key ``intendedAudience/countries``
329375
330376This key explicitly includes certain countries in the intended audience,
331377i.e. the software explicitly claims compliance with specific processes,
332- technologies or laws. All countries are specified using uppercase
333- ISO 3166-1 alpha-2 two-letter country codes.
378+ technologies or laws. All countries are specified using lowercase (* deprecated *)
379+ or uppercase ISO 3166-1 alpha-2 two-letter country codes.
334380
335381Key ``intendedAudience/unsupportedCountries ``
336382'''''''''''''''''''''''''''''''''''''''''''''
@@ -341,7 +387,7 @@ Key ``intendedAudience/unsupportedCountries``
341387This key explicitly marks countries as NOT supported. This might be the
342388case if there is a conflict between how software is working and a
343389specific law, process or technology. All countries are specified using
344- uppercase ISO 3166-1 alpha-2 two-letter country codes.
390+ lowercase (* deprecated *) or uppercase ISO 3166-1 alpha-2 two-letter country codes.
345391
346392Key ``intendedAudience/scope ``
347393''''''''''''''''''''''''''''''
@@ -396,6 +442,19 @@ name most people usually refer to the software. In case the software has
396442both an internal “code” name and a commercial name, use the commercial
397443name.
398444
445+ Key ``description/[lang]/genericName `` (*deprecated *)
446+ '''''''''''''''''''''''''''''''''''''''''''''''''''''
447+
448+ - Type: string (max 35 chars)
449+ - Presence: optional
450+ - Example: ``"Text Editor" ``
451+
452+ This key is the “Generic name”, which refers to the specific category to
453+ which the software belongs. You can usually find the generic name in the
454+ presentation of the software, when you write: “Software xxx is a yyy”.
455+ Notable examples include “Text Editor”, “Word Processor”, “Web Browser”,
456+ “Chat” and so on… The generic name can be up to 35 characters long.
457+
399458Key ``description/[lang]/shortDescription ``
400459'''''''''''''''''''''''''''''''''''''''''''
401460
@@ -574,7 +633,36 @@ sentence. It is also possible to informally refer to a community of
574633group of people like “Linus Torvalds and all Linux contributors”.
575634
576635In case it is not possible to name a main copyright owner, it is
577- possible to omit this key.
636+ possible to omit this key; in those cases, if the repo has a authors
637+ file, you can point to it through ``legal/authorsFile ``.
638+
639+ Key ``legal/repoOwner `` (*deprecated *)
640+ ''''''''''''''''''''''''''''''''''''''
641+
642+ - Type: string
643+ - Presence: optional
644+ - Example: ``"City of Amsterdam" ``
645+
646+ This string describes the entity that owns this repository; this might
647+ or might not be the same entity who owns the copyright on the code
648+ itself. For instance, in case of a fork of the original software, the
649+ ``repoOwner `` is probably different from the ``mainCopyrightOwner ``.
650+
651+ This key is deprecated, use ``organisation/name `` instead.
652+
653+ Key ``legal/authorsFile `` (*deprecated *)
654+ ''''''''''''''''''''''''''''''''''''''''
655+
656+ - Type: string (path to file)
657+ - Presence: optional
658+ - Example: ``"doc/AUTHORS.txt" ``
659+
660+ Some open-source software adopt a convention of identify the copyright
661+ holders through a file that lists all the entities that own the
662+ copyright. This is common in projects strongly backed by a community
663+ where there are many external contributors and no clear single/main
664+ copyright owner. In such cases, this key can be used to refer to the
665+ authors file, using a path relative to the root of the repository.
578666
579667Section ``maintenance ``
580668~~~~~~~~~~~~~~~~~~~~~~~
@@ -803,4 +891,5 @@ format though, so not the full ISO8601 is allowed for the date keys.
803891
804892Encoding
805893~~~~~~~~
806- `publiccode.yml ` **MUST ** be a UTF-8 encoded and **MUST ** be a YAML 1.2 document.
894+ `publiccode.yml ` **MUST ** be a UTF-8 encoded and **SHOULD ** be a YAML 1.2 document,
895+ using YAML 1.1 is *deprecated *.
0 commit comments