How To: Integrate the Highlighter with the Schema App Advanced WordPress Plugin

This support document lists all the steps that must be completed to receive markup from the Schema App Highlighter and the WordPress plugin. Failure to follow this process can result in duplicate markup (i.e custom markup from the Highlighter and automatic markup from the Plugin), or schema drift (markup not updating to reflect page content).

Resources Required

• Schema App Account
• Schema App Advanced WordPress Plugin
• Schema App Highlighter

Instructions

• Schema App WordPress plugin is already installed.
  • Step 1: Enable the Highlighter in the WordPress plugin
  • Step 2: Enable the Highlighter in Schema App
• Schema App WordPress plugin is not yet installed
  • Step 1: Download the Schema App Plugin from Wordpress' Plugin Repository
  • Step 2: Enable the Highlighter in Schema App
  • Step 3: Add your Account ID
  • Step 4: Upload the Schema App Advanced plugin
  • Step 5: Confirm Plugin is Active
  • Step 6: Enable the Highlighter in WordPress

Schema App WordPress plugin is already installed

If you've already followed the instructions on How to Set Up the Schema App Advanced WordPress Plugin.

Step 1: Enable the Highlighter in the WordPress plugin

1. Log into WordPress.
   
   
2. Navigate to WordPress Settings > SchemaApp > Advanced and set the Schema App Highlighter to "Enabled". Enabling the highlighter will add the necessary scripts to your page so you can use the JavaScript + Webhook Hybrid integration method to deploy markup server side.

Step 2: Enable the Highlighter in Schema App

1. Log into your Schema App account. Click the dropdown on your selected project and confirm that:
   • You're in the correct Active Project
   • You've added the website URL
   • The deployment type has been set to WordPress
     
     
     
2. From the menu on the left, navigate to Deployment > Integrations.
   
   
3. Scroll down to Manage Webhooks. You'll see that Highlighter Deployment is set to "Highlighter Disabled". Click Edit.
   
   
   
4. Click the checkbox to Enable Highlighter. Then click Save.
   
   
   
5. The Highlighter Deployment will now show "Highlighter Enabled".
   

You're now ready to begin authoring your markup using the Schema App Highlighter.

Schema App WordPress plugin is not yet installed

If you haven't already followed the instructions on How to Set Up the Schema App Advanced WordPress Plugin, here's what you need to do. 

Step 1: Download the Schema App Plugin from Wordpress' Plugin Repository

The Advanced WordPress plugin can only be added once the basic Schema App plugin has been downloaded to your WordPress site.

If you've already done this, continue to the next step. If you haven't done this yet, follow the instructions on How To Set Up the Schema App WordPress Plugin.

Step 2: Enable the Highlighter in Schema App

1. Once you've downloaded the basic Schema App plugin in WordPress, log into your Schema App account. Click the dropdown on your selected project and confirm that:
   • You're in the correct Active Project
   • You've added the website URL
   • The deployment type has been set to WordPress
     
     
     
2. From the menu on the left, navigate to Deployment > Integrations
   
   
3. Scroll down to Manage Webhooks. You'll see that Highlighter Deployment is set to "Highlighter Disabled". Click Edit.
   
   
4. Click the checkbox to Enable Highlighter. Then click Save.
   
   
5. The Highlighter Deployment will now show "Highlighter Enabled".
   

Step 3: Add your Account ID

1. Go to the Schema App Deployment page and copy your Account ID.
   
2. Go back to your WordPress dashboard, go to Settings > Schema App
   
   
3. In the Settings tab, scroll down to the "Advanced Plugin Setup" section and paste in your Account ID
   

Step 4: Upload the Schema App Advanced plugin

1. Switch back to the Integration page in Schema App
   
   
2. Click on the "Schema App Advanced WordPress Plugin" hyperlink
   
   
3. This will download the plugin as a ZIP file. Once the download it complete, go back to your WordPress site. From Admin, select Plugins > Add New.
    
4. Click the "Upload Plugin" button
   
   
5. Click "Choose File", select the ZIP file, and click "Install Now"

Step 5: Confirm Plugin is Active

1. Within WordPress, navigate to Plugins > Installed Plugins
   
   
2. Search for the basic "Schema App Structured Data" plugin and go into the "Settings"
   
   
   
3. Under the "Licenses" tab, the Schema App Advanced Status should show as "Active"
   

Step 6: Enable the Highlighter in WordPress

1. Log into WordPress.
   
   
2. Navigate to WordPress Settings > SchemaApp > Advanced and set the Schema App Highlighter to "Enabled". Enabling the highlighter will add the necessary scripts to your page so you can use the JavaScript + Webhook Hybrid integration method to deploy markup server side.

For additional support with setting up this integration, contact us at [email protected].