Deploying Highlighter markup to proxied URLs with the WordPress Advanced Plugin

The following document details the steps required to have your markup deploy to WordPress pages that are behind a proxy.

Proxy / Reverse Proxy URLs

If your Wordpress installation has a different internal URL than what users will see, due to the WordPress site behind hosted behind a proxy or reverse proxy, by default the WordPress plugin will not be able to override the default markup generated by the plugin with your Highlighter markup.

The WordPress Advanced Plugin settings has an option to include an element on your pages that contains the internal URL. This can be targeted by the Schema App Highlighter, allowing your markup to deploy to the intended user-facing URLs.

Enable Include Page Path Meta Tag option

Navigate to WordPress Settings > SchemaApp > Advanced and set the Include Page Path Meta Tag to "Enabled". Enabling this will add a meta tag to your page that contains the internal page path URL, so you can target this element in the Schema App Highlighter.

If you need to change the value of the internal page path URL, the option 'Page Path URL' can be set to whatever URL you need to use. This is set to your site's Site Address (URL) by default.

Create Highlights for each Template

For each template for this site, create the following highlights:

1. Create a Fixed Property Highlight with the path identifier~PropertyValue~name and with the value InternalUrl.

2. Create a Manually-Defined Highlight with the path identifier~PropertyValue~value and with the value //meta/@data-page-path, to target the element in your WordPress pages.

Verifying deployment of markup

Once these highlights have been created, upon navigating to the pages the highlight.js script will store your markup in Schema App's CDN. After your WordPress site receives the updated markup from the Schema App CDN via webhooks, it will store the Highlighter markup in your WordPress cache. Upon reloading a page, this cached Highlighter markup will override the default markup on your pages.