Skip to content

Commit d4af5e4

Browse files
committed
docs: improve wording for country-specific sections
Improve wording in the main standard and in the Italian translation.
1 parent 23eca7c commit d4af5e4

File tree

2 files changed

+16
-49
lines changed

2 files changed

+16
-49
lines changed

docs/it/country.rst

Lines changed: 9 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,16 @@
11
.. _`estensioni-paese`:
22

3-
Estensioni nazionali
4-
====================
3+
Sezioni specifiche per Paese
4+
============================
55

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*).
6+
Le sezioni specifiche per paese permettono di includere informazioni rilevanti
7+
solo per un determinato Paese, come la conformità a regolamenti nazionali o
8+
l'integrazione con piattaforme nazionali.
129

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>`__ in minuscolo (*deprecato*) o
16-
in maiuscolo.
17-
Ad esempio, ``spid`` è una proprietà definita per i software italiani per la
18-
dichiarazione dell’eventuale compatibilità con il Sistema Pubblico di
19-
Identità Digitale.
10+
Ogni sezione è identificata con l'\ `ISO 3166-1 alpha-2 country code
11+
<https://it.wikipedia.org/wiki/ISO_3166-1_alpha-2>`__ del Paese in minuscolo
12+
(*deprecato*) o in maiuscolo.
2013

21-
Dunque, se un software è compatibile, troveremo:
22-
23-
.. code:: yaml
24-
25-
it:
26-
countryExtensionVersion: "0.2"
27-
piattaforme:
28-
- spid: yes
29-
30-
Nota bene che le chiavi *country-specific* **non** sono valide
31-
all’interno delle sezioni internazionali. I Paesi che vogliano estendere
32-
il formato devono aggiungere una sezione dedicata.
14+
Attualmente, l'unica sezione specifica per Paese definita è quella italiana (it:).
3315

3416
.. include:: schema.it.rst

docs/standard/country.rst

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,16 @@
11
.. _`country-section`:
22

3-
Country-Specific Sections
3+
Country-specific sections
44
=========================
55

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.
6+
Country-specific sections allow including information relevant only within a
7+
given country, such as compliance with national regulations or integration with
8+
national platforms.
119

12-
All country-specific sections live under a key named after two-letter
10+
Each section is identified by a two-letter ISO 3166-1 alpha-2 country code
1311
lowercase (*deprecated*) or uppercase `ISO 3166-1 alpha-2 country
14-
codes <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.
12+
codes <https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2>`__.
1713

18-
If a software is compliant I will find:
19-
20-
.. code:: yaml
21-
22-
it:
23-
countryExtensionVersion: "1.0"
24-
piattaforme:
25-
- spid: true
26-
27-
Notice that country-specific keys within international sections
28-
are not allowed. Countries that want to extend the format should add a
29-
country-specific section instead.
14+
Currently, the only defined country-specific section is the Italian one (``it:``).
3015

3116
.. include:: schema.it.rst

0 commit comments

Comments
 (0)