DocumentationQualityStandard-template.json

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "../Documentation/Implementation/data_model/Json/",
    "title": "DocumentationQualityStandard",
    "description": "DocumentationQualityStandard template",
    "type": "object",
    "class": "DocumentationQualityStandard",
    "properties": {
        "description": {
            "type": "string",
            "description": "Description générale concernant la documentation et les méthodes qualité appliquées aux données",
            "inputType": "textarea",
            "label@fr_FR": "Description",
            "label@en_GB": "Description",
            "tooltip@fr_FR": "Indiquer par exemple : la convention de nommage des fichiers et leur organisation, les normes, standards de métadonnées et vocabulaires utilisés pour décrire les données, le contrôle des versions des jeux de données, le dictionnaire de données associé au fichier explicitant les variables",
            "tooltip@en_GB": "Indicate for example: the naming convention of the files and their organization, the norms, metadata standards and vocabularies used to describe the data, the version control of the datasets, the data dictionary associated with the file explaining the variables",
            "form_label@fr_FR": "Décrire l'organisation, la structuration et la documentation des données",
            "form_label@en_GB": "Describe data organization, structuration and  documentation"
        },
        "dataOrganizationReference": {
            "type": "array",
            "table_header": null,
            "items": {
                "type": "object",
                "class": "ResourceReferenceStandard",
                "properties": {
                    "dbid": {
                        "type": "number"
                    }
                },
                "template_name": "DataOrganizationReference",
                "required": [
                    "dbid"
                ]
            },
            "description": "Références des resources produites pour la structuration des données (ex. dictionnaire de données, modèle de données, organisation des répertoire, …)",
            "label@fr_FR": "Références associées",
            "label@en_GB": "Related references",
            "tooltip": null,
            "form_label@fr_FR": "Indiquer le ou les documents en lien avec l'organisation des données",
            "form_label@en_GB": "Indicate the document(s) related to the organization of the data"
        },
        "metadataStandard": {
            "type": "array",
            "table_header@fr_FR": "Nom du standard",
            "table_header@en_GB": "Standard name",
            "items": {
                "type": "object",
                "class": "MetadataStandard",
                "properties": {
                    "dbid": {
                        "type": "number"
                    }
                },
                "template_name": "MetadataStandardStandard",
                "required": [
                    "dbid"
                ]
            },
            "description": "Standard(s) de métadonnées ou données utilisé(s) en application des principes FAIR",
            "label@fr_FR": "Standards de métadonnées/données",
            "label@en_GB": "Metadata/data standards",
            "inputType": "dropdown",
            "registries": [
                "Standards"
            ],
            "overridable": true,
            "tooltip": null,
            "form_label@fr_FR": "Lister les standards de métadonnées/données utilisés",
            "form_label@en_GB": "List the metadata/data standards used"
        },
        "metadataLanguage": {
            "type": "string",
            "length": "3",
            "description": "Code langue des métadonnées",
            "inputType": "dropdown",
            "label@fr_FR": "Code langue des métadonnées",
            "label@en_GB": "Metadata language code",
            "registries": [
                "ISO639-3"
            ],
            "tooltip@fr_FR": "Code de la langue des métadonnées, annotations",
            "tooltip@en_GB": "Language code of metadata or annotation",
            "form_label@fr_FR": "Code langue des métadonnées",
            "form_label@en_GB": "Metadata language code"
        },
        "documentationSoftware": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "description": "Outil choisi pour saisir les métadonnées et documentation",
            "inputType": "dropdown",
            "label@fr_FR": "Logiciel de documentation",
            "label@en_GB": "Documentation software",
            "registries": [
                "MetadataTools"
            ],
            "overridable": true,
            "tooltip@fr_FR": "Logiciels/outils utilisés pour la saisie des métadonnées comme par exemple Morpho pour le standard de métadonnées EML (pour en savoir plus : consulter l’onglet « A propos des réferentiels »)",
            "tooltip@en_GB": "Software/tools used for entering metadata, such as Morpho for the EML metadata standard (for more information: see “About registries”",
            "example@fr_FR": "Morpho, Metacat, OMERO, SEEKS, DdiEditor, ...",
            "example@en_GB": "Morpho, Metacat, OMERO, SEEKS, DdiEditor, ...",
            "form_label@fr_FR": "Logiciel de documentation",
            "form_label@en_GB": "Documentation software"
        },
        "contributor": {
            "type": "array",
            "table_header@fr_FR": "Nom",
            "table_header@en_GB": "Name",
            "items": {
                "type": "object",
                "class": "Contributor",
                "properties": {
                    "dbid": {
                        "type": "number"
                    }
                },
                "template_name": "ContributorStandard",
                "required": [
                    "dbid"
                ]
            },
            "description": "Personne(s) impliquée(s) dans la documentation des données et/ou production des métadonnées",
            "label@fr_FR": "Personnes impliquées dans la documentation des données",
            "label@en_GB": "Data documentation managers",
            "tooltip@fr_FR": "Le responsable peut être une personne, une équipe, un service",
            "tooltip@en_GB": "Person in charge can be a person, a team, a department",
            "form_label@fr_FR": "Personnes impliquées dans la documentation des données",
            "form_label@en_GB": "Data documentation managers"
        },
        "cost": {
            "type": "array",
            "table_header@fr_FR": "Type de coût : montant",
            "table_header@en_GB": "Cost type: amount",
            "items": {
                "type": "object",
                "class": "Cost",
                "properties": {
                    "dbid": {
                        "type": "number"
                    }
                },
                "template_name": "CostStandard",
                "required": [
                    "dbid"
                ]
            },
            "description": "Côuts éventuels en terme de ressources humaines ou acquisition de logiciels pour la documentation des données",
            "label@fr_FR": "Coûts",
            "label@en_GB": "Costs",
            "tooltip": null,
            "form_label@fr_FR": "Coûts liés à la documentation",
            "form_label@en_GB": "Documentation related costs"
        }
    },
    "required": [
        "description",
        "metadataLanguage"
    ],
    "to_string": []
}