Terms highlighting plugin

<?php
/**
 * Allows definition of term which is then highlighted using <acronym> tag throughout the page:
 * Example:
 * <term Title>description</term>
 * All occurences of 'title' will be rendered as acronym with 'description' popup.
 * Title parameter is not case sensitive.
 * TODO: Acronym tags defined inside acronyms.conf or acronyms.local.conf cannot be overriden.
 * Termadd is term registering plugin, Termshow is needed to display terms
 *
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Pavel Vitis <pavel [dot] vitis [at] seznam [dot] cz>
 */
 
if (!defined('DOKU_INC')) {
  define('DOKU_INC',realpath(dirname(__FILE__).'/../../').'/');
}
if (!defined('DOKU_PLUGIN')) {
  define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
}
require_once(DOKU_PLUGIN.'syntax.php');
 
global $terms;
if (!isset($terms)) {
  $terms = array();
}
 
/**
 * All DokuWiki plugins to extend the parser/rendering mechanism
 * need to inherit from this class
 */
class syntax_plugin_term_add extends DokuWiki_Syntax_Plugin {
 
    /**
     * return some info
     */
    function getInfo(){
        return array(
            'author' => 'Pavel Vitis',
            'email'  => 'pavel.vitis@seznam.cz',
            'date'   => '2005-08-17',
            'name'   => 'Terms registering plugin',
            'desc'   => 'Definition of term which is then highlighted using <acronym> tag throughout the page',
            'url'    => 'http://wiki.splitbrain.org/plugin:term',
        );
    }
 
    /**
     * What kind of syntax are we?
     */
    function getType(){
      return 'substition';
    }
 
   /**
    * Paragraph Type
    *
    * Defines how this syntax is handled regarding paragraphs. This is important
    * for correct XHTML nesting. Should return one of the following:
    *
    * 'normal' - The plugin can be used inside paragraphs
    * 'block'  - Open paragraphs need to be closed before plugin output
    * 'stack'  - Special case. Plugin wraps other paragraphs.
    *
    * @see Doku_Handler_Block
    */
    function getPType() {
      return 'normal';
    }
 
    /**
     * Where to sort in?
     */
    function getSort() {
      // Somewhere on the beginning
      return 09;
    }
 
    /**
     * Connect pattern to lexer
     */
    function connectTo($mode) {
      $this->Lexer->addEntryPattern('<term\s{1,}(?=.*\x3C/term\x3E)',$mode,'plugin_term_add');
    }
 
    function postConnect() {
      $this->Lexer->addExitPattern('</term>','plugin_term_add');
    }
 
    /**
     * Handle the match
     */
    function handle($match, $state, $pos, &$handler){
      switch ($state) {
        case DOKU_LEXER_UNMATCHED:
          $parts = explode('>', $match);
          $this->_replaceTerm(trim($parts[0]), trim($parts[1]));
          return array($match, $state);
          break;
        default:
          return array($match, $state);
      }
    }
 
    /**
     * Create output
     */
    function render($mode, &$renderer, $data) {
      return false;
    }
 
    function _replaceTerm($def, $desc) {
      global $terms;
      $terms[strtoupper($def)] = $desc;
    }
}
 
//Setup VIM: ex: et ts=4 enc=utf-8 :
 
 

<?php
/**
 * Allows definition of term which is then highlighted using <acronym> tag throughout the page:
 * Example:
 * <term Title>description</term>
 * All occurences of 'title' will be rendered as acronym with 'description' popup.
 * Title parameter is not case sensitive.
 * TODO: Acronym tags defined inside acronyms.conf or acronyms.local.conf cannot be overriden.
 * Termshow is term displaying plugin, Termadd is needed to register term first
 *
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Pavel Vitis <pavel [dot] vitis [at] seznam [dot] cz>
 */
 
if (!defined('DOKU_INC')) {
  define('DOKU_INC',realpath(dirname(__FILE__).'/../../').'/');
}
if (!defined('DOKU_PLUGIN')) {
  define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
}
require_once(DOKU_PLUGIN.'syntax.php');
 
global $terms;
if (!isset($terms)) {
  $terms = array();
}
 
/**
 * All DokuWiki plugins to extend the parser/rendering mechanism
 * need to inherit from this class
 */
class syntax_plugin_term_show extends DokuWiki_Syntax_Plugin {
 
    /**
     * return some info
     */
    function getInfo(){
        return array(
            'author' => 'Pavel Vitis',
            'email'  => 'pavel.vitis@seznam.cz',
            'date'   => '2005-08-17',
            'name'   => 'Terms highlight plugin',
            'desc'   => 'Definition of term which is then highlighted using <acronym> tag throughout the page',
            'url'    => 'http://wiki.splitbrain.org/plugin:term',
        );
    }
 
    /**
     * What kind of syntax are we?
     */
    function getType(){
      return 'substition';
    }
 
   /**
    * Paragraph Type
    *
    * Defines how this syntax is handled regarding paragraphs. This is important
    * for correct XHTML nesting. Should return one of the following:
    *
    * 'normal' - The plugin can be used inside paragraphs
    * 'block'  - Open paragraphs need to be closed before plugin output
    * 'stack'  - Special case. Plugin wraps other paragraphs.
    *
    * @see Doku_Handler_Block
    */
    function getPType() {
      return 'normal';
    }
 
    /**
     * Where to sort in?
     */
    function getSort() {
      // This should be larger than acronym sort, otherwise it conflicts with it
      return 500;
    }
 
    function connectTo($mode) {
       $this->Lexer->addSpecialPattern('(?<=\b)[a-zA-Z]+(?=\b)',$mode,'plugin_term_show');
    }
 
    /**
     * Handle the match
     */
    function handle($match, $state, $pos, &$handler){
       global $terms;
       // save some useless processing
       if (count($terms) > 0) {
           $word = $match;
           // save some useless processing, do not allow words shorter than 2 characters
           if ($word != '' && strlen($word) > 2) {
               $word = strtoupper($word);
               if (array_key_exists($word, $terms)) {
                   return array($match, $state, $terms[$word]);
               }
           }
       }
       return array($match, $state);
    }
 
    /**
     * Create output
     */
    function render($mode, &$renderer, $data) {
        global $terms;
        if($mode == 'xhtml'){
          if (!empty($data[2])) {
            $renderer->doc .= $this->_renderTerm($renderer, $data[0], $data[2]);
          }
          else {
            $renderer->doc .= ''.$data[0].'';
          }
          return true;
        }
        return false;
    }
 
    function _renderTerm(&$renderer, $term, $descr) {
      return '<acronym class="term" title="'.$renderer->_xmlEntities($descr).'">'.$term.'</acronym>';
    }
}
 
//Setup VIM: ex: et ts=4 enc=utf-8 :
 
 

acronym.term {
  border-bottom: 1px dashed;
}