1. Getting Started

1.1 Overview

C9 Variables simplifies content management by providing ways to author smart reusable content. A "smart" content is easy to maintain. A good example is a promotion code that keeps changing from time to time. You simply want to keep your links updated with the latest code. Likewise, a "reusable" content makes it easy to author content once but use it in multiple places. An example of this would be the product features that you may want to refer from multiple locations on your site, such as, the product page, blog posts, etc.

C9 Variables makes it easy to author and use such content by following these 2 simple steps.

  1. Author the smart/reusable content as a variable.
  2. Update the referring content (such as, links, blogs, pages, etc.) to use this variable. That way, the referring content gets the latest value.

As you will see further in this documentation, C9 Variables makes it easy to manage and use these variables via convenience UI and shortcode.

1.2 How it works?

The following graphics demonstrates the essence of C9 Variables basic functionality.

C9 Variables - How it works?

  • The variable ProductFeatures is defined (shown in the top box).
  • The referring content uses a shortcode to refer to the variable (as shown by the bottom 2 boxes).
  • Whenever the referring content is shown, the latest value of the ProductFeatures variable is used to build the overall content. Simple!
 

1.3 Installation

1.3.1 C9 Variables Installation

  1. Use the WordPress Plugins->Add New action and search for C9 Variables. Click on Install Now to proceed with the installation. Alternately, upload c9-variables-<version>.zip using WordPress Admin Plugins->Add New.
  2. Activate the plugin.
  3. Optional: Tweak the 'Settings'. You can always do this later.

1.3.2 C9 Variables Pro Installation

  1. Purchase or renew subscription.
  2. Download the c9-variables-pro-<version>.zip. (See detailed instructions)
  3. Upload the c9-variables-pro-<version>.zip using WordPress Admin Plugins->Add New.
  4. Activate the plugin.
  5. Specify the license key (available under Account->My Licenses) in the Variables Pro->Settings section. Here is the link for your convenience:
    https://cloudnineapps.com/my-licenses
  6. Optional: Tweak other 'Settings'. You can always do this later.

 

2. C9 Variables Documentation

This section of documentation is common to both the C9 Variables and C9 Variables Pro plugins. The enhanced functionality available in the C9 Variables Pro plugin is called out, as appropriate.

2.1 Overview

2.1.1 C9 Variables Features

  • WordPress Admin
    • Add/modify/delete up to 10 Variables
    • Support for WordPress built-in roles: Super Admin, Administrator, Editor, Author, Contributor, Subscriber (see details)
    • Page/Post Editor Enhancements
      • Integrated Editor button to lookup and insert a Variable
      • Organize Variable list by title
      • Use selected Variable in the post/page via a convenient shortcode
    • Settings
      • Debug Mode: On/Off (default: Off)
      • Anonymous Usage Tracking: On/Off (default: Off)
  • WordPress Public
    • Replace Variable value when showing the post/page

2.1.2 C9 Variables Roles and Capabilities

Since the primary intent of C9 Variables is to author smart reusable content, it uses the built-in WordPress roles and grants these specific capabilities depending on the role. It closely adheres to the WordPress built-in capabilities model. C9 Variables specific capabilities are automatically applied and no specific user action is necessary unless you need to tweak these for your installation. Following matrix provides the details.

Legend: 'X' indicates capability is available, '-' indicates capability is not available.

CapabilitySuper Admin/AdministratorEditorAuthorContributorSubscriber
Read VariablesXXXXX
Edit Own VariablesXXXX-
Edit Others VariablesXX---
Publish VariablesXXX--
Delete Own VariablesXXXX-
Delete Others VariablesXX---
Manage Options/SettingsX----

2.2 C9 Variables User Guide

2.2.1 Adding a Variable

In order to add a Variable, please follow these steps.

  • Login as an admin.
  • Go to Variables->All Variables (in case of C9 Variables Pro, go to Variables Pro->All Variables).
  • Click on Add New.
    C9 Variables - Add Variable
  • Author the Variable content, as needed. You can use the visual editor or text editor and shortcodes from other plugins.
    C9 Variables - Edit Variable Content
    Following screenshot is from the Pro plugin that provides additional capabilities (see C9 Variables Pro documentation for details).
    C9 Variables Pro - Edit Variable Content
  • Click on Publish or Update to save the Variable.

2.2.2 Using a Variable

A "Referring Content" is a page or post that would use one or more Variables. Please follow these steps to use a Variable.

  • Edit the Referring Content.
  • Use the Variables button to launch the Variable Selector.
    C9 Variables - Launch Variable Selector
    Following screenshot is from the Pro plugin that provides additional capabilities (see C9 Variables Pro documentation for details).
    C9 Variables Pro - Launch Variable Selector
  • If needed type in a keyword to narrow down the Variable list. Select a Variable from the list. The keyword search is incremental - a short delay in typing letters performs the search.
    C9 Variables - Variable Selector
    Following screenshot is from the Pro plugin that provides additional capabilities (see C9 Variables Pro documentation for details).
    C9 Variables Pro - Variable Selector
  • The selected Variable name is shown in the Selected Variable field.
    Note: You may notice that the Selected Variable text could be different from the Variable's title and is in all lower case. A Variable's title is a user-friendly text to identify the Variable. Whereas, a Variable's name is what the WordPress system understands internally to uniquely identify a Variable. For this reason, C9 Variables shortcode also uses Variable's name.
  • Click on Insert Variable to insert the Variable in the Referring Content or Cancel to abort. The Variable is inserted using the c9-vars-insert shortcode.

2.2.3 Listing Variables

In order to see Variables list, please follow the following steps.

  • Login as an admin.
  • Go to Variables->All Variables (in case of C9 Variables Pro, go to Variables Pro->All Variables).
    C9 Variables - Variables List

2.2.4 Editing a Variable

In order to edit a Variable, please follow these steps.

  • Login as an admin.
  • Go to Variables->All Variables (in case of C9 Variables Pro, go to Variables Pro->All Variables).
    C9 Variables - Variables List
  • Click on a Variable to edit it.

2.2.5 Deleting one or more Variables

In order to see Variables list, please follow the following steps.

CAUTION: Deleting a Variable that's in use by other Referring Content could impact the user experience. Please make sure to remove any references to the Variable prior to deleting it.

  • Login as an admin.
  • Go to Variables->All Variables (in case of C9 Variables Pro, go to Variables Pro->All Variables).
    C9 Variables - Variables List
  • If deleting a single Variable, simply hover over the Variable and click on the Trash link. If you change your mind later, you can always recover it from the trash.
  • If deleting multiple Variables, select the checkbox against the Variables and choose Move to Trash from the Bulk Actions.
  • Click Apply. This will move all the selected Variables to the trash. If you change your mind later, you can always recover these from the trash.

2.2.6 Managing Settings

2.2.6.1 Updating Settings

In order to update settings, please follow these steps.

  • Login as an admin.
  • Go to Variables->Settings (in case of C9 Variables Pro, go to Variables Pro->Settings).
    C9 Variables - Settings
    SettingInformationDefault
    Enable Debug Mode- Select to turn Debug Mode on.
    - Deselect to turn Debug Mode off.
    Off
    Allow Anonymous Usage Tracking- Select to capture anonymous usage tracking in order to improve the quality of service.
    - Deselect to turn off anonymous usage tracking.
    Off
    Following screenshot is from the Pro plugin that provides additional capabilities (see C9 Variables Pro documentation for details).
    C9 Variables Pro - Settings

2.2.6.2 Finding Plugin Information

In order to find plugin information, please follow these steps.

  • Login as an admin.
  • Go to Variables->About Variables (in case of C9 Variables Pro, go to Variables Pro->About Variables).
    • This will display information, such as, plugin version.

2.2.6.3 Finding Information about Other Plugins

Other Plugins provides information about our other plugins, both - free and paid ones. In order to find information about other plugins, please follow these steps.

  • Login as an admin.
  • Go to Variables->Other Plugins (in case of C9 Variables Pro, go to Variables Pro->Other Plugins).