Entities

A project declares its own entity types in a schema file, and the build then treats them as first-class constructs: parsed, validated, indexed project-wide, cross-referenceable and rendered. See entities.toml beside this document for the meta-model these pages use.

• Requirements
  • An entity with every kind of declaration
  • Attribute defaults and a generated id
  • Specifications and implementations
  • A one-directional relation and a required one
  • Referring to entities from prose
• Audit events
• Listing entities
  • Every entity in the project
  • Choosing columns
  • Filtering
  • Sorting and layout
• Charting the graph
  • Counting by type
  • A legend and colours of your own
  • Scoping a whole chart once
  • Numbers written outright
  • Bar charts
  • When nothing matches
• Importing from sphinx-needs
  • Importing a whole file
  • Imported entities are ordinary entities
  • Importing by name
  • Choosing a version
  • Narrowing what is imported
  • Ids the project does not own
  • Tagging an import
  • What is not supported
• Updating entities after the fact
  • Targeting a single id, appending and removing a tag
  • Targeting a filter, setting a field on every match at once
  • Appending and removing a relation target
  • A target matching nothing
  • Rejected mutations
  • A conflicting pair
• Diagrams over the entity graph
  • Drawing what a filter selects
  • Reading one entity's fields
  • Extra values
  • An architecture diagram inside an entity
  • Importing another entity's diagram
  • Named PlantUML preambles
  • Flowcharts of the graph itself
  • Sequence diagrams of the graph