function lexicon_help in Lexicon 6

Same name and namespace in other branches

1. 7 lexicon.module \lexicon_help()

Lexicon is used to create lists of terms and definitions to use on a website and optionally mark them in the content with an indicator.

The Lexicon module lists all lexicon terms on a lexicon page. Optionally it scans posts for lexicon terms (and their synonyms) in the body. If found, the lexicon indicator is inserted after the term, or the term is turned into an indicator link depending on the settings. By hovering over the indicator, users may learn the definition of that term. Clicking leads the user to that term presented within the whole lexicon. @file

1 call to lexicon_help()

lexicon_search_results in ./lexicon.module

File

./lexicon.module, line 15

Lexicon is used to create lists of terms and definitions to use on a website and optionally mark them in the content with an indicator.

Code

function lexicon_help($path, $args = array()) {
  $output = '';
  switch ($path) {
    case 'admin/help#lexicon':
      return t('<p>Lexicon is used to create lists of terms and definitions to use on a website and optionally mark them in the content with an indicator</p>
      <p>The Lexicon module lists all lexicon terms on a lexicon page. Optionally it scans posts for lexicon terms (and their synonyms) in the body. If found, the lexicon indicator is inserted after the term, or the term is turned into an indicator link depending on the settings. By hovering over the indicator, users may learn the definition of that term. Clicking leads the user to that term presented within the whole lexicon.</p>
      <p>Lexicon terms are managed as vocabularies within the taxonomy module. To get started with lexicon, create a new vocabulary on the !taxonomy_admin page. The vocabulary need not be associated with any modules, although you can add detailed description to terms by attaching (story or other type of) nodes to them. Add a few terms to the vocabulary. The term title should be the lexicon entry and the description should be its definition. You can make use of the synonym, and related terms features. These features impact the display of the lexicon when viewed in an overview.</p>
      <p>Next, you have to set up the Lexicon module and enable the Lexicon filter on input formats. On the !input_formats page, select an input format to configure. Select the Lexicon filter checkbox and press "Save configuration".</p>
      <p>Administration of lexicon requires %permissions permissions.</p>', array(
        '%permissions' => join(', ', array(
          t('administer taxonomy'),
          t('access administration pages'),
          t('administer lexicon'),
        )),
        '!taxonomy_admin' => l(t('administer >> content >> taxonomy'), 'admin/content/taxonomy'),
        '!input_formats' => l(t('administer >> site configuration >> input formats'), 'admin/settings/filters'),
        '!lexicon' => l(t('administer >> site configuration >> lexicon'), 'admin/settings/lexicon'),
        '!lexicons' => l(t('lexicons'), 'lexicon'),
      ));
      break;
    case 'admin/settings/lexicon':
      return '<p><big>' . t('This page and its tabs allow you to control how the Lexicon module functions.') . '</big></p>';
      break;
    case 'admin/modules#description':
      return t('Maintain one or more lexicons on your site.');
      break;
    case 'lexicon':
      if (!$args[1]) {
        if (user_access('administer lexicon')) {
          return t('<a href="!url">Lexicon settings page</a>', array(
            '!url' => url('admin/settings/lexicon'),
          ));
        }
      }
      break;
    case 'lexicon_search#noresults':
      return t('<ul>
<li>Check if your spelling is correct.</li>
<li>Remove quotes around phrases to match each word individually: <em>"blue smurf"</em> will match less than <em>blue smurf</em>.</li>
<li>Consider loosening your query with <em>OR</em>: <em>blue smurf</em> will match less than <em>blue OR smurf</em>.</li>
</ul>');
  }
}