# Settings Documentation

updated (2024-11-21) for version 1.0.3

## Overview
This document provides an overview of the settings and configuration options available for the plugin. The user can find the setting under Setting -> Exodox in the wp admin menu.

## General settings

### Publisher ID
This settings determine the all important Publisher ID. the publisher id links the plugin to a creator on the Exodox link platform, allowing that creator to lock links on the site.

### Publisher API Key
This settings setts the publisher api key. This optional setting allows the plugin to access more advanced api functions on the host such as locking post directly via the plugin or fetching data regarding the settings of the publisher

## Display settings

### Disable Exodox in loop message on archive pages
The Exodox plugin poses a legacy function that prints information messages in Post Archive loops regarding locked content this do not always work well depending on the theme and its currently recommended to keep this option turned on if your theme allow it.

Disabling this option is necessary for the loops lock to work.

### Replace theme header when using the template redirect lock
When turned on the plugin will replace the wp header of your theme with the header template 'templates/redirect-lock/locked-page-header.php' on pages locked with the replace lock. 

Turn this of to keep the default theme header even on locked pages. Be carful when doing this, theme headers and associated menus sometimes conflict with the plugins locked page depending on the theme.

### Replace theme footer when using the template redirect lock
When turned on the plugin will replace the wp footer of your theme with the header template 'templates/redirect-lock/locked-page-footer.php' on pages locked with the replace lock. 

Turn this of to keep the default theme footer even on locked pages. Be carful when doing this, theme footer and associated items sometimes conflict with the plugins locked page depending on the theme.

### Show post excerpt in pages
Turn on to show the wp post excerpt on locked pages if there is no description of the locked item available form the Exodox host.

### Show info box on top of the exodox post display
This settings toggles the visibility of the top info segment visible on locked pages.

## Style settings

### Use dark mode styling 
This swaps the default appearance of the exodox plugin into using dark mode styling

### Popup alignment
This setts the alignment and positioning of the timmer popup visible on unlocked pages

## Locks

The locks settings tabb contain settings for what lock to keep active on the site

### Lock pages and redirect to locked template
This setting activates the redirect lock. The redirect lock detects when a page is locked for the user and redirects that user to a locked page template provided by exodox, in effect replacing the entire page before the user or the theme interacts with it.

The locked page template can be edited via the theme using the template system provided by the plugin.

### Lock pages and replace content

This setting activates the post lock. The post lock detects when a single page is locked for the user and replaces every occurrence of the wp content of that page with a the locked content html.

This lock is less intrusive then the redirect lock but unlike the redirect lock it only replaces part of the page. The replacement works via replacing every occurrence of the_content prior to it being printed, unfortunate not every wp them make use of the_content or prints the_content using standard methods this mens that this option do not work for every theme.

### Lock Archives and replace content

This setting activates the loop lock. The loop lock detects when a archive page is locked for the user and replaces every occurrence of the wp content of that page with a the locked content html.

This lock is less intrusive then the redirect lock but unlike the redirect lock it only replaces part of the page. The replacement works via replacing every occurrence of the_content in loops prior to it being printed, unfortunate not every wp them make use of the_content or prints the_content using standard methods this mens that this option do not work for every theme.