Section de description de l’application

OA_application

Date de publication

07 mai 2025

Résumé

Cette section définit un certain nombre d’informations et de paramètres de l’ensemble du système d’information

Sections attendues

Sections obligatoires

OA_name
OA_version

Sections facultatives

OA_i18n
OA_comment
OA_defaultLanguage

example de section application

OA_application:
    OA_defaultLanguage: fr
    OA_i18n:
        OA_title:
            fr: "ACBB"
            en: "ACBB"
        OA_description:
            fr: "Agroécosystèmes, Cycles Biogéochimiques et Biodiversité"
            en: "Agroecosystems, Biogeochemical Cycles and Biodiversity"
    OA_comment: "L'application ACBB V2"
    OA_name: acbb_openadom_v2
    OA_version: 1.0.5

Cette section doit comporter obligatoirement:

1 OA_name le nom de l’application qui correspondra au nom du schema de la base de données.

Note

       OA_name: acbb_openadom_v2

Ce nom doit obligatoirement être en minuscules, commencer par une lettre et ne comporter que des caractères alphanumériques sans accent et l’espace souligné. (_)

2 OA_version qui correspond à la version du fichier de configuration. Lors des mise à jour du schéma, vous incrémenterez ce numéro de version.

Note

       OA_version: 1.0.5

Exemple de numérotation

Versions Majeures

2.4.0
2.4.1
2.3.5
2.0.0
3.0.0
1.11.2
1.10.0
1.9.0

Versions de Développement

2.4.0-SNAPSHOT
2.3.5-SNAPSHOT
2.0.0-rc.3
2.0.0-b.2
2.0.0-a.1

Versions avec Métadonnées

1.2.3+20231006
1.2.0+build.123

Versions de Maintenance

1.2.5
1.2.3

On peut aussi rajouter des informations facultatives:

OA_defaultLanguage qui permet de définir la langue par défaut. La langue par défaut est celle utilisée si aucune autre information de langue n’est précisée. Lors de l’internationalisation de certains champs / données, on essait de trouver la traduction dans la langue demandée; à défaut on fournit la traduction dans la langue par défaut; si aucune traduction n’est trouvée on renvoit l’indentificateur fourni en entrée.

Note

       OA_defaultLanguage: fr

OA_i18n cette section permet d’internationaliser le nom de l’application en fournissant un titre et / ou une description à ce nom.

Note

        OA_i18n:
            OA_title:
                fr: "ACBB"
                en: "ACBB"
            OA_description:
                fr: "Agroécosystèmes, Cycles Biogéochimiques et Biodiversité"
                en: "Agroecosystems, Biogeochemical Cycles and

OA_comment C’est un commentaire, que vous pouvez remplir à votre guise pour vous permettre d’indiquer les modifications de version en version.

Note

    OA_comment: >
        Ceci est un 
        commentaire sur
        plusieurs lignes

    OA_comment: "ceci est un commentaire entre quotes"

Retour au sommet

--- title: Section de description de l'application subtitle: OA_application abstract: > Cette section définit un certain nombre d'informations et de paramètres de l'ensemble du système d'information mandatories: OA_version, sections: mandatory: - OA_name - OA_version optional: - OA_i18n - OA_comment - OA_defaultLanguage --- ::: {.callout-note title="example de section application" collapse="false"} ``` yaml OA_application: OA_defaultLanguage: fr OA_i18n: OA_title: fr: "ACBB" en: "ACBB" OA_description: fr: "Agroécosystèmes, Cycles Biogéochimiques et Biodiversité" en: "Agroecosystems, Biogeochemical Cycles and Biodiversity" OA_comment: "L'application ACBB V2" OA_name: acbb_openadom_v2 OA_version: 1.0.5 ``` ::: Cette section doit comporter obligatoirement: 1 **OA_name** le nom de l'application qui correspondra au nom du schema de la base de données. :::{.callout-note collapse="false" #name title=""} ``` yaml OA_name: acbb_openadom_v2 ``` ::: Ce nom doit obligatoirement être en minuscules, commencer par une lettre et ne comporter que des caractères alphanumériques sans accent et l'espace souligné. (_) 2 [**OA_version**]{#version} qui correspond à la version du fichier de configuration. Lors des mise à jour du schéma, vous incrémenterez ce numéro de version. :::{.callout-note collapse="false" title="" } ``` yaml OA_version: 1.0.5 ``` ::: ::: {.callout-note collapse="true" title="Exemple de numérotation" } ### Versions Majeures - 2.4.0 - 2.4.1 - 2.3.5 - 2.0.0 - 3.0.0 - 1.11.2 - 1.10.0 - 1.9.0 ### Versions de Développement - 2.4.0-SNAPSHOT - 2.3.5-SNAPSHOT - 2.0.0-rc.3 - 2.0.0-b.2 - 2.0.0-a.1 ### Versions avec Métadonnées - 1.2.3+20231006 - 1.2.0+build.123 ### Versions de Maintenance - 1.2.5 - 1.2.3 ::: On peut aussi rajouter des informations facultatives: 1. **OA_defaultLanguage** qui permet de définir la langue par défaut. La langue par défaut est celle utilisée si aucune autre information de langue n'est précisée. Lors de l'internationalisation de certains champs / données, on essait de trouver la traduction dans la langue demandée; à défaut on fournit la traduction dans la langue par défaut; si aucune traduction n'est trouvée on renvoit l'indentificateur fourni en entrée. :::{.callout-note collapse="false" title="" #defaultLanguage} ``` yaml OA_defaultLanguage: fr ``` ::: 2. **OA_i18n** cette section permet d'internationaliser le nom de l'application en fournissant un titre et / ou une description à ce nom. :::{.callout-note collapse="false" title="" #i18n} ``` yaml OA_i18n: OA_title: fr: "ACBB" en: "ACBB" OA_description: fr: "Agroécosystèmes, Cycles Biogéochimiques et Biodiversité" en: "Agroecosystems, Biogeochemical Cycles and ``` ::: ![rendu en français](/img/application_fr.png){height="100" .lightbox} ![rendu en anglais](/img/application-en.png){height="100" .lightbox} 3. **OA_comment** C'est un commentaire, que vous pouvez remplir à votre guise pour vous permettre d'indiquer les modifications de version en version. :::{.callout-note collapse="false" title="" #comment} ``` yaml OA_comment: > Ceci est un commentaire sur plusieurs lignes ``` ``` yaml OA_comment: "ceci est un commentaire entre quotes" ``` :::