Glossary helps newbies understand the jargon which always crops up when specialists talk about a topic. Doctors discuss CBC and EKG and CCs. Web developers keep talking about CSS, P2P, XSLT, etc. This is all intimidating for newbies.
The Glossary module scans posts for glossary terms (and their synonyms) in the body. If found, the glossary 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 glossary.
Glossary terms are managed as vocabularies within the taxonomy.module. To get started with glossary, 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 glossary entry and the description should be its definition. You can make use of the hierarchy, synonym, and related terms features. These features impact the display of the glossary when viewed in an overview.
Next, you have to set up the input formats with which you want to use the glossary. On the !input_formats page, select an input format to configure. Select the Glossary filter checkbox and press "Save configuration". Now proceed to the !glossary page and select the tab for the input format and select the vocabulary and other settings.
You can see how a vocabulary would function as a glossary by going to the !glossaries page and selecting the vocabulary to view.
Administration of glossary requires %permissions permissions.
',
array('%permissions' => join(', ',
array(t('administer taxonomy'), t('access administration pages'), t('administer filters'))),
'!taxonomy_admin' => l(t('administer >> content >> taxonomy'), 'admin/content/taxonomy'),
'!input_formats' => l(t('administer >> site configuration >> input formats'), 'admin/settings/filters'),
'!glossary' => l(t('administer >> site configuration >> glossary'), 'admin/settings/glossary'),
'!glossaries' => l(t('glossaries'), 'glossary')));
break;
case 'admin/settings/glossary':
return ''. t('This page and its tabs allow you to control how the Glossary module functions.') .'
';
break;
case 'admin/modules#description':
return t('Maintain one or more glossaries on your site.');
break;
case 'glossary':
if (!$args[1]) {
if (user_access('administer filters')) {
return t('Glossary settings page', array('!url' => url('admin/settings/glossary')));
}
}
break;
case 'glossary_search#noresults':
return t('
- Check if your spelling is correct.
- Remove quotes around phrases to match each word individually: "blue smurf" will match less than blue smurf.
- Consider loosening your query with OR: blue smurf will match less than blue OR smurf.
');
}
}
/**
* Implementation of hook_block().
*/
function glossary_block($op = 'list', $delta = 0, $edit = array()) {
$blocks = array();
switch ($op) {
case 'list':
$blocks[0]['info'] = t('Glossary: Search');
$blocks[1]['info'] = t('Glossary: Random');
return $blocks;
case 'view':
switch ($delta) {
case 0:
$blocks['subject'] = t('Search Glossary');
$blocks['content'] = drupal_get_form('glossary_search_form');
return $blocks;
case 1:
$interval = variable_get("glossary_block_{$delta}_interval", 0) * variable_get("glossary_block_{$delta}_step", 0);
$last = variable_get("glossary_block_{$delta}_last", 0);
if ($last + $interval < time()) {
// Time to get a new selection.
$saved_vids = variable_get("glossary_block_{$delta}_vids", NULL);
if (is_null($saved_vids)) {
$blocks['content'] = t('Glossary block !blk has not been configured.', array('!blk' => $delta));
return $blocks;
}
$vids = array_filter($saved_vids);
if (count($vids) == 0) {
$vids = _glossary_get_filter_vids();
}
$placeholders = implode(',', array_fill(0, count($vids), '%d'));
$tid = db_result(db_query_range('SELECT tid FROM {term_data} WHERE vid in ('. $placeholders .') ORDER BY RAND()', $vids, 0, 1));
// Set now as the last selection and save that tid.
variable_set("glossary_block_{$delta}_last", time());
variable_set("glossary_block_{$delta}_tid", $tid);
}
else {
// Get the current selected tid.
$tid = variable_get("glossary_block_{$delta}_tid", 0);
}
$term = taxonomy_get_term($tid);
// $blocks['content'] = theme('glossary_overview_item', $term, FALSE, NULL, TRUE);
$blocks['content'] = theme('glossary_block_term', $term, variable_get("glossary_block_{$delta}_link", TRUE));
return $blocks;
}
case 'configure':
$form = array();
switch ($delta) {
case 0:
// Search block - no config.
return $form;
case 1:
$vids = array();
$vid_list = _glossary_get_filter_vids();
foreach ($vid_list as $vid) {
$voc = taxonomy_vocabulary_load($vid);
$vids[$vid] = check_plain($voc->name);
}
$form['vids'] = array(
'#type' => 'checkboxes',
'#title' => t('Choose from'),
'#description' => t('Select the vocabularies from which to choose a term.'),
'#options' => $vids,
'#default_value' => variable_get("glossary_block_{$delta}_vids", array()),
'#prefix' => '',
'#suffix' => '
',
);
$form['interval'] = array(
'#type' => 'textfield',
'#size' => 4,
'#maxlength' => 3,
'#default_value' => variable_get("glossary_block_{$delta}_interval", 0),
'#field_prefix' => ''. t('Update every') .' ',
'#prefix' => '',
);
$form['step'] = array(
'#type' => 'select',
'#default_value' => variable_get("glossary_block_{$delta}_step", 0),
'#options' => array(
1 => t('seconds'),
60 => t('minutes'),
3600 => t('hours'),
86400 => t('days'),
),
'#suffix' => '
',
'#description' => t('How often do you want a new term? Leaving this blank or zero means every time.'),
);
$form['link'] = array(
'#type' => 'checkbox',
'#title' => t('Show term as link'),
'#default_value' => variable_get("glossary_block_{$delta}_link", TRUE),
'#description' => t('If selected, this option causes the term name to be made a link to the glossary entry.'),
);
return $form;
}
return $form;
case 'save':
switch ($delta) {
case 0:
// Search block - no config.
break;
case 1:
variable_set("glossary_block_{$delta}_vids", $edit['vids']);
if (!$edit['interval'] || !is_numeric($edit['interval'])) {
// Make interval numeric;
$edit['interval'] = 0;
}
variable_set("glossary_block_{$delta}_interval", $edit['interval']);
variable_set("glossary_block_{$delta}_step", $edit['step']);
variable_set("glossary_block_{$delta}_link", $edit['link']);
break;
}
}
}
/**
* Implementation of hook_menu().
*/
function glossary_menu() {
$items['glossary/search'] = array(
'title' => 'Glossary Search',
'page callback' => 'glossary_search_results',
'page arguments' => array(2),
'access arguments' => array('access content'),
'type' => MENU_CALLBACK,
);
$items['glossary/clearcache'] = array(
'title' => 'Glossary clear cache',
'page callback' => 'glossary_clearcache',
'access arguments' => array('administer filters'),
'type' => MENU_CALLBACK,
);
$items['glossary'] = array(
'title' => 'Glossary',
'page callback' => 'glossary_page',
'page arguments' => array(1, 2),
'access arguments' => array('access content'),
'type' => MENU_SUGGESTED_ITEM,
);
$items['admin/settings/glossary'] = array(
'title' => 'Glossary Settings',
'page callback' => 'glossary_settings_page',
'description' => 'Select how you want the Glossary module to behave.',
'access arguments' => array('administer filters'),
'type' => MENU_NORMAL_ITEM,
'file' => 'glossary.admin.inc',
);
$items['admin/settings/glossary/general'] = array(
'title' => 'General',
'description' => 'General settings',
'page callback' => 'drupal_get_form',
'page arguments' => array('glossary_general_settings_form'),
'access arguments' => array('administer filters'),
'type' => MENU_DEFAULT_LOCAL_TASK,
'weight' => -3,
'file' => 'glossary.admin.inc',
);
$items['admin/settings/glossary/alphabet'] = array(
'title' => 'Alphabet',
'access arguments' => array('administer filters'),
'page callback' => 'drupal_get_form',
'page arguments' => array('glossary_alphabet_form'),
'description' => 'Alphabet settings.',
'type' => MENU_LOCAL_TASK,
'weight' => 0,
'file' => 'glossary.admin.inc',
);
$items['admin/settings/glossary/clearcache'] = array(
'title' => 'Clear cache',
'access arguments' => array('administer filters'),
'page callback' => 'drupal_get_form',
'page arguments' => array('glossary_clearcache_form'),
'description' => 'Clear the filter cache.',
'type' => MENU_LOCAL_TASK,
'weight' => 0,
'file' => 'glossary.admin.inc',
);
$result = db_query('SELECT format, name FROM {filter_formats}');
while ($filter = db_fetch_array($result)) {
$format = $filter['format'];
$enabled = db_result(db_query("SELECT COUNT(delta) FROM {filters} WHERE format=%d AND module='glossary'", $format));
if ($enabled || !variable_get('glossary_hide_menus', FALSE)) {
$name = $filter['name'];
$items['admin/settings/glossary/filter/'. $format] = array(
'title' => '!name',
'title arguments' => array('!name' => $name),
'access arguments' => array('administer filters'),
'page callback' => 'drupal_get_form',
'page arguments' => array('glossary_filter_form', 4),
'description' => 'Settings for the !name input format.', array('!name' => $name),
'weight' => 2,
'type' => MENU_LOCAL_TASK,
'file' => 'glossary.admin.inc',
);
}
}
$items['glossary/term/%'] = array(
'title' => 'Glossary',
'page callback' => 'glossary_term',
'page arguments' => array(2),
'access arguments' => array('access content'),
'type' => MENU_CALLBACK,
);
return $items;
}
/**
* Implementation of hook_init().
*/
function glossary_init() {
drupal_add_css(drupal_get_path('module', 'glossary') .'/glossary.css');
}
function glossary_search_form($form_state, $keys = NULL) {
$form['#action'] = url('glossary/search');
$form['#attributes'] = array('class' => 'glossary search-form');
$form['keys'] = array(
'#type' => 'textfield',
'#title' => '',
'#default_value' => $keys,
'#size' => 15,
);
$form['search'] = array(
'#type' => 'submit',
'#value' => t('Search'),
);
return $form;
}
function glossary_search_form_submit($form, &$form_state) {
$keys = trim($form_state['values']['keys']);
$form_state['redirect'] = 'glossary/search/'. $keys;
}
function glossary_search_results($keys = NULL) {
$vids = _glossary_get_filter_vids();
$output = '';
$sql = db_rewrite_sql("SELECT t.tid FROM {term_data} t WHERE t.vid IN (". db_placeholders($vids) .") AND (t.description LIKE '%%%s%%' OR t.name LIKE '%%%s%%')", 't}', 'tid');
$vars = $vids;
// Yes, we need this twice.
$vars[] = $keys;
$vars[] = $keys;
$result = db_query($sql, $vars);
$found = NULL;
while ($row = db_fetch_object($result)) {
++$count;
$term = taxonomy_get_term($row->tid);
$found .= '
'. theme('glossary_overview_item', $term, TRUE) .'
';
}
if (!$found) {
$found = drupal_get_form('glossary_search_form', $keys) .'
'. t('Your search yielded no results') . glossary_help('glossary_search#noresults') .'
';
}
$output .= theme('box', t('Glossary search results'), $found);
return $output ."
'. drupal_render($form) .'
';
}
/**
* Implementation of hook_theme.
*/
function glossary_theme() {
return array(
'glossary_search_form' => array(
'arguments' => array('form'),
),
'glossary_overview_item' => array(
'arguments' => array('term', 'show_desc', 'destination'),
),
'glossary_block_term' => array(
'arguments' => array('term', 'link'),
),
);
}
function glossary_term($tid) {
$result = db_query(db_rewrite_sql('SELECT * FROM {term_data} t WHERE t.tid=%d', 't', 'tid'), $tid);
$output .= ''."\n";
while ($row = db_fetch_object($result)) {
$term = taxonomy_get_term($row->tid);
$output .= '
'. theme('glossary_overview_item', $term, TRUE) .'
';
$vid = $row->vid;
}
$output .= "
'. $output;
return $output;
}
function glossary_filter_tips($delta, $format, $long = FALSE) {
$block_tags = explode(' ', variable_get("glossary_blocking_tags_$format", 'abbr acronym'));
$standard_blocks = array('a', 'code', 'pre');
foreach ($standard_blocks as $tag) {
if (!in_array($tag, $block_tags)) {
$block_tags[] = $tag;
}
}
foreach ($block_tags as $key => $tag) {
if ($tag[0] == '.') {
$block_tags[$key] = 'span class="'. drupal_substr($tag, 1) .'"';
}
}
sort($block_tags, SORT_STRING);
$blocked = implode(', ', $block_tags);
$more = ' '. t('Additionally, these HTML elements will not be scanned: %blocked.', array('%blocked' => $blocked));
if ($long) {
return t('The Glossary module will automatically mark terms that have been defined in the glossary vocabulary with links to their descriptions. These marks depend on the settings and may be a superscript character or an icon, or the term may be turned into an acronym, cite, or abbreviation. If there are certain phrases or sections of text that should be excluded from glossary marking and linking, use the special markup, [no-glossary] ... [/no-glossary].') . $more;
}
else {
return t('Glossary terms will be automatically marked with links to their descriptions. If there are certain phrases or sections of text that should be excluded from glossary marking and linking, use the special markup, [no-glossary] ... [/no-glossary].') . $more;
}
}
function glossary_filter($op, $delta = 0, $format = -1, $text = "") {
switch ($op) {
case 'list':
return array(0 => t('Glossary filter'));
case 'description':
return t('Maintain one or more glossaries on your site.');
case 'process':
return _glossary_filter_process($format, $text);
// case 'settings':
// return _glossary_filter_settings($format);
case 'no cache':
return FALSE;
default:
return $text;
}
}
/**
* Implementation of hook_user().
*/
function glossary_taxonomy($op, $type, $array = NULL) {
if ($array) {
_glossary_clear_cache($array['vid']);
}
}
/**
* Implementation of hook_user().
*/
function glossary_user($type, $edit, $user) {
switch ($type) {
case 'form':
// Note: this requires a setting. Do we also need to clear cache if selected?
if (variable_get('glossary_disable_indicator', FALSE)) {
$form['content_glossary'] = array(
'#type' => 'fieldset',
'#title' => t('Glossary Indicators'),
);
$form['content_glossary']['glossary_disable_indicator'] = array(
'#type' => 'checkbox',
'#title' => t('Disable Glossary indicators'),
'#return_value' => 1,
'#default_value' => $user->glossary_disable_indicator,
'#description' => t('Check this box to disable the display of Glossary indicators.'),
);
return $form;
}
break;
}
}
function _glossary_filter_process($format, $text) {
global $user;
if ($user->glossary_disable_indicator && variable_get('glossary_disable_indicator', FALSE)) {
return $text;
}
if (variable_get("glossary_vids_$format", 0)) {
$text = ' '. $text .' ';
$replace_mode = variable_get("glossary_replace_$format", 'superscript');
$link_style = variable_get("glossary_link_$format", 'normal');
$absolute_link = ($link_style == 'absolute');
$terms = _glossary_get_terms($format);
$vids = _glossary_get_filter_vids();
$terms_replace = array();
foreach ($terms as $term) {
// $term_title = strip_tags($term->description);
$term_title = filter_xss($term->description);
$fragment = NULL;
if ($term->nodes > 0) {
$linkto = taxonomy_term_path($term);
}
elseif (!empty($vids) && (variable_get('glossary_click_option', 0) == 1)) {
if (variable_get('glossary_page_per_letter', FALSE)) {
$linkto = 'glossary/'. $term->vid .'/letter'. drupal_strtolower(drupal_substr($term->name, 0, 1));
}
else {
$linkto = 'glossary/'. $term->vid;
}
$fragment = 'term'. $term->tid;
}
else {
$linkto = 'glossary/term/'. $term->tid;
}
$ins_before = $ins_after = NULL;
$term_class = variable_get('glossary_term_class', 'glossary-term');
// Let's try to get Drupal to show non-Latin letters right.
$linkto = decode_entities($linkto);
switch ($replace_mode) {
case 'superscript':
$ins_after = '';
if ($link_style == 'none') {
$ins_after .= variable_get("glossary_superscript_$format", 'i');
}
else {
$ins_after .= l(variable_get("glossary_superscript_$format", 'i'), $linkto,
array('attributes' => array('title' => $term_title, 'class' => 'glossary-indicator'),
'fragment' => $fragment, 'absolute' => $absolute_link));
}
$ins_after .= '';
break;
case 'abbr':
if ($link_style == 'none') {
$ins_before .= '<'. $replace_mode .' title="'. $term_title .'">';
$ins_after .= '';
}
else {
$ins_before .= '<'. $replace_mode .' title="'. $term_title .'">';
$ins_after .= '';
}
break;
// TODO: remove first case after a while.
case 'acronym link':
$replace_mode = 'acronym';
case 'acronym':
case 'cite':
case 'dfn':
if ($link_style == 'none') {
$ins_after .= '';
}
else {
$ins_before .= '';
$ins_after .= '';
}
$ins_before .= '<'. $replace_mode .' title="'. $term_title .'">';
break;
case 'hovertip':
if ($link_style == 'none') {
$ins_after .= '';
}
else {
$ins_before = '';
$ins_after .= '';
}
$ins_before .= '';
$ins_after .= ''. $term->image . $term_title .'';
break;
default:
// Icon format.
$img = ' . variable_get()
";
if ($link_style == 'none') {
$ins_after .= $img;
}
else {
$ins_after = l($img, $linkto,
array('attributes' => array('title' => $term_title, 'class' => 'glossary-icon'),
'fragment' => $fragment, 'absolute' => $absolute_link, 'html' => TRUE));
}
break;
}
// Replace term and synonyms with the desired new HTML code.
$terms_replace[] = array(
'synonyms' => $term->synonyms,
'ins_before' => decode_entities($ins_before, array('"')),
'ins_after' => decode_entities($ins_after, array('"')),
);
}
return _glossary_insertlink($format, $text, $terms_replace);
}
return $text;
}
/**
* Insert glossary links to $text after every matching $terms[i]['synonyms'] that is not inside a blocking tag.
* $terms[i]['ins_before'] is prepended to the matches, $terms[i]['ins_after'] is appended to them.
* Match type and replace mode all depend on user settings.
* The text is scanned once for all blocking tags and matches, then those 'events' are sorted and handled one by one.
*/
function _glossary_insertlink($format, &$text, &$terms) {
$multibyte_enabled = extension_loaded('mbstring');
if ($multibyte_enabled) {
$mb_prefix = 'mb_';
}
else {
$mb_prefix = NULL;
}
$case_sensitive = variable_get("glossary_case_$format", '1');
// $findfunc = $mb_prefix . ($case_sensitive ? 'strpos' : 'stripos');
$findfunc = $mb_prefix .'strpos';
$findtagfunc = $mb_prefix .'strpos';
$replaceall = variable_get("glossary_replace_all_$format", 0);
$events = array();
// Find blocking tags.
$open_tags = array('[no-glossary]', '<', '', '', '', '', '[/code]');
// use these always/when Codefilter module is on?
// array('< ?php ', '[?php ', '<% ', '[% ', '[codefilter_');
// array('?'.'>', '?]', '%'.'>', '%]', '[/codefilter_');
$user_tags = explode(' ', variable_get("glossary_blocking_tags_$format", 'abbr acronym'));
foreach ($user_tags as $tag) {
if (!empty($tag)) {
if (ctype_alnum($tag)) {
$open_tags[] = "<$tag";
$close_tags[] = "";
}
else if ($tag[0] == '.') {
$open_tags[] = '";
}
}
}
$searchtext = $case_sensitive ? $text : drupal_strtolower($text);
foreach ($open_tags as $i => $tag) {
$offset=0;
while (($offset = $findtagfunc($searchtext, $tag, $offset)) !== FALSE) {
// Longer tags will override shorter '<' on the same offset.
$events[$offset] = array('type' => 'open', 'which' => $i);
$offset += drupal_strlen($tag);
}
}
// Find match candidates.
foreach ($terms as $i => $term) {
foreach ($term['synonyms'] as $synonym) {
if (!$case_sensitive) {
$synonym = drupal_strtolower($synonym);
}
$offset=0;
$first_match_found = FALSE;
while (($offset = $findfunc($searchtext, $synonym, $offset)) !== FALSE) {
$len = drupal_strlen($synonym);
$match = drupal_substr($text, $offset, $len);
// Only longer matches override shorter ones.
if (!isset($events[$offset]) || drupal_strlen($events[$offset]['match']) < drupal_strlen($match)) {
// Get synonym with case as in text.
$events[$offset] = array('type' => 'match', 'which' => $i, 'match' => $match);
if (!$replaceall) {
$first_match_found = TRUE;
break;
}
}
$offset += $len;
}
//TODO: remove this if we want different synonyms of the same term to be matched independently as 'first matches'
if ($first_match_found && !$replaceall) {
break;
}
}
}
ksort($events);
$newtext = '';
$parsed = 0; // Text was parsed from chars 0 to $parsed (exclusive).
foreach ($events as $place => $event) {
// Skip events inside blocking tag (they're already copied as is).
if ($place < $parsed) {
continue;
}
// Copy plain text (with no events).
$newtext .= drupal_substr($text, $parsed, ($place - $parsed));
$parsed = $place;
// If a blocking tag is opened, skip to closing tag.
if ($event['type'] == 'open') {
$skip = $findtagfunc($text, $close_tags[$event['which']], $place);
if ($skip === FALSE) {
$skip = drupal_strlen($text);
}
// If the tag is [no-glossary] - remove it with the closing tag (by incrementing $parsed without copying).
if ($event['which'] == 0) {
$parsed += drupal_strlen($open_tags[$event['which']]);
$newtext .= drupal_substr($text, $parsed, ($skip - $parsed));
$parsed = $skip + drupal_strlen($close_tags[$event['which']]);
}
// Copy text without changing it.
else {
$newtext .= drupal_substr($text, $parsed, ($skip - $parsed));
$parsed = $skip;
}
}
if ($event['type'] == 'match') {
$matchlen = drupal_strlen($event['match']);
$proper_match = FALSE;
switch (variable_get("glossary_match_$format", 'b')) {
case 'lr': // Require word break left or right.
// $proper_match = (_glossary_is_boundary($text {$next - 1}) || _glossary_is_boundary($text {$next + $matchlen}));
$proper_match = (_glossary_is_boundary(drupal_substr($text, $place - 1, 1)) ||
_glossary_is_boundary(drupal_substr($text, $place + $matchlen, 1 )));
break;
case 'b': // Require word break left and right.
// $proper_match = (_glossary_is_boundary($text {$next - 1}) && _glossary_is_boundary($text {$next + $matchlen}));
$proper_match = (_glossary_is_boundary(drupal_substr($text, $place - 1, 1)) &&
_glossary_is_boundary(drupal_substr($text, $place + $matchlen, 1)));
break;
case 'l': // Require word break left.
// $proper_match = _glossary_is_boundary($text {$next - 1});
$proper_match = _glossary_is_boundary(drupal_substr($text, $place - 1, 1));
break;
case 'r': // Require word break right.
// $proper_match = _glossary_is_boundary($text {$next + $matchlen});
$proper_match = _glossary_is_boundary(drupal_substr($text, $place + $matchlen, 1));
break;
case 's': // Match any substring.
default:
$proper_match = TRUE;
break;
}
if ($proper_match) {
$newtext .= $terms[$event['which']]['ins_before'] . $event['match'] . $terms[$event['which']]['ins_after'];
$parsed += $matchlen;
}
}
}
// Append remaining part.
return $newtext . drupal_substr($text, $parsed);
}
function glossary_page($vid = NULL, $letter = NULL) {
$vids = _glossary_get_filter_vids();
$found = FALSE;
if (!$vid) {
if (count($vids) == 1) {
$vid = $vids[0];
$found = TRUE;
}
}
else {
$found = array_search($vid, $vids);
}
if (!$vid || $found === FALSE) {
$breadcrumb = array(l(t('Home'), NULL));
drupal_set_title(t('Glossaries'));
drupal_set_breadcrumb($breadcrumb);
return _glossary_list();
}
else {
$voc = taxonomy_vocabulary_load($vid);
$breadcrumb = array(l(t('Home'), NULL));
if (count($vids) > 1) {
$breadcrumb[] = l(t('Glossaries'), 'glossary');
}
drupal_set_title($voc->name);
drupal_set_breadcrumb($breadcrumb);
return glossary_overview($voc, $letter);
}
}
function _glossary_alphabar($vid, &$tree) {
$page_per_letter = variable_get('glossary_page_per_letter', FALSE);
if (variable_get('glossary_suppress_unused', FALSE)) {
// Just make it empty; it will be filled in below.
$letters = array();
}
else {
$lets = array_merge(variable_get('glossary_alphabet', range('a', 'z')), variable_get('glossary_digits', range('0', '9')));
$letters = drupal_map_assoc($lets);
}
foreach ($tree as $key => $term) {
$term->let = drupal_strtolower(drupal_substr($term->name, 0, 1));
if ($page_per_letter) {
$letters[$term->let] = l($term->let, 'glossary/'. $vid .'/letter'. $term->let);
}
else {
$letters[$term->let] = l($term->let, 'glossary/'. $vid, array('fragment' => 'letter'. $term->let));
}
}
$sep = ' '. variable_get('glossary_alphabar_separator', '|') .' ';
$output = ''. implode($sep, $letters);
$output .= '
';
$output .= variable_get('glossary_alphabar_instruction', _alphabar_instruction_default());
$output .= "
';
if ($vocab->description) {
$output .= '
'. $vocab->description .'
';
}
$vid = $vocab->vid;
if ($letter) {
$letter = drupal_substr($letter, 6, 1, 'UTF-8');
}
$current_let = '';
$no_overview = (variable_get('glossary_click_option', 0) == 0) && (variable_get('glossary_page_per_letter', FALSE) == TRUE);
$show_desc = variable_get('glossary_show_description', FALSE);
$separate = variable_get('glossary_separate_letters', FALSE);
$tree = taxonomy_get_tree($vid);
$synonyms = _glossary_get_synonyms($vid);
$output .= _glossary_alphabar($vid, $tree);
$output .= '
'."\n";
if ($tree) {
foreach ($tree as $term) {
$term->synonyms = $synonyms[$term->tid];
// See if it's a new section.
// If we're looking for a single letter, see if this is it.
if ((!$no_overview && !$letter) || $term->let == $letter) {
// See if it's a new section.
if ($term->let != $current_let) {
$output .= "\n".'';
if ($separate) {
$output .= ''. $term->let .'
';
}
$current_let = $term->let;
}
$output .= theme('glossary_overview_item', $term, $show_desc, $dest);
}
}
if ($current_let != '') {
$output .= '
';
}
}
$output .= '
';
$text = NULL;
$detailed = db_query(db_rewrite_sql('SELECT t.nid FROM {term_node} t JOIN {node} n USING (nid) WHERE t.tid=%d AND n.status=1'), $term->tid);
while ($row = db_fetch_array($detailed)) {
$node = node_load($row['nid']);
// Format as teaser view with links.
$text .= node_view($node, TRUE, FALSE, TRUE);
}
if ($text) {
$fieldset = array(
'#title' => t('Detailed definition of @term', array('@term' => $term->name)),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#value' => $text,
);
$output .= theme('fieldset', $fieldset);
}
$output .= "
\n";
}
else {
$output .= ''.
l(t('Detailed definition of @term', array('@term' => $term->name)), taxonomy_term_path($term))
.'
';
}
}
}
// return htmlspecialchars_decode($output);
return decode_entities($output);
}
function theme_glossary_block_term($term, $link = TRUE) {
global $base_url;
static $click_option, $link_related, $one_way, $tax_img_avail;
if (!isset($click_option)) {
$click_option = variable_get('glossary_click_option', 0);
$link_related = variable_get('glossary_link_related', TRUE);
$one_way = variable_get('glossary_link_related_how', FALSE);
$tax_img_avail = module_exists('taxonomy_image');
}
if ($tax_img_avail) {
$img = taxonomy_image_display($term->tid);
if ($img) {
$obj = taxonomy_image_get_object($term->tid);
$img = ''. $img .'';
}
}
else {
$img = NULL;
}
$output .= '';
$output .= $link ? l($term->name, 'glossary/term/'. $term->tid) : check_plain($term->name);
$output .= "
\n";
$output .= '';
$output .= $term->description ? check_markup($term->description) : NULL;
$output .= "
\n";
if ($relations = glossary_get_related($term->tid, 'name', $one_way)) {
$output .= ''. t('See also') .': ';
$items = array();
foreach ($relations as $related) {
if ($link_related) {
if ($click_option == 1) {
$items[] .= l($related->name, 'glossary/'. $term->vid, array('fragment' => 'term'. $related->tid));
}
else {
$items[] .= l($related->name, 'glossary/term/'. $related->tid);
}
}
else {
$items[] .= check_plain($related->name);
}
}
$output .= implode(', ', $items) ."\n";
}
if ($term->synonyms) {
$output .= ''. t('Synonyms') .': ';
$output .= implode(', ', $term->synonyms) ."\n";
}
// return htmlspecialchars_decode($output);
return decode_entities($output);
}
function glossary_admin_links($vocabulary, $destination) {
$output = '';
$links = array();
if (user_access('administer taxonomy')) {
$links['glossary_add_term'] = array(
'title' => t('Add term'),
'href' => 'admin/content/taxonomy/'. $vocabulary->vid .'/add/term',
);
$links['glossary_edit'] = array(
'title' => decode_entities(t('Edit @name', array('@name' => drupal_strtolower($vocabulary->name)))),
'href' => 'admin/content/taxonomy/edit/vocabulary/'. $vocabulary->vid,
'query' => $destination,
);
}
if (user_access('administer filters')) {
$links['glossary_admin'] = array(
'title' => t('Glossary settings'),
'href' => 'admin/settings/glossary',
'query' => $destination,
);
}
if (!empty($links)) {
$output .= theme('links', $links);
}
return $output .'
';
}
function _glossary_list() {
$output = "";
$destination = drupal_get_destination();
$vids = _glossary_get_filter_vids();
$vocs = array();
foreach ($vids as $vid) {
$voc = taxonomy_vocabulary_load($vid);
$vocs[$voc->name] = $voc;
}
uksort($vocs, _glossary_cmp_strcase);
$eo = array('even', 'odd');
$i = 0;
$output .= '| '. t("Glossary name") .' | '. t('Operations') .' |
|---|
';
foreach ($vocs as $voc) {
$links = array();
$class = $eo[++$i & 1];
if (user_access('administer taxonomy')) {
$links['glossary_edit'] = array(
'title' => t('Edit @name', array('@name' => drupal_strtolower($vocabulary->name))),
'href' => 'admin/content/taxonomy/edit/vocabulary/'. $voc->vid,
'query' => $destination,
);
}
$links['glossary_view'] = array(
'title' => t('List'),
'href' => 'glossary/'. $voc->vid,
);
if ($voc->description) {
$output .= '| '. $voc->name .' | '. theme('links', $links) .' |
|---|
';
$output .= '| '. $voc->description .' |
';
}
else {
$output .= '';
$output .= '| '. $voc->name .' | '. theme('links', $links) .' |
';
}
}
// Were there any rows produced?
if ($i == 0) {
$output .= '| '. t('No applicable vocabularies were found, please check your settings.') .' |
';
}
$output .= '
';
return $output;
}
function _glossary_get_terms($format) {
static $terms = FALSE;
$show_all = variable_get('glossary_allow_no_description', FALSE);
$taxonomy_image_enabled = module_exists('taxonomy_image');
if ($terms === FALSE) {
$terms = $synonyms = array();
$vids = variable_get("glossary_vids_$format", 0);
foreach ($vids as $vid) {
$synonyms = _glossary_get_synonyms($vid);
// Get all glossary terms and attach synonyms.
// Omit terms without a description. those are usually container terms.
$result = db_query(db_rewrite_sql("SELECT t.tid, t.name, t.description, COUNT(tn.nid) as nodes FROM {term_data} t LEFT JOIN {term_node} tn USING(tid) WHERE t.vid=%d GROUP BY t.tid, t.name, t.description ORDER BY LENGTH(t.name) DESC", 't', 'tid'), $vid);
while ($term = db_fetch_object($result)) {
if ($term->nodes) {
// If there were any nodes attached, we need to see if they were unpublished.
$unpubs = db_result(db_query(db_rewrite_sql("SELECT COUNT(n.nid) FROM {term_node} tn JOIN {node} n USING (nid) WHERE tn.tid=%d AND n.status=0"), $term->tid));
$term->nodes -= $unpubs;
}
if ($term->description || $show_all) {
$term->synonyms = $synonyms[$term->tid];
$term->synonyms[] = filter_xss($term->name);
$term->vid = $vid;
$terms[] = $term;
}
if ($taxonomy_image_enabled) {
$term->image = taxonomy_image_display($term->tid);
}
else {
$term->image = NULL;
}
}
}
}
return $terms;
}
/**
* Find all term objects related to a given term ID.
* Adapted from taxonomy.module.
*
* @param $tid
* the term id to look up (int).
* @param $one_way
* whether to do one-way or two-way relations (bool).
* @return
* an array related-tid => related-name
*
*/
function glossary_get_related($tid, $key = 'tid', $one_way = FALSE) {
if ($tid) {
$related = array();
$qargs = array_fill(0, 3, $tid);
if ($one_way) {
$result = db_query('SELECT r.tid2 FROM {term_relation} r WHERE r.tid1 = %d ORDER BY r.tid2', $qargs);
while ($term = db_fetch_object($result)) {
// Hope that taxonomy has this cached to save a query.
$rel = taxonomy_get_term($term->tid2);
$related[$rel->$key] = $rel;
}
}
else {
// Two-way (normal taxonomy function).
$result = db_query('SELECT t.*, tid1, tid2 FROM {term_relation}, {term_data} t WHERE (t.tid = tid1 OR t.tid = tid2) AND (tid1 = %d OR tid2 = %d) AND t.tid != %d ORDER BY weight, name', $qargs);
while ($term = db_fetch_object($result)) {
$related[$term->$key] = $term;
}
}
return $related;
}
else {
return array();
}
}
// Get all synonyms for all glossary terms.
function _glossary_get_synonyms($vid) {
$result = db_query(db_rewrite_sql('SELECT ts.tid, ts.name FROM {term_synonym} ts JOIN {term_data} t USING(tid) WHERE t.vid=%d', 't', 'tid'), $vid);
while ($synonym = db_fetch_object($result)) {
$synonyms[$synonym->tid][] = filter_xss($synonym->name);
}
return $synonyms;
}
function _glossary_is_boundary($char) {
if (extension_loaded('mbstring')) {
return (mb_strpos("!\"#\$%&'()*+,-./:;<=>?@[\]^_`{|}~’ “”´°®©¼½¾ \t\n\r", $char) !== FALSE);
}
else {
return (strpos("!\"#\$%&'()*+,-./:;<=>?@[\]^_`{|}~’ “”´°®©¼½¾ \t\n\r", $char) !== FALSE);
}
}
// Natively only available in PHP 5+
// WARNING: Eats a tremendous amount of memory!
if (!function_exists("stripos")) {
function stripos($haystack, $needle, $offset = 0) {
return strpos(drupal_strtoupper($haystack), drupal_strtoupper($needle), $offset);
}
}
if (!function_exists("mb_stripos")) {
function mb_stripos($haystack, $needle, $offset = 0) {
return mb_strpos(drupal_strtoupper($haystack), drupal_strtoupper($needle), $offset);
}
}
// Menu call back for link on settings page.
function glossary_clearcache() {
cache_clear_all('*', 'cache_filter', TRUE);
drupal_set_message(t('Cache_filter cleared.'));
drupal_goto('/glossary');
}
function _glossary_clear_cache($format=NULL) {
// We could throw less things away if we checked which filter formats
// used the glossary filter, and we only threw those away. In practice,
// most if not all formats would use the glossary filter, so we just
// get rid of them all.
if ($format) {
$wildcard = $format .':';
}
else {
$wildcard = '*';
}
cache_clear_all($wildcard, 'cache_filter', TRUE);
drupal_set_message(t('The filter cache has been cleared. There may be a temporary performance degradation while it is rebuilt.'));
}
/**
* Get an array of all vocabulary IDs associated with Glossary.
*
* @param
* None.
*
* @return
* An array of vids.
*/
function _glossary_get_filter_vids() {
// We can't use filter_formats() here, because we need all input formats,
// not just those we are allowed to post in.
$vids = array();
$result = db_query('SELECT format FROM {filter_formats}');
while ($format = db_fetch_object($result)) {
$filters = filter_list_format($format->format);
foreach ($filters as $filter) {
if ($filter->module == "glossary") {
$vids = array_merge($vids, variable_get("glossary_vids_". $format->format, array()));
}
}
}
return array_unique($vids);
}
function _glossary_cmp_strcase($a, $b) {
return strcmp(drupal_strtolower($a), drupal_strtolower($b));
}
function _alphabar_instruction_default() {
if (variable_get('glossary_page_per_letter', FALSE)) {
return t('Click one of the letters above to be taken to a page of all terms beginning with that letter.');
}
else {
return t('Click one of the letters above to advance the page to terms beginning with that letter.');
}
}