You are here

function optimizely_help in Optimizely 7.2

Same name and namespace in other branches
  1. 8.3 optimizely.module \optimizely_help()
  2. 8 optimizely.module \optimizely_help()
  3. 8.0 optimizely.module \optimizely_help()
  4. 7.3 optimizely.module \optimizely_help()

Implements hook_help().

Help text related to the modules functionality and use.

File

./optimizely.module, line 28
Optimizely module

Code

function optimizely_help($path, $arg) {
  switch ($path) {
    case 'admin/help#optimizely':
      return '<p>' . t('<a href="http://optimize.ly/OZRdc0">Optimizely</a> is a third party service to add A/B testing to a web site. The tests are applied to the site by loading javascript snippets generated by the Optimizely web site. The generated javascript files are applied to certain paths on the site based on Project entries managed by the Optimizely module. To start to apply the general, site wide Optimizely javascript file the <a href="@settings">Optimizely account ID</a> must be entered in the module administration page.', array(
        '@settings' => url('admin/config/system/optimizely/settings'),
      )) . '</p><p>Enable or disable each project
entry to apply the project settings while not needing to remove the actual entry. The default entry can be disabled when additional project entries are made with more specific settings. This can include using the the orginal Project Code.';
    case 'admin/config/system/optimizely':
      return t('<p>A listing of the Optimizely projects. Each entry can be enabled / disable for specific or wildcard paths. Enabled entries are highlighted in green while disabled entries are in red. The top, "Default" entry can not be deleted but its settings can be adjusted or completely disabled.</p>
							  <p>The goal of having multiple projects is to minimize the size of the Optimizely hosted javascript file. If all experiments are contained in a single file and processed on every page load there may be an issue with decreased page load time. Having multiple projects and loading them on specific paths that apply to the experiments helps to minimize the size of the file and eliminate processing unused javascript in the user\'s browser.</p>');
      break;
    case 'admin/config/system/optimizely/add_update':
      return t('Add or edit specific project entries. Each entry should have an Optimizely project / experiment assigned to it. as well as a range of website paths where the Optimizely javascript hosted file should should be included.');
      break;
    case 'admin/config/system/optimizely/settings':
      return t('Add the Optimizely account ID supplied by the Optimizely website. The account ID is essential to setting up the initial site wide default project entry.');
      break;
  }
}