function lexicon_help in Lexicon 7

Same name and namespace in other branches

1. 6 lexicon.module \lexicon_help()

Implements hook_help().

File

./lexicon.module, line 15

The Lexicon module is used to create lists of terms and definitions to use on a website and optionally mark those terms in the content of the website.

Code

function lexicon_help($path, $arg) {
  $output = '';
  switch ($path) {
    case 'admin/help#lexicon':
      return t('<p>The Lexicon module is used to create lists of terms and definitions to use on a website and optionally mark those terms in the content of the website.</p>
      <p>The Lexicon module lists all lexicon terms on a lexicon page. Optionally it replaces lexicon terms (and their synonyms) in the body of content that is filtered by an input filter.</p>
      <p>Lexicon terms are managed in vocabularies. To get started with the Lexicon module, create a new vocabulary on the !taxonomy_admin page. Add a few terms to the vocabulary. The term title is the lexicon entry and the description is its definition. You can use the related terms, synonyms, and image features by adding fields to the vocabulary using the Fields functionality of Drupal 7. For synonyms create a Field of type "Text". For related terms create a field of type "Term reference". For images create a field of type "Image". You can configure which field to use as the field for related terms, synonyms and images in the Lexicon configuration.</p>
      <p>Next, you have to set up the Lexicon module by selecting the vocabularies that you want to use as Lexicons and set the behaviour of the module to your preferences. You have to enable the Lexicon filter on input formats if you want terms to be marked in the content. On the !input_formats page, select a text format to configure. Select the Lexicon filter checkbox and press "Save configuration".</p>', array(
        '!taxonomy_admin' => l(t('administer > content > taxonomy'), 'admin/structure/taxonomy'),
        '!input_formats' => l(t('administer > site configuration > input formats'), 'admin/config/content/formats'),
      ));
      break;
    case 'admin/config/system/lexicon':
      return '<p>' . t('This page and its tabs allow you to control how the Lexicon module functions.') . '</p>';
      break;
    case 'admin/modules#description':
      return t('Maintain one or more lexicons on your site.');
      break;
  }
}