Textes d’aide à l’édition dans les blocs du catalogue

6 décembre 2022

Il est maintenant possible d’ajouter des textes d’aide à l’édition pour les blocs.

Les textes peuvent être en markdown.

On peut soit :

les renseigner directement dans le code du composant
les renseigner sur le template de métadonnées

Ajouter un texte d’aide à l’intérieur d’un composant

Passer la prop editionTooltip dans le code via <aeris-metadata-dialog-layout> :

<!-- dans un composant de bloc -->
<!-- ... -->
<aeris-metadata-dialog-layout
  :language="language"
  v-if="canDisplayEditionForm"
  max-width="400px"
  :is-displaying-dialog="isDisplayingDialogEditionForm"
  :disable-save-button="!isFormValid"
  :title="$t('editDOI')"
  :editionTooltip_en="editionTooltip_en"
  :editionTooltip_fr="editionTooltip_fr"
  :editionTooltip="{
    en: 'This is the english tooltip provided by the developer',
    fr: 'aide en français renseignée par le développeur'
  }"
>
<!-- ... -->
</aeris-metadata-dialog-layout>

Ajouter un texte d’aide à l’édition via le template

Renseigner les champs editionTooltip_en et editionTooltip_fr dans les props du bloc concerné :

      "metadataTab": [
        {
          "name": "aeris-metadata-alert",
          "editable": true,
          "props": {}
        },
        {
          "name": "aeris-metadata-title",
          "editable": true,
          "props": {
            "editionTooltip_en": "Corresponds to the title of the data set (English/French version).<br/>Fill in the « English » tab with an English title, and optionally fill in the « Français » tab with a French title.",
            "editionTooltip_fr": "Correspond au titre du jeu de données (version english/french).<br/>Remplir l’onglet « English » en priorité avec un titre en anglais, éventuellement remplir aussi l’onglet « French » avec un titre en français."
          }
        },

NB : cela écrasera le texte par défaut qui a été défini directement dans le code.

Ajouter un texte d’aide à l’intérieur d’un composant

Ajouter un texte d’aide à l’édition via le template

Exemple de texte d’aide dans un bloc

Rechercher