function optimizely_help in Optimizely 8.0

Same name and namespace in other branches

1. 8.3 optimizely.module \optimizely_help()
2. 8 optimizely.module \optimizely_help()
3. 7.3 optimizely.module \optimizely_help()
4. 7.2 optimizely.module \optimizely_help()

Implements hook_help().

Help text related to the module's functionality and use.

File

./optimizely.module, line 31

Optimizely module

Code

function optimizely_help($route_name, $arg) {
  switch ($route_name) {
    case 'help.page.optimizely':
      return t('<p><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, sitewide Optimizely javascript file the' . '
         <a href="@settings">Optimizely account ID</a> must be entered in the' . ' module administration page.</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 orginal Project Code.</p>', array(
        '@settings' => \Drupal::url('optimizely.settings'),
      ));
    case 'optimizely.listing':
      return t('<p>A listing of the Optimizely projects. Each entry can be' . ' enabled / disabled for specific or wildcard paths. Enabled entries are' . ' highlighted in green while disabled entries are in red. The top,' . ' "Default" entry cannot 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' . ' increased 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 on the user's" . ' browser.</p>');
    case 'optimizely.add_update':
    case 'optimizely.add_update.oid':
      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 be' . ' included.');
    case 'optimizely.settings':
      return t('Add the Optimizely account ID supplied by the Optimizely website.' . ' The account ID is essential to setting up the initial sitewide default' . ' project entry.');
  }
}