====== Skill Plugin ======

---- plugin ----
description: Show Skill level for a page
author     : iDo
email      : iDo@woow-fr.com
type       : syntax
lastupdate : 2005-10-13
compatible :
depends    :
conflicts  :
similar    : progressbar
tags       : poll
----

The skill plugin allows you to show a number of stars to represent the level of skill needed to understand and use the page content.

Example on: http://www.woow-fr.com/wikistuce/doku.php?id=javascript:polices_proportionelles

===== How to use it =====

Just write ''%%{{skill>5/7}}%%''

The ''%%/7%%'' is not mandatory.

===== Install =====
Create a folder named 'skill' in the plugins directory and put the code provided below in a ''syntax.php'' file.

Don't forget to put the picture in the same folder.


===== Code =====

<code php>
<?php
 
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');
 
/**
 * All DokuWiki plugins to extend the parser/rendering mechanism
 * need to inherit from this class
 */
class syntax_plugin_skill extends DokuWiki_Syntax_Plugin {
 
    /**
     * return some info
     */
    function getInfo(){
        return array(
            'author' => 'iDo',
            'email'  => 'iDo@woow-fr.com',
            'date'   => '13/10/2005',
            'name'   => 'Skill Plugin',
            'desc'   => 'Add the possibility to show skill level',
            'url'    => 'http://www.dokuwiki.org/plugin:skill',
        );
    }
    
    /**
     * What kind of syntax are we?
     */
    function getType(){
        return 'substition';
    }
 
    /**
     * Where to sort in?
     */
    function getSort(){
        return 107;
    }
 
    /**
     * Connect pattern to lexer
     */
    function connectTo($mode) {
      $this->Lexer->addSpecialPattern("{{skill>[0-9]*/?[0-9]*}}",$mode,'plugin_skill');
    }
      
    /**
     * Handle the match
     */
    function handle($match, $state, $pos, &$handler){
        $match = substr($match,8,-2); // Strip markup
		$match=split('/',$match); // Strip size

        if (!isset($match[1])) $match[1] = $match[0];
		if ($match[0]>$match[1]) $match[1]=$match[0];
        return $match;
    }  
 
    /**
     * Create output
     */
    function render($mode, &$renderer, $data) {
        if($mode == 'xhtml'){       		
            $renderer->doc .= '<div>';
            $renderer->doc .= $this->_Skill($data);
            $renderer->doc .= '</div>';
            return true;
        }
        return false;
    }
	
	function _Skill($d) {
		$mRet='';
		for($i=1;$i<=$d[0];$i++) {
			$mRet.='<img src="lib/plugins/skill/star.png" alt="." style="" />';
		}
		for($i=1;$i<=($d[1]-$d[0]);$i++) {
			$mRet.='<img src="lib/plugins/skill/star.png" alt="." style="filter:alpha(opacity=40);-moz-opacity:0.4;opacity: 0.4;" />';
		}

		return $mRet;
	}
}

//Setup VIM: ex: et ts=4 enc=utf-8 :
?>

</code>

Other resource:

You must put this image in the same directory as syntax.php: http://www.woow-fr.com/wikistuce/lib/plugins/skill/star.png


===== Comments =====

> What about making this plugin "plugin manager" compatible to provide automatic install ?

> Thank you for this plugin ;-) [[http://leedoriden.free.fr/tutodir/doku.php|Leedoriden]]

This is a great plugin!  I have one request: a max number of stars, to prevent users from entering (for example) 3,000 stars.  Also, I made a couple of changes:

The first is to put the stars in a <span> instead of <div>, so I can put text and stars on the same line.  \\
Since transparencies aren't supported in Opera, the second replaces the less visible star with a different image.

<code php>
            $renderer->doc .= '<span>';
            $renderer->doc .= $this->_Skill($data);
            $renderer->doc .= '</span>';
            return true;
</code>

And then:

<code php>
function _Skill($d) {
$mRet='';
for($i=1;$i<=$d[0];$i++) {
$mRet.='<img src="lib/plugins/skill/star.png" alt="." style="" />';
}
for($i=1;$i<=($d[1]-$d[0]);$i++) {
$mRet.='<img src="lib/plugins/skill/star2.png" alt="." style="" />';
}
</code>

I added some code to limit the number of stars to 10.  Simply insert these two lines in **function handle**, before the line 'return $match'.
<code php>
   if ($match[0]>10) $match[0]=10;
   if ($match[1]>10) $match[1]=10;
</code>

> Please, provide an archive so that we can use the plug-in manager. I spend most of my time at some strange place called //work// where I have much spare time but no FTP access to my wiki, so that I cannot do anything except using the plug-in manager...

> I have changed the above max star = 10 with calculations...
<code php>
  if ($match[1]>10) {
    $match[0] = 10 * $match[0] / $match[1];
    $match[1] = 10;
  }
</code>
> This keeps the ratio, rather than a roof cut-off. (kenc)