us.polhem.skywrite.defs

Details · defs
Kinddefs
Authorityskywrite.polhem.us
Commit rev3n2s64dapv522
Indexed

Showing version bafyreiak2x4djawzuhsfipjhdfytbjm6m6i57ps54i5mlbitvfcqiwoqqu. Show the latest

#customColumn

object

A table column whose value is worked out for each record, like a preview field.

Properties

name

requiredstring

The column's heading, and its name in tableColumnFields. Must differ from the collection's own fields.

  • minLength: 1
  • maxLength: 640
  • maxGraphemes: 64

#fieldParts

object

A value computed by a chain of steps: each step receives the previous step's result, starting from the record.

Properties

parts

requiredarray
itemsunion

#fieldPath

object

A value read from the input: a field path such as 'title' or 'subject.uri', or a lookup function: getRecord() (AT URI to record), describeRepo() (handle, DID, AT URI or record to its repo's DID and handle), getBskyProfile() (handle, DID, AT URI or record to that account's Bluesky profile record), getUri() (record to its AT URI) or getRkey() (record to its record key). A blob read from a record becomes its URL.

Properties

path

requiredstring

Field path or lookup function name.

#fieldTemplate

object

A value rendered from a Mustache template. The template can use the record's fields, plus any variables defined in vars.

Properties

template

requiredstring

Mustache template, such as '{{name}} ({{slug}})'.

vars

array

Extra template variables, each computed from the record.

itemsref
Reference

#previewFields

object

Which parts of a record to show when previewing it in a list.

#quickCompose

object

What a Quick Compose box asks for when writing a new record in a collection. Taken whole: with these settings saved, nothing is guessed from the lexicon. Required properties the box can't fill in itself are always asked for.

Properties

body

string

Older settings: where the text is written. Absent: chosen from 'fields'.

  • maxLength: 640

defaults

unknown

Values the box starts with, by field name, for fields it asks for: any value the field can hold, such as a document's 'site' or a post's 'tags'.

fields

array

The fields the box asks for, taken from the collection's editor fields. They're shown in the order the editor has them. The text goes in the first rich text field (or text field such as 'text') among them, and a field such as 'title' is the title.

  • maxLength: 64
itemsstring
  • maxLength: 640

title

string

Older settings: the text property typed on a line of its own above the text. Absent: chosen from 'fields'.

  • maxLength: 640

#relatedField

object

Records of another collection that link to the record being edited, such as a list's items. They're found by the link, so nothing is stored in the record itself.

Properties

anyRepo

boolean

Include linking records from any account's repo, not only the repo of the record being edited.

collection

requiredstring · nsid

The collection the linking records are in, such as 'app.bsky.graph.listitem'.

limit

integer

The most records there should be; 1 for a single record, such as a list's starter pack. No limit when absent.

  • minimum: 1

name

requiredstring

Names the field in the editor and its layout. Must differ from the collection's own fields.

  • minLength: 1
  • maxLength: 640
  • maxGraphemes: 64

path

requiredstring

Field path to the link in those records, such as 'list', or 'subject.uri' for a strong reference.

  • maxLength: 640

How to preview these records in the editor, in place of the collection's own preview: parts left out are left out of the preview. The collection's preview applies when absent.

Reference

#richTextFacets

object

Plain text with facets, as in a Bluesky post: one property holds the text, another the app.bsky.richtext.facet annotations (mentions, links, hashtags) on it. Edited as one field, named by the text property.

Properties

facets

requiredstring

The property that holds the facets, such as 'facets'.

  • maxLength: 640

text

requiredstring

The property that holds the text, such as 'text'.

  • maxLength: 640

#richTextMarkdown

object

Markdown, as in a standard.site document: one property holds the Markdown, and another, optionally, a plain text copy of it. Edited as one field, named by the Markdown property.

Properties

markdown

requiredstring

The property that holds the Markdown, such as 'content'.

  • maxLength: 640

How Markdown is stored: as text, as an at.markpub.markdown object, or as the blocks of a Leaflet (pub.leaflet.content), pckt (blog.pckt.content) or Offprint (app.offprint.content) document, converted to and from Markdown. Text already stored becomes an object when it's next edited, if an object is called for; an object stays one, of the same kind. Absent: text if the lexicon makes the property a string, otherwise at.markpub.markdown.

  • knownValues: text | at.markpub.markdown | pub.leaflet.content | blog.pckt.content | app.offprint.content

plainText

string

The property that gets a plain text copy of it, without formatting, such as 'textContent'.

  • maxLength: 640

#templateVar

object

A named template variable and how to compute its value.

Properties

name

requiredstring

Variable name used in the template.

value

requiredunion

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.