pub.leaflet.richtext.facet

leaflet.pub

Documentation

Annotation of a sub-string within rich text.

main object

Annotation of a sub-string within rich text.

Properties

index ref #byteSlice Required

No description available.

View raw schema
{
  "type": "object",
  "required": [
    "index",
    "features"
  ],
  "properties": {
    "index": {
      "ref": "#byteSlice",
      "type": "ref"
    },
    "features": {
      "type": "array",
      "items": {
        "refs": [
          "#link",
          "#didMention",
          "#atMention",
          "#code",
          "#highlight",
          "#underline",
          "#strikethrough",
          "#id",
          "#bold",
          "#italic"
        ],
        "type": "union"
      }
    }
  },
  "description": "Annotation of a sub-string within rich text."
}
atMention object

Facet feature for mentioning an AT URI.

Properties

atURI string uri Required

A valid URI.

View raw schema
{
  "type": "object",
  "required": [
    "atURI"
  ],
  "properties": {
    "atURI": {
      "type": "string",
      "format": "uri"
    }
  },
  "description": "Facet feature for mentioning an AT URI."
}
bold object

Facet feature for bold text

This object has no properties defined.

View raw schema
{
  "type": "object",
  "required": [],
  "properties": {},
  "description": "Facet feature for bold text"
}
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.

Properties

byteEnd integer Required

No description available.

minimum: 0
byteStart integer Required

No description available.

minimum: 0
View raw schema
{
  "type": "object",
  "required": [
    "byteStart",
    "byteEnd"
  ],
  "properties": {
    "byteEnd": {
      "type": "integer",
      "minimum": 0
    },
    "byteStart": {
      "type": "integer",
      "minimum": 0
    }
  },
  "description": "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."
}
code object

Facet feature for inline code.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "required": [],
  "properties": {},
  "description": "Facet feature for inline code."
}
didMention object

Facet feature for mentioning a did.

Properties

did string did Required

A decentralized identifier (DID).

View raw schema
{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    }
  },
  "description": "Facet feature for mentioning a did."
}
highlight object

Facet feature for highlighted text.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "required": [],
  "properties": {},
  "description": "Facet feature for highlighted text."
}
id object

Facet feature for an identifier. Used for linking to a segment

Properties

id string Optional

No description available.

View raw schema
{
  "type": "object",
  "required": [],
  "properties": {
    "id": {
      "type": "string"
    }
  },
  "description": "Facet feature for an identifier. Used for linking to a segment"
}
italic object

Facet feature for italic text

This object has no properties defined.

View raw schema
{
  "type": "object",
  "required": [],
  "properties": {},
  "description": "Facet feature for italic text"
}
link object

Facet feature for a URL. The text URL may have been simplified or truncated, but the facet reference should be a complete URL.

Properties

uri string Required

No description available.

View raw schema
{
  "type": "object",
  "required": [
    "uri"
  ],
  "properties": {
    "uri": {
      "type": "string"
    }
  },
  "description": "Facet feature for a URL. The text URL may have been simplified or truncated, but the facet reference should be a complete URL."
}
strikethrough object

Facet feature for strikethrough markup

This object has no properties defined.

View raw schema
{
  "type": "object",
  "required": [],
  "properties": {},
  "description": "Facet feature for strikethrough markup"
}
underline object

Facet feature for underline markup

This object has no properties defined.

View raw schema
{
  "type": "object",
  "required": [],
  "properties": {},
  "description": "Facet feature for underline markup"
}

Lexicon Garden

@