Skip to content

Commit

Permalink
Update user and installation guides regarding archive format validation
Browse files Browse the repository at this point in the history
ARKADE-570
  • Loading branch information
jtellnes committed Mar 21, 2022
1 parent 35ac95d commit 618e927
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 19 deletions.
23 changes: 22 additions & 1 deletion Brukerveiledning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,9 @@ Menyvalg
| Åpner hjemmesiden til Arkade i standard nettleser.
| |menuItem_tools| **- Verktøy**
| Åpner et nytt vindu med tilleggsverktøy for Arkade. I gjeldende versjon er det eneste tilgjengelige tilleggsverktøyet PRONOM-filanalyse av en valgt katalog.
| Åpner et nytt vindu med tilleggsverktøy for Arkade:
| - PRONOM-filanalyse av en valgt katalog.
| - Validering av arkivformat for en valgt fil.

Innlastingsvinduet
Expand Down Expand Up @@ -327,6 +329,25 @@ Kommandoen under ufører PRONOM filformat-analyse på alt innhold i katalogen so
| :code:`--output-filename`/:code:`-O` (stor O)
| :code:`--language`/:code:`-l` - `Velg hvilket språk <#sprak-language-l>`_ filer som blir generert av Arkade skal ha.
:command:`validate` - Utfør validering
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Kommandoen validerer en fil oppgitt med parameteren :code:`--item`/:code:`-i` mot et gyldig arkivformat oppgitt med parameteren :code:`--format`/:code:`-f`. Resultatet vises på skjermen.

Støttede formater
* PDF/A

Eksempel:

.. code-block:: bash
arkade validate -i ~/N5-arkivuttrekk/dokumenter/dokument.pdf -f PDF/A
| *Obligatoriske parametre ved validering:*
| :code:`--item`/:code:`-i` - Oppgi stien til filen som skal valideres.
| :code:`--format`/:code:`-f` - Oppgi arkivformatet som filen skal valideres mot.

Resulterende data
^^^^^^^^^^^^^^^^^
:command:`process` og :command:`pack` kommandoene produserer en arkivpakke som en tar-fil, med tilhørende :file:`\{uuid\\\}.xml` på METS-format, samlet i en katalog. :command:`process` produserer i tillegg testrapport på HTML, PDF/A-1b, XML og JSON-format; rapporten plasseres i en egen katalog ved siden av pakken. Dersom man kjører :command:`test` lagres rapportene i en katalog på oppgitt lokasjon.
Expand Down
58 changes: 40 additions & 18 deletions Installasjonsveiledning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,25 +48,29 @@ Aktiver støtte for validering av SIARD-2.1-filer

For at Arkade skal støtte bruk av verktøyet |database_preservation_toolkit_link| for validering av Siard-filer må følgende instruksjoner utføres:

Installer Java Runtime Environment
----------------------------------
* Last ned installasjonsfil for Java Runtime Environment (JRE) fra |java_download_link|
* Installer JRE ved å dobbeltklikke den nedlastede filen
* Installer Java Runtime Environment (`hjelp <Installasjonsveiledning.html#jre-info>`_)

Tilgjengeligjør DBPTK Developer for Arkade
------------------------------------------
* Last ned :download:`dbptk-app-2.9.9.jar <https://github.com/keeps/dbptk-developer/releases/download/v2.9.9/dbptk-app-2.9.9.jar>`
* Lagre den nedlastede filen under :file:`<arkadeinstallasjonsmappe>/ThirdPartySoftware/DBPTK/`.
* Tilgjengeligjør DBPTK Developer for Arkade

- Last ned :download:`dbptk-app-2.9.9.jar <https://github.com/keeps/dbptk-developer/releases/download/v2.9.9/dbptk-app-2.9.9.jar>`
- Lagre den nedlastede filen under :file:`<arkadeinstallasjonsmappe>/ThirdPartySoftware/DBPTK/`.

.. image:: img/dbptk_save_location.png

.. |database_preservation_toolkit_link| raw:: html

<a href="https://database-preservation.com/#developer" target="_blank">Database Preservation Toolkit Developer (DBPTK Developer)</a>

.. |java_download_link| raw:: html

<a href="https://java.com/en/download/" target="_blank" >https://java.com/en/download/</a>


Aktiver støtte for validering av PDF/A
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

For å kunne validere PDF/A-filer må Java Runtime Environment være installert:


* Installer Java Runtime Environment (`hjelp <Installasjonsveiledning.html#jre-info>`_)


Kjør programmet
Expand Down Expand Up @@ -198,19 +202,24 @@ Aktiver støtte for validering av SIARD-2.1-filer

For at Arkade skal støtte bruk av verktøyet |database_preservation_toolkit_link| for validering av Siard-filer må følgende instruksjoner utføres:

Installer Java Runtime Environment
----------------------------------
* Last ned installasjonsfil for Java Runtime Environment (JRE) fra |java_download_link|
* Installer JRE ved å dobbeltklikke den nedlastede filen
* Installer Java Runtime Environment (`hjelp <Installasjonsveiledning.html#jre-info>`_)

* Tilgjengeligjør DBPTK Developer for Arkade

Tilgjengeligjør DBPTK Developer for Arkade
------------------------------------------
* Last ned :download:`dbptk-app-2.9.9.jar <https://github.com/keeps/dbptk-developer/releases/download/v2.9.9/dbptk-app-2.9.9.jar>`
* Lagre den nedlastede filen under :file:`<arkadeinstallasjonsmappe>/ThirdPartySoftware/DBPTK/`.
- Last ned :download:`dbptk-app-2.9.9.jar <https://github.com/keeps/dbptk-developer/releases/download/v2.9.9/dbptk-app-2.9.9.jar>`
- Lagre den nedlastede filen under :file:`<arkadeinstallasjonsmappe>/ThirdPartySoftware/DBPTK/`.

.. image:: img/dbptk_save_location.png


Aktiver støtte for validering av PDF/A
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

For å kunne validere PDF/A-filer må Java Runtime Environment være installert:

* Installer Java Runtime Environment (`hjelp <Installasjonsveiledning.html#jre-info>`_)


Kjør Arkade 5 CLI
~~~~~~~~~~~~~~~~~

Expand All @@ -228,3 +237,16 @@ Avinstaller Arkade 5 CLI
* **Windows:** Åpne ledetekst som administrator og kjør :code:`del C:\Windows\arkade.bat`

*Mindre enn 1 uke gamle system- og feillogger slettes ikke automatisk etter kjøring.* `Les mer ... <Brukerveiledning.html#prosesseringsomrade-cli>`_



.. tip:: Installer Java Runtime Environment
:name: jre-info

* Last ned installasjonsfil for JRE fra |java_download_link|
* Installer JRE ved å dobbeltklikke den nedlastede filen


.. |java_download_link| raw:: html

<a href="https://java.com/en/download/" target="_blank" >https://java.com/en/download/</a>
Binary file modified img/cli/commands.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 618e927

Please sign in to comment.