function lexicon_general_settings_form in Lexicon 7

Same name and namespace in other branches

1. 6 lexicon.admin.inc \lexicon_general_settings_form()

Lexicon general settings form.

2 string references to 'lexicon_general_settings_form'

lexicon_menu in ./lexicon.module

Implements hook_menu().

lexicon_settings_page in includes/lexicon.admin.inc

Introductory stuff for the settings page.

File

includes/lexicon.admin.inc, line 24

Lexicon administration functions and forms.

Code

function lexicon_general_settings_form($form, &$form_state) {
  $form = array();
  $form['general'] = array(
    '#type' => 'fieldset',
    '#title' => t('General settings'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  );
  $options = array();
  $result = db_query('SELECT vid, name FROM {taxonomy_vocabulary} ORDER BY name');
  foreach ($result as $record) {
    $options[$record->vid] = filter_xss_admin($record->name);
  }
  if (!$options) {
    drupal_set_message(t('No vocabularies were found. Until you set up, and select, at least one vocabulary to use as a Lexicon, no lexicon is displayed and no marking of terms in the content of the website can be done.'));
  }
  $form['general']['lexicon_vids'] = array(
    '#type' => 'checkboxes',
    '#title' => t('Which vocabularies act as lexicons.'),
    '#default_value' => variable_get('lexicon_vids', array()),
    '#options' => $options,
    '#description' => t('Select one or more vocabularies which hold terms for your lexicons.'),
    '#multiple' => TRUE,
    '#required' => FALSE,
  );
  $form['general']['lexicon_allow_no_description'] = array(
    '#type' => 'checkbox',
    '#title' => t('Show/mark lexicon terms even if there is no description.'),
    '#default_value' => variable_get('lexicon_allow_no_description', FALSE),
    '#description' => t('By default, Lexicon does not show/mark terms if there is no term description. This setting overrides that. This is useful on free-tagging vocabularies that rarely get descriptions.'),
  );
  $form['lexicon_page'] = array(
    '#type' => 'fieldset',
    '#title' => t('Lexicon Page'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  );
  $form['lexicon_page']['lexicon_page_per_letter'] = array(
    '#type' => 'checkbox',
    '#title' => t('Show lexicon across many smaller pages.'),
    '#default_value' => variable_get('lexicon_page_per_letter', FALSE),
    '#description' => t('Do you want to show all terms on one lexicon page or break up the lexicon into a page for each first letter (i.e. many pages).'),
  );
  $form['lexicon_page']['lexicon_page_show_all'] = array(
    '#type' => 'checkbox',
    '#title' => t('Show all terms when no letter argument is given.'),
    '#default_value' => variable_get('lexicon_page_show_all', FALSE),
    '#description' => t('Do you want to show all terms on the lexicon page if no letter argument is given.'),
    '#states' => array(
      'invisible' => array(
        ':input[name="lexicon_page_per_letter"]' => array(
          'checked' => FALSE,
        ),
      ),
    ),
  );
  $form['lexicon_page']['lexicon_separate_letters'] = array(
    '#type' => 'checkbox',
    '#title' => t('Separate letters.'),
    '#default_value' => variable_get('lexicon_separate_letters', FALSE),
    '#description' => t('Separate the terms by the first letters. This will create heading with the letter at the beginning of each section. If the terms are not separated by the first letters, no alphabar will be shown.'),
    '#states' => array(
      'visible' => array(
        ':input[name="lexicon_page_per_letter"]' => array(
          'checked' => FALSE,
        ),
      ),
    ),
  );
  $form['lexicon_page']['lexicon_show_description'] = array(
    '#type' => 'checkbox',
    '#title' => t('Show lexicon term descriptions.'),
    '#default_value' => variable_get('lexicon_show_description', FALSE),
    '#description' => t('Lexicon term descriptions may be large and/or include pictures, therefore the Lexicon can take a long time to load if you include the full descriptions.'),
  );
  $form['lexicon_page']['lexicon_link_to_term_page'] = array(
    '#type' => 'checkbox',
    '#title' => t('Link terms to the taxonomy term page.'),
    '#default_value' => variable_get('lexicon_link_to_term_page', FALSE),
    '#description' => t('Do you want the term names to link to their taxonomy term page?'),
  );
  $form['lexicon_page']['lexicon_link_related'] = array(
    '#type' => 'checkbox',
    '#title' => t('Link related terms on the Lexicon page.'),
    '#default_value' => variable_get('lexicon_link_related', TRUE),
    '#description' => t('Do you want terms that are related to link to each other?'),
  );
  $click_options = array(
    t('Show only the single term.'),
    t('Advance the whole lexicon to the term.'),
  );
  $form['lexicon_page']['lexicon_click_option'] = array(
    '#type' => 'select',
    '#title' => t('Clicking on a term link will:'),
    '#options' => $click_options,
    '#default_value' => variable_get('lexicon_click_option', 1),
    '#description' => t('Set the link to show only the single term by using the default taxonomy single term view or go to the lexicon overview.'),
  );
  $form['lexicon_page']['lexicon_show_edit'] = array(
    '#type' => 'checkbox',
    '#title' => t('Show "edit" link.'),
    '#default_value' => variable_get('lexicon_show_edit', TRUE),
    '#description' => t('Determines whether or not to show an "edit term" link for each entry.'),
  );
  $form['lexicon_page']['lexicon_show_search'] = array(
    '#type' => 'checkbox',
    '#title' => t('Show "search" link.'),
    '#default_value' => variable_get('lexicon_show_search', TRUE),
    '#description' => t('Determines whether or not to show an "search for term" link for each entry.'),
  );
  $form['lexicon_page']['lexicon_go_to_top_link'] = array(
    '#type' => 'checkbox',
    '#title' => t('Show "go to top" link.'),
    '#default_value' => variable_get('lexicon_go_to_top_link', FALSE),
    '#description' => t('Determines whether or not to show a "go to top" link after each group of lexicon items per letter.'),
  );
  $form['lexicon_page']['lexicon_go_to_top_link_fragment'] = array(
    '#type' => 'textfield',
    '#title' => t('"Go to top" link anchor name.'),
    '#default_value' => variable_get('lexicon_go_to_top_link_fragment', 'top'),
    '#description' => t('Sets the "go to top" link anchor name to link to.'),
    '#states' => array(
      'invisible' => array(
        ':input[name="lexicon_go_to_top_link"]' => array(
          'checked' => FALSE,
        ),
      ),
    ),
  );
  $form['lexicon_page']['lexicon_local_links_scroll'] = array(
    '#type' => 'checkbox',
    '#title' => t('Use scroll animation for local links.'),
    '#default_value' => variable_get('lexicon_local_links_scroll', FALSE),
    '#description' => t('Determines whether or not to animate scrolling to sections when following local links on the page.'),
  );
  $form['mark_terms'] = array(
    '#type' => 'fieldset',
    '#title' => t('Term marking settings'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
    '#description' => t('You have to enable the <em>Lexicon Filter</em> in one or more text formats in the !text_format_settings to enable term marking in content.', array(
      '!text_format_settings' => l(t('Text format settings'), 'admin/config/content/formats'),
    )),
  );
  $form['mark_terms']['lexicon_mark_terms'] = array(
    '#type' => 'checkbox',
    '#title' => t('Mark terms in content.'),
    '#default_value' => variable_get('lexicon_mark_terms', TRUE),
    '#description' => t('Determines whether or not to mark terms in the content.'),
  );
  $form['mark_terms']['match'] = array(
    '#type' => 'fieldset',
    '#title' => t('Term matching'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
    '#states' => array(
      'invisible' => array(
        ':input[name="lexicon_mark_terms"]' => array(
          'checked' => FALSE,
        ),
      ),
    ),
  );
  $form['mark_terms']['match']['lexicon_match'] = array(
    '#type' => 'select',
    '#title' => t('Match type'),
    '#default_value' => variable_get('lexicon_match', 'b'),
    '#options' => array(
      'b' => t('Word'),
      'lr' => t('Right or left substring'),
      'l' => t('Left substring'),
      'r' => t('Right substring'),
      's' => t('Any substring'),
    ),
    '#description' => t('Choose the match type of lexicon links. "Word" means a word break must occur on both sides of the term. "Right or left" requires a word break on either side. "Left" requires a word break on the left side of the term. "Right" requires a word break on the right. "Any" means any substring will match.'),
  );
  $form['mark_terms']['match']['lexicon_case'] = array(
    '#type' => 'select',
    '#title' => t('Case sensitivity'),
    '#default_value' => variable_get('lexicon_case', '1'),
    '#options' => array(
      t('Case insensitive'),
      t('Case sensitive'),
    ),
    '#description' => t('Match either case sensitive or not. Case sensitive matches are not very resource intensive.'),
  );
  $form['mark_terms']['match']['lexicon_replace_all'] = array(
    '#type' => 'select',
    '#title' => t('Replace matches'),
    '#default_value' => variable_get('lexicon_replace_all', 1),
    '#options' => array(
      t('Only the first match'),
      t('All matches'),
    ),
    '#description' => t('Whether only the first match should be replaced or all matches.'),
  );
  $form['mark_terms']['match']['lexicon_blocking_tags'] = array(
    '#type' => 'textarea',
    '#title' => t('Blocked elements'),
    '#default_value' => variable_get('lexicon_blocking_tags', 'abbr acronym'),
    '#cols' => 60,
    '#rows' => 1,
    '#maxlength' => 512,
    '#description' => t('Which HTML elements (tags) should not include Lexicon links;
      that is, text within these elements will not be scanned for lexicon terms.
      Enter the list separated by a space and do not include < and > characters (e.g. h1 h2).
      To use a %span element to skip text, prefix the class name with a dot (e.g. ".skipping-this").
      All "a," "code," and "pre" elements will be skipped by default.
      ', array(
      '%span' => 'span',
    )),
  );
  $form['mark_terms']['indicator'] = array(
    '#type' => 'fieldset',
    '#title' => t('Link style'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
    '#states' => array(
      'invisible' => array(
        ':input[name="lexicon_mark_terms"]' => array(
          'checked' => FALSE,
        ),
      ),
    ),
  );
  $indicator_options = array(
    'template' => t('Use the template file: !template_file.', array(
      '!template_file' => '<em>lexicon-mark-term.tpl.php</em>',
    )),
    'superscript' => t('Superscript'),
    'icon' => t('Icon'),
    'iconterm' => t('Icon + Term in span'),
    'term' => t('Term in span'),
    'abbr' => t('Use !type element', array(
      '!type' => l(t('abbr'), 'http://www.w3.org/TR/html401/struct/text.html#edef-ABBR'),
    )),
    'acronym' => t('Use !type element', array(
      '!type' => l(t('acronym'), 'http://www.w3.org/TR/html401/struct/text.html#edef-ACRONYM'),
    )),
    'cite' => t('Use !type element', array(
      '!type' => l(t('cite'), 'http://www.w3.org/TR/html401/struct/text.html#edef-CITE'),
    )),
    'dfn' => t('Use !type element', array(
      '!type' => l(t('dfn'), 'http://www.w3.org/TR/html401/struct/text.html#edef-DFN'),
    )),
  );
  $form['mark_terms']['indicator']['lexicon_replace'] = array(
    '#type' => 'radios',
    '#title' => t('Term Indicator'),
    '#default_value' => variable_get('lexicon_replace', 'template'),
    '#options' => $indicator_options,
    '#description' => t('This determines how the the lexicon term will be marked in the content. The default template renderes a simple hyperlink and gives site developers more control over how terms are marked than the "preset options". The "phrase" items are linked to the standards in case you want to study them.'),
  );
  $form['mark_terms']['indicator']['lexicon_superscript'] = array(
    '#type' => 'textfield',
    '#title' => t('Superscript'),
    '#default_value' => variable_get('lexicon_superscript', 'i'),
    '#size' => 15,
    '#maxlength' => 255,
    '#description' => t('Enter the superscript text.'),
    '#states' => array(
      'visible' => array(
        ':input[name="lexicon_replace"]' => array(
          'value' => 'superscript',
        ),
      ),
    ),
  );
  $form['mark_terms']['indicator']['lexicon_icon'] = array(
    '#type' => 'textfield',
    '#title' => t('Lexicon Icon URL'),
    '#default_value' => variable_get('lexicon_icon', drupal_get_path('module', 'lexicon') . '/imgs/lexicon.gif'),
    '#size' => 50,
    '#maxlength' => 255,
    '#description' => t('Enter the URL of the lexicon icon relative to the root ("%root") of your Drupal site.', array(
      '%root' => base_path(),
    )),
  );

  // Since #states does not support "OR" a workaround is used:
  // http://api.drupal.org/api/drupal/includes!common.inc/function/
  // drupal_process_states/7#comment-24708.
  $all_options = array_keys($indicator_options);
  $visible = array(
    'icon',
    'iconterm',
  );
  foreach (array_diff($all_options, $visible) as $i => $option) {
    $form['mark_terms']['indicator']['lexicon_icon']['#states']['visible'][':input[name="lexicon_replace"], dummy-element' . $i] = array(
      '!value' => $option,
    );
  }
  $form['mark_terms']['indicator']['lexicon_link'] = array(
    '#type' => 'select',
    '#options' => array(
      'none' => t('none'),
      'normal' => t('normal'),
      'absolute' => t('absolute'),
    ),
    '#title' => t('Link type'),
    '#default_value' => variable_get('lexicon_link', 'normal'),
    '#description' => t('You may choose no linking of terms ("none"), standard site linking ("normal"), or "absolute" links. RSS feeds need absolute links to ensure they point back to this site. If you are not providing RSS feeds, it is better to choose one of the other types.'),
  );
  $form['mark_terms']['indicator']['lexicon_term_class'] = array(
    '#type' => 'textfield',
    '#title' => t('Term link class'),
    '#default_value' => variable_get('lexicon_term_class', 'lexicon-term'),
    '#description' => t('This is the style class that will be used for "acronym," "abbr," and "hovertip" links. It should only be used by those with specific site standards.'),
  );
  $form['mark_terms']['indicator']['lexicon_disable_indicator'] = array(
    '#type' => 'checkbox',
    '#title' => t('Allow the user to disable lexicon links.'),
    '#default_value' => variable_get('lexicon_disable_indicator', FALSE),
    '#description' => t('Determines whether or not the individual user may disable the Lexicon indicators.'),
  );
  $form['lexicon_clear_filter_cache_on_submit'] = array(
    '#type' => 'checkbox',
    '#title' => t('Clear the cache when settings are submitted.'),
    '#default_value' => TRUE,
    '#description' => t('Changes in the filter behaviour are only visible when the filter cache is flushed. This setting ensures that the filter cache is flushed when the settings are submitted.'),
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save configuration'),
    '#weight' => 5,
  );
  return $form;
}