Traits

Many elements support reusable fields called traits. These traits add additional richness and depth to your content and are always optional.

To use a trait, simply add the relevant fields – in full or in part – to the Element being defined.

  1. Social
  2. Detail
  3. Location
  4. Audio
  5. Attribution

Social

Summary

Configure social features associated with your content by allowing or denying platform-specific interactions.

Example

{
  "allow": [ "fb:like", "fb:comment", "email" ],
  "deny": [],
  ...
}

Fields

Field Type Default Purpose Caveats Version
allow array of SOCIAL_ACTION [] The permitted social actions. If empty, all are allowed. 1
deny array of SOCIAL_ACTION [] The disallowed social actions. If empty, all are allowed. 1

█

Detail

Summary

Add captions, summaries, and other details to content.

Example

{
  "caption": "Hello World",
  "subcaption": "A great adventure",
  "summary": "This section discusses the universe",
  ...
}

Fields

Field Type Default Purpose Caveats Version
caption string null The primary caption. Markdown enabled. 1
subcaption string null Additional details related to the caption. Markdown enabled. 1
summary string null A summary of the content. Markdown enabled. 1

█

Location

Summary

Add location metadata to your content.

Example

{
  "location": {...},
  ...
}

Fields

Field Type Default Purpose Caveats Version
geography Geography — Location associated with the content. 1

█

Audio

Summary

Add audio to your content.

Example

{
  "source": "http://example.com/audio.mp3",
  "title": "A story to remember",
  "mode": "ambient",
  ...
}

Fields

Field Type Default Purpose Caveats Version
source string — The URL of the media. Must be a valid URL. 1
title string null The title of the audio. 1
mode AUDIO_MODE null The audio playback mode. 1

█

Attribution

Summary

Add attribution and legal notices to your content.

Example

{
  "legal": "(c) 2015 The Authors",
  "credit": "John Smith",
  ...
}

Fields

Field Type Default Purpose Caveats Version
legal string null Any copyright or legal notice. 1
credit string null The attribution. 1

█