# orca.ui.terms

> A module of morca's API.

What the UI's words mean, in one place: the help on every table's column headers, and on the values that come from a fixed set (statuses, step kinds, triggers, placements, where a setting came from), so the same word has the same explanation on every page.

```
header_help("Attempts")           # the "?" of a column named Attempts
header_help("From", "config")     # a column whose meaning depends on its table
value_help("status", "deferred")  # what a status chip says on hover
```

The UI (`orca.web.page.respond`) adds a header's help to every `<th>` it
finds one for (a `data-help` attribute names a table-specific one), and
`Html.status` and `Html.term` put a value's on its chip or word. Texts are
HTML, written here as `if` chains (`_header`, `_context_header`, `_value`, `_key`), so
they may hold entities; none holds data from a request or a double quote,
as a value's goes in an attribute. An empty text means no help.

## Functions

### `key_help`

```mojo
def key_help(key: StringSpan) -> StaticString
```

The help of a setting `key` of orca.toml (`env.NAME` is `env`'s).

### `header_help`

```mojo
def header_help(label: StringSpan, table: StringSpan = "") -> StaticString
```

The help of a column named `label`, in `table` if it has its own.

### `value_help`

```mojo
def value_help(kind: StringSpan, value: StringSpan) -> StaticString
```

The help of `value` of `kind` (`status`, `kind`, `trigger`, `placement`, `from`, `touch`, `role`, `fills`, `fill_order`, `spot`): a placement `worker:<pool>` is `worker`'s.

## Aliases

### `COVERAGE_HELP`

```mojo
comptime COVERAGE_HELP = "How much of the pipeline is done: its days or months done of those in its range so far (its first partition through the last that has ended), or a keyed pipeline's keys done of the keys its dataset has. Done means every step succeeded in a run of its current code, as on the calendar; failed, skipped, queued and running ones aren't. A dash means it has none to count yet."
```

The help of a pipeline's Coverage, in the home page's table and on its Progress card.