ORGF

Formato de datos abierto para estructuras organizativas y cualquier modelo jerárquico

Un formato universal y abierto para describir modelos jerárquicos, sus bloques y etiquetas. También admite una métrica y una unidad de valor para todo el modelo, con análisis digital coherente.

ESPECIFICACIÓN DEL FORMATO

El código fuente de ORGF es abierto.

Abrir en 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"

PRINCIPIOS BÁSICOS

Un formato abierto para describir, compartir e integrar modelos jerárquicos

ORGF mantiene el modelo portátil y comprensible para que pueda pasar entre personas, herramientas y sistemas sin quedar ligado a una sola interfaz.

UNIVERSALIDAD

Una lógica para cualquier jerarquía

Use el mismo formato para estructuras organizativas, catálogos, clasificadores, datos de referencia, árboles de conocimiento y otros modelos anidados, sin campos obligatorios específicos de un dominio.

LEGIBILIDAD

Un archivo YAML que las personas pueden leer

El modelo sigue siendo comprensible más allá de una interfaz: ábralo, revíselo y edítelo como una descripción significativa de la estructura.

TRANSPARENCIA

Estructura sin ID ocultos

La jerarquía se expresa directamente mediante elementos hijos, sin identificadores técnicos ni relaciones padre ocultas para el autor del modelo.

INTEGRACIÓN

Intercambie datos más allá de una interfaz

Comparta modelos con otros equipos, úselos en flujos de datos a diagrama e integre ORGF en sus propios sistemas y procesadores.

VALOR

Un modelo de valor para toda la jerarquía

Asigne un valor numérico a los bloques y una unidad al modelo; los totales se calculan a partir de la estructura para un análisis coherente.

INDEPENDENCIA

Libre para usar y desarrollar

ORGF no está ligado a un editor, cloud o plataforma de proveedor concretos. Úselo, amplíelo y cree sus propias soluciones de TI a su alrededor.

El autor del modelo define su licencia

ORGF es un formato abierto y libre. Los derechos, la licencia y los términos de un modelo concreto los declara su autor en los metadatos del modelo.