ORGF

Format de données ouvert pour les structures organisationnelles et tout modèle hiérarchique

Un format universel et ouvert pour décrire les modèles hiérarchiques, leurs blocs et leurs étiquettes. Il prend aussi en charge une mesure de valeur et une unité à l’échelle du modèle pour une analyse numérique cohérente.

SPÉCIFICATION DU FORMAT

Le code source d’ORGF est ouvert.

Ouvrir sur GitHub
reference:
  format: "ORGF 1.0.0"
  syntax: "YAML|UTF-8 without BOM"

  sections_fixed:
    orgformat: "string|required"
    reference: "section|optional"
    meta: "section|required"
    model: "section|optional"
    root: "block|required"
    hierarchy: "root.children[*].children[*]..."

  meta:
    title: "string|max250|optional"
    author: "string|max250|optional"
    rights_holder: "string|max250|optional"
    copyright: "string|max500|optional"
    license: "string|max120|optional"
    created: "string|optional|YYYY-MM-DD/ISO 8601"
    updated: "string|optional|YYYY-MM-DD/ISO 8601"
    status: "draft/final/archived|optional"

  model:
    name: "string|max250|optional"
    desc: "string|max1000|optional"
    value_label: "string|max80|optional|one_value_type_per_model"
    value_unit: "string|max40|optional|one_value_unit_per_model"

  block:
    name: "string|max250|optional|empty_allowed"
    desc: "string|max500|optional"
    value: "number|optional|own_value_only"
    pic: "section|optional"
    pic.set: "emoji/lucide/feather/simple-icons/iconify|required_if_pic"
    pic.name: "string|required_if_pic"
    tags: "array[string|max80]|optional|default:[]"
    hidden: "boolean|optional|default:false"
    branch_orientation: "auto/horizontal/vertical|optional|default:auto"
    style:
      fill: "default/#HEX|optional|default:default"
      contour: "default/solid/dashed/dotted/double|optional|default:default"
      contour_width: "default/regular/bold|optional|default:default"
    relation:
      line: "default/solid/dashed/dotted|optional|default:default"
      line_width: "default/regular/bold|optional|default:default"
      color: "default/#HEX|optional|default:default"
    children: "array[block]|optional|default:[]"

  authoring_rules:
    - "one_file=one_model"
    - "hierarchy=children"
    - "no_id_parent_order"
    - "empty_blocks_allowed"
    - "tags=plain_classifiers_not_key_value"
    - "desc=short_human_note_not_data_dump"
    - "style_relation=custom_overrides_only"
    - "tag_colors_not_stored_in_orgf"
    - "value_one_type_per_model"
    - "value_one_unit_per_model"
    - "value_on_block_is_own_value_only"
    - "value_totals_are_computed_not_stored"
    - "reference_if_present=complete_unmodified_canonical_copy_published_for_declared_orgformat_version_at_https://github.com/orgformat/orgf/releases"
    - "hidden=true_on_a_block_requires_hidden=true_on_every_descendant"

  normalization:
    unknown_fields: remark
    invalid_values: default
    over_limit: truncate
    invalid_yaml: reject
    invalid_structure: reject

  normalization_rules:
    - "missing_optional=default"
    - "unknown_fields=remark"
    - "invalid_values=default"
    - "over_limit=truncate"
    - "normalization=view_only_not_source_mutation"
    - "hidden_branch_inconsistency=remark_not_reject"
    - "normalization_propagates_hidden=true_to_all_descendants"

PRINCIPES FONDAMENTAUX

Un format ouvert pour décrire, partager et intégrer des modèles hiérarchiques

ORGF rend le modèle portable et compréhensible afin qu’il puisse circuler entre personnes, outils et systèmes sans être enfermé dans une seule interface.

UNIVERSALITÉ

Une même logique pour toute hiérarchie

Utilisez le même format pour les structures organisationnelles, catalogues, classifications, données de référence, arbres de connaissances et autres modèles imbriqués, sans champs obligatoires propres à un domaine.

LISIBILITÉ

Un fichier YAML lisible par les humains

Le modèle reste compréhensible au-delà d’une interface : ouvrez-le, examinez-le et modifiez-le comme une description significative de la structure.

TRANSPARENCE

Une structure sans identifiants cachés

La hiérarchie est exprimée directement par les enfants, sans identifiants techniques ni relations parentales cachées à l’auteur du modèle.

INTÉGRATION

Échanger des données au-delà d’une interface

Partagez des modèles avec d’autres équipes, utilisez-les dans des flux de données vers diagramme et intégrez ORGF à vos propres systèmes et processeurs.

VALEUR

Un modèle de valeur pour toute la hiérarchie

Définissez une valeur numérique sur les blocs et une unité pour le modèle ; les totaux sont calculés à partir de la structure pour une analyse cohérente.

INDÉPENDANCE

Libre d’utilisation et de développement

ORGF n’est lié à aucun éditeur, cloud ou plateforme fournisseur en particulier. Utilisez-le, étendez-le et construisez vos propres solutions informatiques autour de lui.

L’auteur du modèle définit sa licence

ORGF est un format ouvert et libre. Les droits, la licence et les conditions d’un modèle donné sont déclarés par son auteur dans les métadonnées du modèle.