Fixed documentation.

This commit is contained in:
Franco Masotti 2020-11-23 15:31:21 +01:00
parent 5ee422392f
commit a4a4317e70
Signed by: frnmst
GPG Key ID: 24116ED85666780A
3 changed files with 76 additions and 61 deletions

61
docs/assets.rst Normal file
View File

@ -0,0 +1,61 @@
Assets
======
fattura-elettronica-reader needs to download some files from the
*Agenzia delle Entrate* website.
No files can be included in this repository because of the website copyright.
See https://www.fatturapa.gov.it/it/copyright/index.html
For sake of completeness the current supported versions
and the SHA-512 and SHA-256 checksums are reported in the following table:
====================================================== ================================================================================================================ ==================================================================================================================================== ====================================================================
Name URL SHA-512 SHA-256
====================================================== ================================================================================================================ ==================================================================================================================================== ====================================================================
XML schema for FatturaPA version 1.2 https://www.fatturapa.gov.it/export/documenti/fatturapa/v1.2.1/Schema_del_file_xml_FatturaPA_versione_1.2.xsd ``e1deab535099bfe9aef798c7d75a992f562c2ffa7648e446a8e1c6b894691feecba0cc9dceb02eba02243a951e1423adcac043a49bb8ab255a88b5b3ecf013d2`` ``fecdf8122fa86d80d4ab6901149a4e5390d9880c00de9987d180a2959d54c842``
XML schema for FatturaPA version 1.2.1 https://www.fatturapa.gov.it/export/documenti/fatturapa/v1.2.1/Schema_del_file_xml_FatturaPA_versione_1.2.1a.xsd ``2a7c3f2913ee390c167e41ae5618c303b481f548f9b2a8d60dddc36804ddd3ebf7cb5003e5cc6996480c67d085b82b438aff7cc0f74d7c104225449785cb575b`` ``1a14ecdc867a01f447052ff1613688deef6f88bbee522f120be060f68d251976``
XML stylesheet for Fattura Ordinaria version 1.2.1 https://www.fatturapa.gov.it/export/documenti/fatturapa/v1.2.1/Foglio_di_stile_fatturaordinaria_v1.2.1.xsl ``849c4b50956b9e9eaccbbbffb04c1f345ff4abdc0dd191a14c54d48092c661984b1fcdb910c4c92291e158a62ecbb1c588d94e6bd6479e61ff6376746154df6c`` ``7e781d58f301055d3caa55aed2d1a8993185c60369004b418aec03a00ec2835a``
XML stylesheet for FatturaPA version 1.2.1 https://www.fatturapa.gov.it/export/documenti/fatturapa/v1.2.1/Foglio_di_stile_fatturaPA_v1.2.1.xsl ``301db9da3c0715c0ab5db22c561bfb2812fea3cef150ff4a2124fe6141ebb3cb1c898d7ca3c931f716eff3b7b1946ebc86ca8bdd6d7561979f2f3a0cb95ff560`` ``ac278f980b84ae59a428544adf3eb52fc1685e381e441f5b8302cfffe902fc7d``
Public keys file https://eidas.agid.gov.it/TL/TSL-IT.xml ``09c2cf39120a6ca869083a659e8861aae8d677957cbbd89be1286f0bb5ef5cbb33a17b15637e6245662e2a4fa60a26efa8fd1101bed2c4dcdff0bbbcbc7811fe`` ``680c51eafcf2bf33f56c960db3e2eaa6bb01a0e572ba22d306cb157b0c0539d2``
====================================================== ================================================================================================================ ==================================================================================================================================== ====================================================================
.. warning:: fattura-elettronica-reader is guaranteed to work with these file versions only!
Updates
-------
October 2020
````````````
The original URL of the schema file dissapeared.
.. image:: assets/old_link.png
:alt: Old link
A new URL points to the schema:
- https://www.fatturapa.gov.it/export/documenti/fatturapa/v1.2.1/Schema_del_file_xml_FatturaPA_versione_1.2.1a.xsd
This resource has been ``Last-Modified: Tue, 20 Oct 2020 19:29:21 GMT`` according to the HTTP headers.
.. image:: assets/page_information.png
:alt: Page information
Same goes for the XML stylesheet files:
- FatturaPA: ``Last-Modified: Tue, 20 Oct 2020 18:00:14 GMT``
- Fattura Ordinaria: ``Last-Modified: Tue, 20 Oct 2020 18:08:05 GMT``
June 2019
`````````
According to the server the schema was last modified on
``Tue, 25 Jun 2019 10:16:31 GMT``, so they fixed an offending ``xsd`` typo:
- https://www.fatturapa.gov.it/export/fatturazione/sdi/fatturapa/v1.2.1/Schema_del_file_xml_FatturaPA_versione_1.2.1.xsd
Before June 2019
````````````````
Initially the schema file was reported as incorrect by lxml because of a typo.

View File

@ -120,67 +120,18 @@ in the contributing section.
Official documentation
----------------------
======================================== ========================================================================= =======================================================================
Type Current Obsolete
======================================== ========================================================================= =======================================================================
Nomativa https://www.fatturapa.gov.it/it/norme-e-regole/normativa/ - https://www.fatturapa.gov.it/export/fatturazione/it/normativa/f-1.htm
Documentazione fatturaPA https://www.fatturapa.gov.it/it/norme-e-regole/documentazione-fatturapa/ - https://www.fatturapa.gov.it/export/fatturazione/it/normativa/f-2.htm
Documentazione Sistema d'Interscambio https://www.fatturapa.gov.it/it/norme-e-regole/DocumentazioneSDI/ - https://www.fatturapa.gov.it/export/fatturazione/it/normativa/f-3.htm
======================================== ========================================================================= =======================================================================
XML schemas for document validations
````````````````````````````````````
Most of XML schemas seem to be non-existing. Only the one for the
invoice file was found.
For sake of completeness the current supported versions
and the SHA-512 and SHA-256 checksums are reported in the following table:
========================================= ================================================================================================================ ==================================================================================================================================== ====================================================================
Name URL SHA-512 SHA-256
========================================= ================================================================================================================ ==================================================================================================================================== ====================================================================
XML schema for FatturaPA version 1.2 https://www.fatturapa.gov.it/export/documenti/fatturapa/v1.2.1/Schema_del_file_xml_FatturaPA_versione_1.2.xsd ``e1deab535099bfe9aef798c7d75a992f562c2ffa7648e446a8e1c6b894691feecba0cc9dceb02eba02243a951e1423adcac043a49bb8ab255a88b5b3ecf013d2`` ``fecdf8122fa86d80d4ab6901149a4e5390d9880c00de9987d180a2959d54c842``
XML schema for FatturaPA version 1.2.1 https://www.fatturapa.gov.it/export/documenti/fatturapa/v1.2.1/Schema_del_file_xml_FatturaPA_versione_1.2.1a.xsd ``2a7c3f2913ee390c167e41ae5618c303b481f548f9b2a8d60dddc36804ddd3ebf7cb5003e5cc6996480c67d085b82b438aff7cc0f74d7c104225449785cb575b`` ``1a14ecdc867a01f447052ff1613688deef6f88bbee522f120be060f68d251976``
========================================= ================================================================================================================ ==================================================================================================================================== ====================================================================
Updates
~~~~~~~
October 2020
............
The original URL of the schema file dissapeared.
.. image:: assets/old_link.png
:alt: Old link
A new URL points to the schema:
- https://www.fatturapa.gov.it/export/documenti/fatturapa/v1.2.1/Schema_del_file_xml_FatturaPA_versione_1.2.1a.xsd
This resource has been ``Last-Modified: Tue, 20 Oct 2020 19:29:21 GMT`` according to the HTTP headers.
.. image:: assets/page_information.png
:alt: Page information
June 2019
.........
According to the server the schema was last modified on
``Tue, 25 Jun 2019 10:16:31 GMT``, so they fixed an offending ``xsd`` typo:
- https://www.fatturapa.gov.it/export/fatturazione/sdi/fatturapa/v1.2.1/Schema_del_file_xml_FatturaPA_versione_1.2.1.xsd
Before June 2019
................
Initially the schema file was reported as incorrect by lxml because of a typo.
======================================== ========================================================================= =======================================================================
Type Current Obsolete
======================================== ========================================================================= =======================================================================
Nomativa https://www.fatturapa.gov.it/it/norme-e-regole/normativa/ - https://www.fatturapa.gov.it/export/fatturazione/it/normativa/f-1.htm
Documentazione fatturaPA https://www.fatturapa.gov.it/it/norme-e-regole/documentazione-fatturapa/ - https://www.fatturapa.gov.it/export/fatturazione/it/normativa/f-2.htm
Documentazione Sistema d'Interscambio https://www.fatturapa.gov.it/it/norme-e-regole/DocumentazioneSDI/ - https://www.fatturapa.gov.it/export/fatturazione/it/normativa/f-3.htm
======================================== ========================================================================= =======================================================================
Considerations
~~~~~~~~~~~~~~
``````````````
Not having access to all schema file is a problem since there is no way to tell if
Not having access to all schema files is a problem since there is no way to tell if
- the metadata file,
- the trusted list file,
@ -191,10 +142,12 @@ are correct and conforming to specifications.
If you find these files please let me know and/or open a pull request.
Downloading of the W3C file
~~~~~~~~~~~~~~~~~~~~~~~~~~~
```````````````````````````
The W3C schema file is a dependency for the invoice schema file and it needs to be downloaded
separately. For some reason the downloading of this file takes a few seconds.
The W3C schema file is a dependency for the invoice schema file and it needs to be cached
because the XML resolver can go in timeout.
Sometimes it takes more than one minute to download this file.
Fattura PA vs Fattura B2B
``````````````````````````

View File

@ -13,6 +13,7 @@ Welcome to fattura-pa-reader's documentation!
install
api
considerations
assets
examples
contributing
workflow