DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:imstatus

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
plugin:imstatus [2008-02-27 22:44]
201.6.156.201
plugin:imstatus [2012-07-25 20:06]
Klap-in
Line 1: Line 1:
 +====== imstatus plugin ======
  
 +---- plugin ----
 +description:​ IM Server current online status
 +author ​    : Walter Torres
 +email      : walter@torres.ws
 +type       : syntax
 +lastupdate : 2008-01-12
 +compatible : 2005-07-13+
 +depends ​   : 
 +conflicts ​ : 
 +similar ​   : icq
 +tags       : chat status embed
 +----
 +
 +
 +The plugin displays your (or any IDs) current online status.
 +
 +This plugin uses the free services of http://​www.onlinestatus.org/​ to work. 
 +\\ FIXME **The onlinestatus website seems out of service**
 +
 +Thanks Gina for your help!
 +
 +===== Syntax =====
 +
 +This syntax takes 2 parameters:
 +  * Service name [AIM|IRC|MSN|Yahoo]
 +  * IM login ID
 +
 +<​code>​
 +{{imstatus>​service id}}
 +</​code>​
 +
 +===== Example =====
 +Look at the bottom of my [[http://​walters-way.com|Web Site]].
 +
 +
 +===== Installation =====
 +
 +I don't know how to make an install package yet, so just copy the code below into **plugins/​imstatus/​syntax.php**
 +
 +
 +
 +===== Plugin Source =====
 +
 +
 +Here is the [[http://​www.gnu.org/​licenses/​gpl.html|GPLed]] PHP source. ((I '​stole'​ the javadoc comments from Matthias Watermann HR plugin. It really helps to see how all this works together.)) Just copy and paste into your plugin directory.
 +
 +<code php |h The plugin'​s PHP4 source code|h>
 +<?php
 +
 +/*
 +Gina told me
 +for markup, i usually go with:
 + * <​...>,​ for replacements
 + * {{command>​param paramn}}
 + * tildes for configuration like (compare ~~NOTOC~~ and ~~NOCACHE~~)
 +*/
 +
 +/**
 + * Plugin IM Status: Displays your current IM Service status"​
 + ​* ​
 + * @license ​   GPL 2 (http://​www.gnu.org/​licenses/​gpl.html)
 + * @author ​    ​Walter Torres <​walter@torres.ws>​
 + */
 + 
 +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_imstatus extends DokuWiki_Syntax_Plugin {
 + 
 +   /**
 +    * Get an associative array with plugin info.
 +    *
 +    * <p>
 +    * The returned array holds the following fields:
 +    * <dl>
 +    * <​dt>​author</​dt><​dd>​Author of the plugin</​dd>​
 +    * <​dt>​email</​dt><​dd>​Email address to contact the author</​dd>​
 +    * <​dt>​date</​dt><​dd>​Last modified date of the plugin in
 +    * <​tt>​YYYY-MM-DD</​tt>​ format</​dd>​
 +    * <​dt>​name</​dt><​dd>​Name of the plugin</​dd>​
 +    * <​dt>​desc</​dt><​dd>​Short description of the plugin (Text only)</​dd>​
 +    * <​dt>​url</​dt><​dd>​Website with more information on the plugin
 +    * (eg. syntax description)</​dd>​
 +    * </dl>
 +    * @param none
 +    * @return Array Information about this plugin class.
 +    * @public
 +    * @static
 +    */
 +    function getInfo(){
 +        return array(
 +            '​author'​ => '​Walter Torres',​
 +            '​email' ​ => '​walter@torres.ws',​
 +            '​date' ​  => '​2008-01-12',​
 +            '​name' ​  => 'IM Status',​
 +            '​desc' ​  => '​Displays a given IM service ID current online status',​
 +            '​url' ​   => '​http://​www.dokuwiki.org/​plugin:​imstatus',​
 +        );
 +    }
 + 
 +   /**
 +    * Get the type of syntax this plugin defines.
 +    *
 +    * @param none
 +    * @return String <​tt>'​substition'</​tt>​ (i.e. '​substitution'​).
 +    * @public
 +    * @static
 +    */
 +    function getType(){
 +        return '​substition';​
 +    }
 + 
 +    /**
 +     * What kind of syntax do we allow (optional)
 +     */
 +//    function getAllowedTypes() {
 +//        return array();
 +//    }
 + 
 +   /**
 +    * Define how this plugin is handled regarding paragraphs.
 +    *
 +    * <p>
 +    * This method is important for correct XHTML nesting. It returns
 +    * one of the following values:
 +    * </p>
 +    * <dl>
 +    * <​dt>​normal</​dt><​dd>​The plugin can be used inside paragraphs.</​dd>​
 +    * <​dt>​block</​dt><​dd>​Open paragraphs need to be closed before
 +    * plugin output.</​dd>​
 +    * <​dt>​stack</​dt><​dd>​Special case: Plugin wraps other paragraphs.</​dd>​
 +    * </dl>
 +    * @param none
 +    * @return String <​tt>'​block'</​tt>​.
 +    * @public
 +    * @static
 +    */
 +//    function getPType(){
 +//        return '​normal';​
 +//    }
 + 
 +   /**
 +    * Where to sort in?
 +    *
 +    * @param none
 +    * @return Integer <​tt>​6</​tt>​.
 +    * @public
 +    * @static
 +    */
 +    function getSort(){
 +        return 280;
 +    }
 + 
 + 
 +   /**
 +    * Connect lookup pattern to lexer.
 +    *
 +    * @param $aMode String The desired rendermode.
 +    * @return none
 +    * @public
 +    * @see render()
 +    */
 +    function connectTo($mode) {
 +        $this->​Lexer->​addSpecialPattern('​\{\{imstatus>​.+?​\}\}',​$mode,'​plugin_imstatus'​);​
 +    }
 + 
 +//    function postConnect() {
 +//      $this->​Lexer->​addExitPattern('</​TEST>','​plugin_test'​);​
 +//    }
 + 
 + 
 +   /**
 +    * Handler to prepare matched data for the rendering process.
 +    *
 +    * <p>
 +    * The <​tt>​$aState</​tt>​ parameter gives the type of pattern
 +    * which triggered the call to this method:
 +    * </p>
 +    * <dl>
 +    * <​dt>​DOKU_LEXER_ENTER</​dt>​
 +    * <dd>a pattern set by <​tt>​addEntryPattern()</​tt></​dd>​
 +    * <​dt>​DOKU_LEXER_MATCHED</​dt>​
 +    * <dd>a pattern set by <​tt>​addPattern()</​tt></​dd>​
 +    * <​dt>​DOKU_LEXER_EXIT</​dt>​
 +    * <dd> a pattern set by <​tt>​addExitPattern()</​tt></​dd>​
 +    * <​dt>​DOKU_LEXER_SPECIAL</​dt>​
 +    * <dd>a pattern set by <​tt>​addSpecialPattern()</​tt></​dd>​
 +    * <​dt>​DOKU_LEXER_UNMATCHED</​dt>​
 +    * <​dd>​ordinary text encountered within the plugin'​s syntax mode
 +    * which doesn'​t match any pattern.</​dd>​
 +    * </dl>
 +    * @param $aMatch String The text matched by the patterns.
 +    * @param $aState Integer The lexer state for the match.
 +    * @param $aPos Integer The character position of the matched text.
 +    * @param $aHandler Object Reference to the Doku_Handler object.
 +    * @return Integer The current lexer state for the match.
 +    * @public
 +    * @see render()
 +    * @static
 +    */
 +    function handle($match,​ $state, $pos, &​$handler) {
 +        $match = substr($match,​ 2, -2);
 +        list($command,​ $match) = split('>',​ $match);
 +        return split('​ ', trim($match));​
 +    }
 + 
 +   /**
 +    * Handle the actual output creation.
 +    *
 +    * <p>
 +    * The method checks for the given <​tt>​$aFormat</​tt>​ and returns
 +    * <​tt>​FALSE</​tt>​ when a format isn't supported. <​tt>​$aRenderer</​tt>​
 +    * contains a reference to the renderer object which is currently
 +    * handling the rendering. The contents of <​tt>​$aData</​tt>​ is the
 +    * return value of the <​tt>​handle()</​tt>​ method.
 +    * </p>
 +    * @param $aFormat String The output format to generate.
 +    * @param $aRenderer Object A reference to the renderer object.
 +    * @param $aData Array The data created by the <​tt>​handle()</​tt>​
 +    * method.
 +    * @return Boolean <​tt>​TRUE</​tt>​ if rendered successfully,​ or
 +    * <​tt>​FALSE</​tt>​ otherwise.
 +    * @public
 +    * @see handle()
 +    */
 +    function render($mode,​ &​$renderer,​ $data) {
 +        if($mode == '​xhtml'​){
 +            $l_srv = strtolower($data[0]);​
 +            $u_srv = strtoupper($data[0]);​
 +            $renderer->​doc .= '<​IMG SRC="​http://​tirorenn.linux-tech.net:​8080/'​ . $l_srv . '/'​ . $data[1] . '"​
 +                               ​align="​absmiddle"​ border="​0"​ ALT="'​ . $u_srv . ' Online Status Indicator"​
 +                               ​onerror="​this.onerror=null;​this.src=\'​http://​tirorenn.linux-tech.net:​8080/​image/'​ . $l_srv . '​unknown.gif\';">';​
 +            return true;
 +        }
 +        return false;
 +    }
 +}
 + 
 +//Setup VIM: ex: et ts=4 enc=utf-8 :
 +?>
 +</​code>​
 +
 +==== Changes ====
 +
 +
 +===== See also =====
 +
 +  * [[plugin:​icq|ICQ]]
 +
 +
 +===== Discussion =====
 +Hints, comments, suggestions ...
 +
 +
 +== To work ==
 +Hi, I change:
 +<​code>​
 +$renderer->​doc .= '<​IMG SRC="​http://​tirorenn.linux-tech.net:​8080/'​ . $l_srv . '/'​ . $data[1] . '"​
 +</​code>​
 +
 +To:
 +
 +<​code>​
 +$renderer->​doc .= '<​IMG SRC="​http://​osi.techno-st.net:​8000/'​ . $l_srv . '/'​ . $data[1] . '"​
 +</​code>​
plugin/imstatus.txt ยท Last modified: 2012-07-25 20:06 by Klap-in