Files
chemenu/types/entity.md
T
torben c64479fe02
CI / verify (push) Successful in 45s
Release / release (push) Successful in 36s
stack: TOC-Scope auf types/ und docs/, Sprachregeln nach AGENTS.md zentralisiert, alle Templates auf Control-Plane-Sprache, --breaking akkumuliert (schliesst #99)
Files changed:
- AGENTS.md
- CHANGES.md
- ENVIRONMENT.md.template
- SOUL.md
- SOUL.md.template
- USER.md.template
- VERSION
- docs/ownership-and-templates.md
- docs/version-model.md
- instructions/CONTRACT.md
- instructions/dev/doc-pull-through.md
- instructions/dev/stack-close/SKILL.md
- instructions/dev/stack-dev/SKILL.md
- instructions/dev/version-parts.md
- instructions/setup-instance.md
- kb/CONVENTIONS.md
- kb/CONVENTIONS.md.template
- kb/concepts/COLLECTION.md
- kb/sources/COLLECTION.md
- tools/CONTRACT.md
- tools/chemenu/commands/types_cmd.py
- tools/chemenu/commands/version_cmd.py
- tools/chemenu/tests/test_toc.py
- tools/chemenu/tests/test_version_cmd.py
- tools/chemenu/toc.py
- tools/chemenu/version.py
- types/comparison.md
- types/concept.md
- types/entity.md
- types/lint-report.md
- types/source.md
2026-09-15 16:21:02 +02:00

3.9 KiB

type, name, description, schema, subtype_field, base_dir, page_ref_fields, layout
type name description schema subtype_field base_dir page_ref_fields layout
types/type-spec.md entity Base type for entity pages - projects, systems, tools, technologies or people types/entity.schema.yaml entity_type entities
related
sources
project system tool technology person
dir title
projects Projekte
dir title
systems Systeme
dir title
tools Werkzeuge
dir title
technologies Technologien
dir title
people Personen

Entity

entity is the type for concrete things: projects, systems, tools, technologies or people. Entities are the primary building blocks of the knowledge graph.

Contents

When to use

  • Representing a software project, an initiative or a piece of work
  • Documenting a running system, service or infrastructure component
  • Describing a CLI tool, utility or software library
  • Recording information about a language, a framework or a protocol
  • Documenting a person, a team or an organization

When NOT to use

  • For abstract concepts, patterns or methodologies (use concept)
  • For source documents or ingested material (use source)
  • For comparative analyses (use comparison)

Frontmatter

Field Required Use
type Yes types/entity.md
entity_type Yes One of: project, system, tool, technology, person
tags No Navigation tags for categorization
created Yes Creation date (YYYY-MM-DD)
modified Yes Date last changed (YYYY-MM-DD)
related No Titles of related pages (entities, concepts, sources)
sources No Titles of the source pages backing this page's claims
provenance Yes sourced, general or mixed
summary Yes One-liner for kb/index.md

Authoring guidance

  • The title is the entity's canonical name and follows the subject's established designation, not the KB language (kb/CONTRACT.md § "Titles are identifiers", kb/CONVENTIONS.md §§ "Naming" and "Language")
  • The main description goes near the top
  • Link to related entities and concepts wherever relationships exist
  • Under provenance: sourced or mixed, back hard facts inline with a [^cite-id] footnote - tools/wikitool cite add --page "<Title>" --source "Source - X" mints the id and its definition
  • Wikipedia register: factual, neutral, no marketing language

Template

The block below is page material, so it is written in this instance's KB language (kb/CONVENTIONS.md language:) rather than in the control plane's English - its headings become the headings of every page wikitool new entity scaffolds.

# {name}

**Typ:** {entity_type|capitalize}

## Beschreibung

TODO: 1-2 Absätze dazu, was diese Entity ist und wozu sie dient.

## Kerndaten

- **Zweck:** TODO
- **Status:** aktiv, abgelöst, in Planung usw.
- **Version:** TODO (falls zutreffend)
- **Sprache/Technik:** TODO (falls zutreffend)
- **Verantwortlich:** TODO (falls zutreffend)
- **Repository:** TODO (falls zutreffend)

## Details

TODO: Ausführliche Informationen, nach sinnvollen Abschnitten gegliedert

## Historie

- [{today}] - Page created via wikitool

The relationships section is deliberately not in the template: it is a generated region that wikitool xref creates between markers on the first edge entry and re-renders from related:. An author never writes into it. The value behind **Typ:** stays the English enum value - that is what search --field filters on.


Additional notes:

  • Entity pages form the concrete inventory of the knowledge base
  • Every entity type (project, system, tool and so on) is a variant of this base type
  • The relationships between entities carry the knowledge graph's interconnection