Modèle Studio

Identifiant de spécification courante

SKOP_TEMPLATE_DECL#1.0

Données

{
  "name": <i18n>,
  "subtitle": <i18n>,
  "projectTitle": "<title>",
  "media": ["<media_1_id>", "<media_2_id>", ...],
  "theme": ["<theme_1_id>", "<theme_2_id>", ...],
  "modules": [
    <module_1>,
    <module_2>,
    ...
  ],
  "data": [
    <data_1>,
    <data_2>,
    ...
  ],
  "assistant": {
    "beforeSend": [
      <operation_1>,
      <operation_2>,
      ...
    ],
    steps: [
      <data_step_definition_1>,
      <data_step_definition_2>,
      ...
    ]
  },
  "summary": [
    <summary_item_1>,
    <summary_item_2>,
    ...
  ]
}

• name : le nom du modèle, présenté dans la liste des modèles proposés à l’utilisateur
• subtitle : un sous-titre optionnel, présenté dans la liste des modèles proposés à l’utilisateur
• projectTitle : le titre du projet généré à partir de l'assistant ; la chaîne peut contenir des substitutions encadrées par ${...}, par exemple : "${media:issue.title}" pour générer un titre à partir du titre de l'anomalie saisi par l'utilisateur
• media : une liste d’identifiants de médias, correspondant aux médias compatibles pouvant être utilisés pour la transmission des informations saisies dans l’assistant par l’utilisateur
• theme : une liste d’identifiants de thèmes, correspondant aux thèmes compatibles pouvant être utilisés pour la génération du contenu final
• modules : décrit les modules utilisés par l'assistant,
• data : décrit les données récoltées par l'assistant
• assistant : description complète de l’assistant affiché à l’utilisateur pour qu’il saisisse les données
• summary : décrit les informations à afficher dans le résumé du projet

Champ data

Décrit les données récoltées par l'assistant.

{
  "id": "<id>",
  "store": "media" | "module" | "local",
  "type": "<data type>",
  "nature": "<nature>",
  "name": <i18n>,
  "required": true | false,
  "readOnly": true | false | "ifInitialDataProvided",
  "defaultValue": <value>,
  "choices": [
    {
      "label": <i18n>,
      "value": "<value>"
    },
    ...
  ],
  "editorParams": {
    // Si l'éditeur est text/file
    "canBeLocal": true | false,
    "canBeRemote": true | false,
    "onSelection": "<TODO>"
    ///

    // Si l'éditeur est json/equipments</span>
    "mediaTag": "<media_tag>",
    "category": "<category_id>",
    "subCategories": [
      "<sub_category_id_1>",
      "<sub_category_id_2>",
      ...
    ],
    "i18n": {
      "emptyList": <i18n>,
      "selectTitle": <i18n>,
      "selectInvite": <i18n>,
      "createTitle": <i18n>,
      "modifyTitle": <i18n>,
      "subCategory_<sub_category_1>": <i18n>,
      "subCategory_<sub_category_2>": <i18n>,
      ...
    },
    "emptyLabel": <i18n>
    ///

    // Si l'éditeur est json/content_sequence
    "moduleVariableTitle": "<variable>",
    "moduleVariableContent": "<variable>"
    ///
  }
}

Champ modules

Décrit les modules utilisés dans les données.

{
  "id": "<id>",
  "multiple": true | false,
  "name": <i18n
}

Champ assistant