at.markpub.facets.baseFormatting

Repository @markpub.at did:plc:kfxbexqtvw76572grhv2f3on namespace authority
Details · object
Kindobject
Authorityfacets.markpub.at
Indexed

Object

object

Properties

features

requiredarray
itemsunion

index

requiredref
Reference

#byteSlice

object

Specifies the sub-string range a facet feature applies to. Start index is inclusive, end index is exclusive. Indices are zero-indexed, counting bytes of the UTF-8 encoded text. NOTE: some languages, like Javascript, use UTF-16 or Unicode codepoints for string slice indexing; in these languages, convert to byte arrays before working with facets. Byte slices can overlap.

Properties

byteEnd

requiredinteger
  • minimum: 0

byteStart

requiredinteger
  • minimum: 0

#header

object

Facet feature for a `<h1>` HTML tag. The integer is the level you want to use, as in h1, h2, h3, etc... For the byteSlice provided it should surround the underlying text.

Properties

level

requiredinteger
  • minimum: 1
  • maximum: 6

#idify

object

Facet feature instructs parsers to stringify the underlying text and include it as an id property on an HTML element. If this overlaps with an existing HTML tag generated by another facet, it is assumed that it will be applied to that tag. If there is no matching tag, use `<span></span>`. It is expected spaces are turned into hyphens. For example, a header facet with an idify feature might produce `<h1 id="header-text">Header Text</h1>`.

Properties

#strong

object

Facet feature for a `<strong>` HTML tag. For the byteSlice provided it should surround the underlying text.

Properties

Similar lexicons

semantic match

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

  • Specifies the sub-string range a facet feature applies to. Start index is inclusive, end index is exclusive. Indices are zero-indexed, counting bytes of the UTF-8 encoded text. NOTE: some languages, like Javascript, use UTF-16 or Unicode codepoints for string slice indexing; in these languages, convert to byte arrays before working with facets. Byte slices can overlap.

  • Annotation of a sub-string within rich text.

  • Annotation of a sub-string within rich text.

  • Annotation of a sub-string within rich text.

  • Annotation of a sub-string within the parent record's `textContent`. Byte offsets refer to a UTF-8 encoding of the string. A single facet may carry multiple features that all apply to the same byte range.