Skip to content

Commit 5a89f25

Browse files
authored
Moved country extension to other page (#41)
fix: several typos feat: moved country extension to new file.
1 parent 21569e6 commit 5a89f25

7 files changed

Lines changed: 95 additions & 103 deletions

File tree

docs/en/country.rst

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
.. _`country-extension`:
2+
3+
Country-Specific Sections
4+
=========================
5+
6+
While the standard is structured to be meaningful on an international
7+
level, there are additional information that can be added that makes
8+
sense in specific countries, such as declaring compliance with local
9+
laws or regulations. The provided extension mechanism is the usage of
10+
country-specific sections.
11+
12+
All country-specific extensions are contained in a section named with
13+
the two-letter lowercase `ISO 3166-1 alpha-2 country
14+
code <https://it.wikipedia.org/wiki/ISO_3166-1_alpha-2>`__. For instance
15+
``spid`` is a property for Italian software declaring whether the
16+
software is integrated with the Italian Public Identification System.
17+
18+
If a software is compliant I will find:
19+
20+
.. code:: .yaml
21+
22+
it:
23+
spid: yes
24+
25+
Notice that country-specific extensions within international sections
26+
are not allowed. Countries that want to extend the format should add a
27+
country-specific section instead.
28+
29+
Documentation for the keys contained in a country specific section is
30+
maintained in separate files.
31+
32+
- Italy: :ref:`italia-extensions`.

docs/en/index.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ The ``publiccode.yml`` Standard
55
:numbered:
66

77
intro.rst
8-
schema.md
9-
schema.it.md
10-
forks.md
11-
pa-types.md
12-
tags.md
13-
tools.md
8+
schema.rst
9+
country.rst
10+
forks.rst
11+
pa-types.rst
12+
tags.rst
13+
tools.rst
1414
example.rst

docs/en/schema.rst

Lines changed: 1 addition & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -4,40 +4,9 @@ The Standard
44
This document represents the description of the ``publiccode.yml``
55
schema.
66

7-
Country-specific extensions
7+
Top-Level Keys and Sections
88
---------------------------
99

10-
While the standard is structured to be meaningful on an international
11-
level, there are additional information that can be added that makes
12-
sense in specific countries, such as declaring compliance with local
13-
laws or regulations. The provided extension mechanism is the usage of
14-
country-specific sections.
15-
16-
All country-specific extensions are contained in a section named with
17-
the two-letter lowercase `ISO 3166-1 alpha-2 country
18-
code <https://it.wikipedia.org/wiki/ISO_3166-1_alpha-2>`__. For instance
19-
``spid`` is a property for Italian software declaring whether the
20-
software is integrated with the Italian Public Identification System.
21-
22-
If a software is compliant I will find:
23-
24-
::
25-
26-
it:
27-
spid: yes
28-
29-
Notice that country-specific extensions within international sections
30-
are not allowed. Countries that want to extend the format should add a
31-
country-specific section instead.
32-
33-
Documentation for the keys contained in a country specific section is
34-
maintained in separate files.
35-
36-
- Italy: :ref:`italia-estensions`.
37-
38-
Top-level section
39-
-----------------
40-
4110
Key ``publiccodeYmlVersion``
4211
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4312

docs/it/country.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
.. _`estensioni-paese`:
2+
3+
Chiavi e Sezioni Specifiche per Paese
4+
=====================================
5+
6+
Mentre lo standard è strutturato per essere significativo a livello
7+
internazionale, vi sono informazioni addizionali che possono essere
8+
aggiunte a livello nazionale, come ad esempio una dichiarazione di
9+
compatibilità con una legge locale. Il meccanismo di estensione fornito
10+
prevede l’utilizzo di sezioni specifiche per ogni Paese
11+
(*country-specific*).
12+
13+
Tutte le sezioni specifiche per ogni Paese sono contenute in una sezione
14+
denominata con l’\ `ISO 3166-1 alpha-2 country
15+
code <https://it.wikipedia.org/wiki/ISO_3166-1_alpha-2>`__. Ad esempio,
16+
``spid`` è una proprietà definita per i software italiani per la
17+
dichiarazione dell’eventuale compatibilità con il Sistema Pubblico di
18+
Identità Digitale.
19+
20+
Dunque, se un software è compatibile, troveremo:
21+
22+
.. code:: .yaml
23+
24+
it:
25+
spid: yes
26+
27+
Nota bene che le chiavi *country-specific* **non** sono valide
28+
all’interno delle sezioni internazionali. I Paesi che vogliano estendere
29+
il formato dovrebbero aggiungere una sezione dedicata.
30+
31+
La documentazione per queste estensioni *country-specific* è mantenuta
32+
in file separati.
33+
34+
.. include:: schema.it.rst

docs/it/index.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ Lo Standard ``publiccode.yml``
55
:numbered:
66

77
intro.rst
8-
schema.md
9-
schema.it.md
10-
forks.md
11-
pa-types.md
12-
tags.md
13-
tools.md
8+
schema.rst
9+
country.rst
10+
forks.rst
11+
pa-types.rst
12+
tags.rst
13+
tools.rst
1414
example.rst

docs/it/schema.it.rst

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,11 @@
11
.. _estensioni-italiane:
22

3-
Estensioni italiane
4-
========================================
3+
Chiavi e Sezioni italiane
4+
-------------------------
55

6-
Estensioni
7-
----------
8-
9-
Tutte le estensioni elencate qui di seguito sono specifiche per un Paese e, di
6+
Tutte le estensioni elencate qui di seguito sono specifiche per l'Italia e, di
107
conseguenza, devono essere inserite in una sezione denominata con
11-
l’\ `ISO 3166-1 alpha-2 country
12-
code <https://it.wikipedia.org/wiki/ISO_3166-1_alpha-2>`__.
13-
In questo caso, siccome le sezioni e chiavi seguenti sono italiane,
14-
è necessario utilizzare il codice `it`.
8+
il codice ``it``.
159

1610
Sezione ``conforme``
1711
~~~~~~~~~~~~~~~~~~~~

docs/it/schema.rst

Lines changed: 12 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
11
Lo standard
2-
===========================
2+
===========
33

44
La struttura di un file ``publiccode.yml`` prevede l'esistenza di chiavi
55
top-level e sezioni che possono contenere al proprio interno altre chiavi.
66
Lo standard ha rilevanza internazionale ma è possibile dichiarare una sezione
77
dedicata per le chiavi relative ad un Paese specifico (si veda
88
:ref:`estensioni-paese` per maggiori dettagli).
99

10-
Estensioni Top-Level
11-
--------------------
12-
10+
Chiavi e Sezioni Top-Level
11+
--------------------------
1312

1413
Chiave ``publiccodeYmlVersion``
1514
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -282,22 +281,22 @@ Chiave ``softwareType``
282281
``configurationFiles``
283282

284283
Le chiavi sono:
284+
285285
- ``standalone`` - Il software è un pacchetto *self-contained*, *standalone*.
286-
La maggior parte del software sarà di questo tipo. Pare di questa categoria
287-
di software potrà essere eseguita
288-
su un computer desktop (e.g., un eseguibile), come un’applicazione
289-
*cloud-based*, come un servizio di rete o anche come un set di servizi
290-
cloud o microservizi.
286+
La maggior parte del software sarà di questo tipo. I software
287+
appartenenti a questa categoria potrebbero essere eseguiti
288+
su un computer desktop (e.g., un eseguibile) oppure potrebbero essere
289+
*cloud-based* o servizi di rete, oppure set di microservizi.
291290
- ``softwareAddon`` - Il software è un *addon*,
292291
come ad esempio un plugin o un tema, per un software più complesso
293292
(e.g., un CMS o una suite per ufficio).
294293
- ``library`` - Il software
295-
contiene una libreria o una SDK che permette uno sviluppo più semplice
296-
per sviluppatori di terze parti per la creazione di nuovi prodotti.
294+
contiene una libreria o una SDK che facilita la creazione di nuovi prodotti
295+
a sviluppatori di terze parti.
297296
- ``configurationFiles`` - Il software non contiene script eseguibili ma
298297
una serie di file di configurazione. Questi potrebbero documentare come
299-
ottenere un certo tipo di *deployment*. Potrebbero avere la forma di
300-
semplici file di configurazione, script bash, playbook ansible,
298+
ottenere un certo tipo di *deployment*. I suddetti file potrebbero avere la
299+
forma di semplici file di configurazione, script bash, playbook ansible,
301300
Dockerfile, o altri set di istruzioni.
302301

303302
Sezione ``intendedAudience``
@@ -769,42 +768,6 @@ Chiave ``dependsOn/hardware``
769768
This key contains a list of hardware dependencies that must be owned to use the
770769
software.
771770

772-
.. _`estensioni-paese`:
773-
774-
Estensioni Specifiche per Paese
775-
-------------------------------
776-
777-
Mentre lo standard è strutturato per essere significativo a livello
778-
internazionale, vi sono informazioni addizionali che possono essere
779-
aggiunte a livello nazionale, come ad esempio una dichiarazione di
780-
compatibilità con una legge locale. Il meccanismo di estensione fornito
781-
prevede l’utilizzo di sezioni specifiche per ogni Paese
782-
(*country-specific*).
783-
784-
Tutte le sezioni specifiche per ogni Paese sono contenute in una sezione
785-
denominata con l’\ `ISO 3166-1 alpha-2 country
786-
code <https://it.wikipedia.org/wiki/ISO_3166-1_alpha-2>`__. Ad esempio,
787-
``spid`` è una proprietà definita per i software italiani per la
788-
dichiarazione dell’eventuale compatibilità con il Sistema Pubblico di
789-
Identità Digitale.
790-
791-
Dunque, se un software è compatibile, troveremo:
792-
793-
::
794-
795-
it:
796-
spid: yes
797-
798-
Nota bene che le chiavi *country-specific* **non** sono valide
799-
all’interno delle sezioni internazionali. I Paesi che vogliano estendere
800-
il formato dovrebbero aggiungere una sezione dedicata.
801-
802-
La documentazione per queste estensioni *country-specific* è mantenuta
803-
in file separati.
804-
805-
- Italia: :ref:`estensioni-italiane`.
806-
807-
808771

809772
Formati di dato speciali
810773
------------------------

0 commit comments

Comments
 (0)