Add Custom Structured Data to Invision Community Pages Database

Notice: This article is for providing insight on how to add custom schema markup to "Databases" in Invision Community's Pages application.

There are a few ways to structured data an Invision Community Pages' Database:

1. Implement Microdata, RDFa, or JSON-LD into a Database template and custom fields,
2. Create a custom field that allows authors to create customized JSON-LD schema markup,
3. Use a custom field to implement JSON-LD and map variables to properties.

This is a more advanced method for dynamically embedded values into JSON-LD structured data. This is likely the best way to implement custom data because once setup, markup is added to each post automatically based on custom fields values.

Necessary Variables

Variable	Title	Description
{$record->_title}	Record Title
{$record->truncated()|raw}	Record Content
{$record->container()->url()} {$record->container()->_title}	Record Container/Category
{$record->fieldValues()['field_{id#}']}	fieldValues	Accessing $values for Text fields or the key (rather than value) for Selectbox and Checkbox Set.
{$record->customFieldDisplayByKey('{Template Key}')}	customFieldDisplayByKey	Accessing the formatted input from the Display View Format option.

Note: For fields that will be displayed with any format other than just the value of the field, the ID of those fields are required to populate JSON-LD data with just the field value without the formatting data. The ID will be used with the {$record->fieldValues()['field_{id#}']} variable, replacing {id#} with the ID number, e.g. {$record->fieldValues()['field_123']}.

Note: For Select box and Checkbox Set fields with multiple options, the fieldValues variable will pull the key of the individual option(s). So, it is important to give the options a key that comply with the format of your structured data type from the Schema.org vocabulary. For example, if you are making a "Books" database, and you want to populate the bookFormat property with options from a Checkbox set. In order to have valid schema markup, you have to comply with the Schema.org enumeration members for the enumeration type: BookFormatType, which are limited to: AudiobookFormat, EBook, GraphicNovel, Hardcover, Paperback. enumeration will be the key for your options even if your options value is in another language.

Schema.org Properties and DB Field Types

Schema.org Properties	Database Field Type	Notes
genre	Select box or Checkbox Set
isbn	Text or Number
inLanguage	Select box or Checkbox Set
author	Text
editor	Text
illustrator	Text
contributor	Text
publisher	Select box or Checkbox Set
publisherImprint	Select box or Checkbox Set
isPartOf	Select box or Checkbox Set	Used with the BookSeries schema.org type.
abridged	Checkbox, Radio, or Yes/No
bookFormat	Select box or Checkbox Set
bookEdition	Text

Basic Instructions

1. Create a Database,
2. Add your custom fields, including any of the above that will be mapped to Schema.org Properties.
3. Create the field that will hold the JSON-LD structured data.
   • "General Options" tab:
     • Title: your choice,
     • Type: Checkbox or Radio,
     • Default Value: 1.
   • "Display options" tab:
     • Template Key: your choice; if you leave this blank, it will be generated automatically when you save the field,
     • List View section: If you want the structured data to be included on listing pages, you can follow and use the steps below:
     • Display View section:
       • Display View Format: Custom,
       • Display: your choice; If you select Under the item content and there are no other fields are there will be a horizontal line with a nothing under it.

Display Custom Format

{{if $formValue}}
<script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@graph": {
    "@type": "Book",
    "name": "{$record->_title}",
    {{if $record->customFieldDisplayByKey('pages', 'display')}}
    "numberOfPages": "{$record->fieldValues()['field_123']}",
    {{endif}}
    {{if $record->customFieldDisplayByKey('genre', 'display')}}
    "genre": "{$record->fieldValues()['field_123']}",
    {{endif}}
    {{if $record->customFieldDisplayByKey('isbn', 'display')}}
    "isbn": "{$record->fieldValues()['field_11']}",
    {{endif}}
    "description": "{$record->truncated()|raw}",
    {{if $record->customFieldDisplayByKey('date', 'display')}}
    "datePublished": "{$record->fieldValues()['field_123']}",
    {{endif}}
    {{if $record->customFieldDisplayByKey('language', 'display')}}
    "inLanguage": {
      "@type": "Language",
      "name": "{$record->fieldValues()['field_123']}"
    },
    {{endif}}
    "url": "{$record->url()}",
    "discussionUrl": "{$record->url()?&tab=comments}",
    {{if $record->customFieldDisplayByKey('author', 'display')}}
    "author": {
      "@type": "Person",
      "name": "{$record->fieldValues()['field_123']}"
    },
   {{endif}}
   {{if $record->customFieldDisplayByKey('editor', 'display')}}
   "editor": {
      "@type": "Person",
      "name": "{$record->fieldValues()['field_123']}"
    },
   {{endif}}
   {{if $record->customFieldDisplayByKey('illustrator', 'display')}}
   "illustrator": {
      "@type": "Person",
      "name": "{$record->fieldValues()['field_123']}"
    },
  {{endif}}
  {{if $record->customFieldDisplayByKey('contributor', 'display')}}
  "contributor": {
      "@type": "Person",
      "name": "{$record->fieldValues()['field_123']}"
    },
  {{endif}}
  {{if $record->record_image}}
  "thumbnail": {
      "@type": "ImageObject",
      "url": "{file="$record->_record_image_thumb" extension="cms_Records"}"
    },
  {{endif}}
  {{if $record->customFieldDisplayByKey('publisher', 'display')}}
    "publisher": {
      "@type": "Organization",
      "name": "{$record->fieldValues()['field_123']}"
    },
  "copyrightHolder": {
      "@type": "Organization",
      "name": "{$record->fieldValues()['field_123']}"
    },
  {{endif}}
  {{if $record->customFieldDisplayByKey('imprint', 'display')}}
  "publisherImprint": {
      "@type": "Organization",
      "name": "{$record->fieldValues()['field_123']}"
    },
  {{endif}}
  {{if $record->customFieldDisplayByKey('series', 'display')}}
  "isPartOf": {
      "@type": "BookSeries",
      "name": "{$record->fieldValues()['field_123']}"
    },
  {{endif}}
  {{if $record->customFieldDisplayByKey('abridged', 'display')}}
  "abridged": "http://schema.org/True",
  {{endif}}
  {{if $record->customFieldDisplayByKey('format', 'display')}}
  "bookFormat": "{$record->fieldValues()['field_123']}",
  {{endif}}
  {{if $record->customFieldDisplayByKey('edition', 'display')}}
 "bookEdition": "{$record->fieldValues()['field_123']}",
 {{endif}}
    "awards": "{$record->fieldValues()['field_123']}"
  }
}
</script>
{{endif}}

Frequently Asked Questions