openadom
  • Accueil
  • Installation
  • Fichier d’example
  • Lexique
  • A propos
  1. Fichiers d’échange
  2. Aide fichier
  • Introduction
    • Introduction
    • Vocabulaire
    • Fichier d’échange
  • Fichiers d’échange
    • Aide fichier
    • Application (OA_application)
    • Etiquettes (OA_tags)
    • Données (OA_data)
      • Components
        • introduction
        • Basic Components
        • Computed Components
        • Dynamic Components
        • Constant Components
        • Pattern Components
        • Paramétrage des composants
        • Verificateurs
        • Validations
        • Dépôt de fichier (OA_submission)
        • Autorisations (OA_autorisations)
      • Fichier additionnels
      • Formulaire de demande de droits
  • Pour aller plus loin
    • Glossaire
    • Authorization
    • Component Qualifiers
    • Expression Groovy
    • Internationalisation i18n
    • Submission
  • Base de données
    • Introduction
  • En réflexion
    • Verificateurs
    • Clefs étrangères
  • Exemples
    • Fichier de configuration minimale
    • Composantes
      • Example d’utilisation des composants
      • Example d’utilisation des composantes dynamiques(sites)
      • Example d’utilisation des composantes dynamiques (taxons)
      • Example d’utilisation des composantes basiques

Sur cette page

  • La création :
  • Modifier cette page
  • Voir la source
  • Faire part d'un problème
  1. Fichiers d’échange
  2. Aide fichier

Rédaction du fichier de configuration

Date de publication

07 mai 2025

Résumé

Vous trouverez ci-dessous des exemples décrivant les parties attendues dans le fichier de configuration pour qu’il soit valide.

La création :

Vous trouverez ci-dessous des exemples décrivant les parties attendues dans le fichier de configuration pour qu’il soit valide.

Attention le format Yaml est sensible, il faut donc respecter l’indentation.

Il y a 6 parties (sans indentation) attendues dans le fichier :

  • OA_version
OA_version

Cela détermine la version du moteur openADOM charger de lire le fichier de configuration. En cas de version incompatible avec celle du moteur une erreur sera renvoyée.

Actuellement la version du navigateur est la version 2.0.1

  • Application (OA_application),
  • OA_data,
  • OA_tags,
  • OA_rightsRequest

prochaine release
  • OA_additionalFiles

l’indentation du fichier yaml est très importante.

Afin de faciliter l’écriture du fichier de configuration, nous avons mit : * soit “OA_” devant des noms réservés (ex : “OA_version”) * soit les noms réservés sont en MAJUSCULE (ex : “__ REFERENCE __“)

Retour au sommet
Fichier d’échange
Application (OA_application)
Code source
---
    title: Rédaction du fichier de configuration
            
    abstract: >
        Vous trouverez ci-dessous des exemples décrivant les parties attendues dans le fichier de configuration pour qu'il
        soit valide. 
---

# <a id="creation" />La création :

Vous trouverez ci-dessous des exemples décrivant les parties attendues dans le fichier de configuration pour qu'il
soit valide. 

**Attention le format Yaml est sensible,** il faut donc respecter l'indentation.

Il y a 6 parties (<span style="color: orange">sans indentation</span>) attendues dans le fichier :

* OA_version

::: {.callout-tip title="OA_version" collapse="true" #openadom_version}
Cela détermine la version du moteur openADOM charger de lire le fichier de configuration. En cas de version incompatible avec celle du moteur une erreur sera renvoyée.

Actuellement la version du navigateur est la version {{<var openadom.version>}}
:::

* {{<var page-refs.application.link>}},
* {{<var page-refs.data.oa>}},
* {{<var page-refs.etiquettes.oa>}},
* {{<var page-refs.rightsRequest.oa>}}

::: {.callout-caution collapse="true" title="prochaine release"}

* {{<var page-refs.additionalFiles.oa>}}
:::

<span style="color:orange">l'indentation du fichier yaml est très importante.</span>

Afin de faciliter l'écriture du fichier de configuration, nous avons mit : 
* soit "OA_" devant des noms réservés (ex : "OA_version")
* soit les noms réservés sont en MAJUSCULE (ex : "__ REFERENCE __")

Copyright 2025, OpenADOM

 
  • Modifier cette page
  • Voir la source
  • Faire part d'un problème