Package
| Name (singular): | Package |
| Name (plural): | Packages |
| Alias (uri): | package |
| Identifier (ID): | cerberusweb.contexts.package.library |
Records API
These fields are available in the Records API and packages:
| Req'd | Field | Type | Notes |
|---|---|---|---|
description |
text | A description of this library package's contents | |
image |
image | The library tile art. Either an image base64-encoded in data URI format, or an art spec naming a Cerb icon and its colors | |
links |
links | An array of record type:id tuples to link to. Prefix with - to unlink. |
|
| x | name |
text | The name of this package |
| x | package_json |
text | |
| x | point |
text | The library section containing this package |
updated_at |
timestamp | The date/time when this record was last modified | |
| x | uri |
text | The unique identifier of this package |
Tile art
A package's image can name a Cerb icon and the colors it's painted in, instead of carrying an embedded image. That's how a package tile in the library, and in the Add-tab and Add-widget choosers, can match the thing it installs.
An art spec is up to three space-delimited words:
<icon> [background] [foreground]| Written | Result |
|---|---|
todo |
The icon on a neutral gray |
todo #7f7f7f |
The icon on the background you named |
todo #7f7f7f #ffffff |
Both the background and the glyph color |
todo auto #d62728 |
A glyph color with the background left at default |
todo #eeeeee:#333333 |
One background in the light theme, another in dark |
A color is #rgb or #rrggbb. Either color can be a light:dark pair, and a color with no pair is used in both themes. The word auto holds a slot at its default, which is how you set a foreground without pinning a background.
Anything unusable falls back on its own slot's default, so an unrecognized icon name still lets your colors through and a malformed color still lets your icon through. The default background is a neutral gray that follows the theme, and the default glyph color is whichever of near-black or white reads better on the background behind it.
Dictionary Placeholders
These placeholders are available in dictionaries for automations, snippets, and API responses:
| Field | Type | Description |
|---|---|---|
_context |
text | Record type extension ID |
_label |
text | Label |
_type |
text | Record type alias |
description |
text | Description |
id |
number | Id |
name |
text | Name |
point |
text | Extension Point |
record_url |
text | Record Url |
updated_at |
date | Updated |
uri |
text | Uri |
These optional placeholders are also available with key expansion in dictionaries and the API:
| Field | Type | Description |
|---|---|---|
comment_count |
number | Comment count on the record |
comments |
comments | Comments |
links |
links | Links |
Search Query Fields
These filters are available in package search queries:
| Field | Type | Description |
|---|---|---|
description: |
text | Description |
fieldset: |
record | Fieldset |
id: |
number | Id |
links: |
links | Record Links |
name: |
text | Name |
point: |
text | Extension Point |
updated: |
date | Updated |
uri: |
text | Uri |
Worklist Columns
These columns are available on package worklists:
| Column | Description |
|---|---|
p_description |
Description |
p_id |
Id |
p_name |
Name |
p_point |
Extension Point |
p_updated_at |
Updated |
p_uri |
Uri |