Cyclium.Terminology (Cyclium v0.2.0)

Copy Markdown View Source

Provides configurable display labels for rendered logs and UI text.

Consuming applications can override default terminology via application config:

config :cyclium, :terminology, %{
  episode: "Cascade",
  finding: "Insight",
  raised: "created",
  completed: "resolved"
}

Unconfigured keys fall back to built-in defaults. Database values and schema atoms are never affected — this is purely for rendered display text.

Summary

Functions

format(concept, action)

Combines a concept label and an action label into a display string.

label(key)

Returns the display label for a terminology key.

Functions

format(concept, action)

Combines a concept label and an action label into a display string.

iex> Cyclium.Terminology.format(:finding, :raised)
"Finding raised"

With config %{finding: "Insight", raised: "created"}:

iex> Cyclium.Terminology.format(:finding, :raised)
"Insight created"

label(key)

Returns the display label for a terminology key.

Falls back to the built-in default, then to stringifying the key.