Revision [8125]

This is an old revision of AcronymFormatter made by DarTar on 2005-05-14 10:23:23.

 

Acronym (or Abbreviation) Formatter


This is the development page for the Acronym (or Abbreviation) Formatter.
 

This modification allows Wikka to automatically parse known acronyms and render them as <acronym> elements with titles, for example:

CSS - FAQ - HTML

The list of acronyms can be set by the WikiAdmin in a configuration file: each time an acronym is found in the page source matching one of the entries of this file, it is automatically rendered with the appropriate markup and expanded description.

Features



To do



The code

Here's the list of files that you will have to create or modify (backup the original files before making any modification)

1. Modify ./formatters/wakka.php

original:
  1. // we're cutting the last <br />
  2. $text = preg_replace("/<br \/>$/","", $text);
  3.  
  4. echo ($text);
  5. wakka2callback('closetags');


modified:
  1. // we're cutting the last <br />
  2. $text = preg_replace("/<br \/>$/","", $text);
  3.  
  4. //render acronyms
  5. if ($this->GetConfigValue('enable_acronyms') == 1) {
  6.     $text = preg_replace_callback('/([A-Z]{2,})/', array(&$this,'AcronymTableLookup'), $text); # REGEX pattern matching sequences of 2 or more capital letters
  7. }
  8.  
  9. echo ($text);


2. Modify wikka.php

Add the following function in the code, for instance immediately before the VARIABLES section:

original:
  1.     // VARIABLES


modified:
  1.     /**
  2.      * Look up and return acronym definition from a configuration file.
  3.      *
  4.      * @author      {@link http://wikka.jsnx.com/DarTar DarioTaraborelli}
  5.      * @version     0.1
  6.      *
  7.      * @access      public
  8.      * @uses        GetConfigValue()
  9.      *
  10.      * @param       array  $matches  array of matching strings sent from the formatter
  11.      * @return      string $acronym acronym formatted as HTM element
  12.      */
  13.  
  14.     function AcronymTableLookup($matches){
  15.         global $wikka_acronyms;
  16.         include($this->GetConfigValue('acronym_table'));
  17.         $acronym = (is_array($wikka_acronyms) && array_key_exists($matches[0], $wikka_acronyms))? "<acronym title=\"".$wikka_acronyms[$matches[0]]."\">".$matches[0]."</acronym>" : $matches[0];
  18.         return $acronym;
  19.     }
  20.  
  21.     // VARIABLES


3. Modify wikka.config.php

Add the following values to the ConfigurationOptions configuration file:

    "enable_acronyms" => "1",
    "acronym_table" => "acronyms.php",


4. Create the acronym configuration file (acronyms.php)

Save the following code as acronyms.php in the root folder of your Wikka installation. You can obviously add as many acronym definitions as you like:

<?php

$wikka_acronyms = array(
    "CSS"   => "Cascade Style Sheet",
    "GIF"   => "Graphics Interchange Format",
    "GPL"   => "GNU General Public License",
    "HTML" => "Hyper Text Markup Language",
    "HTTP"  => "Hyper Text Transfer Protocol"
);

?> 


5. Add some style

Some browsers (Mozilla/FF) automatically highlight acronym elements in the page. To make acronyms visible also in other browsers, paste the following in your stylesheet (default: ./css/wikka.css):

acronym {
    border-bottom: 1px dotted #333;
    cursor: help /*modifies the mouse pointer as a question mark*/
}



CategoryDevelopment
There are 9 comments on this page. [Show comments]
Valid XHTML :: Valid CSS: :: Powered by WikkaWiki