Possibly you have a simple logfile to made visible like this:

 
>> Machine this and that#
>> Version 0.14#
>> Ready#
<< Start#
>> OK#

viewlog:	/home/www/fcon/lib/plugins/xsviewlog/testfiles/tst.log
0		Machine this and that#
1		Version 0.14#
2		Ready#
3		Start#
4		OK#

The plugin creates a table with own styling defined by css-file based on the given classes at php-code for table components.

• The table header contains the displayed log-file, given by syntax parameter.
• First column output is just a line counter you may use as reference for related explanations.
• Let us assume the log handles send and receive messages, which are differed by leading ”»” and ”«” characters per line. php-Code lines 94 and 100 test for such leading characters to handle the output accordingly. Then following lines will add the line number, related picture into second column and line content, coloured according the css definition for send/receive, into 3rd column.

The plugin does contain additionally css, images and a test file.

syntax.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_xsviewlog extends DokuWiki_Syntax_Plugin { /******************************************************************************/ /* return some info */ function getInfo(){ return confToHash(dirname(__FILE__).'/plugin.info.txt'); } function getType(){ return 'substition';} function getPType(){ return 'block';} function getSort(){ return 999;} /******************************************************************************/ /* Connect pattern to lexer */ function connectTo($mode){ $this->Lexer->addSpecialPattern('\{\(xsviewlog\>.*?\)\}',$mode,'plugin_xsviewlog'); } /******************************************************************************/ /* handle the match */ function handle($match, $state, $pos, &$handler) { global $ID; $match = substr($match,strlen('{(xsviewlog>'),-2); //strip markup from start and end //handle params $data = array(); /******************************************************************************/ /* parameters can be: {(xsviewlog>[file path],[from line],[to line],[type])} [file path] ... path to the file (either it is in DokuWiki media directory or windows fileshare, etc.) [from line] ... the first line, which should be displayed [to line] ... the last line, which should be displayed [type] ... the type of content to chose appropriate description ini file /******************************************************************************/ $params = explode(",",$match); // if you will have more parameters and choose ',' to delim them if ((!$params) || (count($params)<3)) { msg('Syntax of xsviewlog detected but to less parameters attached.', -1); } else { // Values $xsviewlog = array(); $xsviewlog['filepath'] = $params[0]; $xsviewlog['from'] = $params[1]; $xsviewlog['until'] = $params[2]; $xsviewlog['type'] = $params[3]; return $xsviewlog; } } /******************************************************************************/ /* render output * @author Taggic */ function render($mode, &$renderer, $xsviewlog) { global $ID; if($xsviewlog['filepath'] === '') $xsviewlog['filepath'] = DOKU_PLUGIN.'xsviewlog/testfiles/tst.log'; if(!$xsviewlog['type']) $xsviewlog['type'] = 'txt'; // 1. check if $xsviewlog['filepath'] exist, else error message if(!file_exists($xsviewlog['filepath'])) { msg('file '.$xsviewlog['filepath'].' not found',-1); return false; } // 2. retrieve file content $records = file($xsviewlog['filepath']); // 3. parse file content if(!$xsviewlog['until']) $xsviewlog['until']=count($records); foreach ($records as $line_num => $line) { if(($line_num>=$xsviewlog['from']-1) && ($line_num<=$xsviewlog['until']-1)) { // check if left 3 sign are matching '>> ' or '<< ' to differ between send and receive if(strpos($line, '>>')===0) { $log_block .= ''.$line_num.' '.substr($line,strlen(">>"),strlen($line)).'  '.NL; } elseif(strpos($line, '<<')===0) { $log_block .= ''.$line_num.' '.substr($line,strlen("<<"),strlen($line)).'  '.NL; } else { $log_block .= ''.$line_num.'   '.$line.'  '.NL; } } if ($line_num>$xsviewlog['until']) break; } // 4. append output to renderer $renderer->doc .= '

'. ''. $log_block.'

viewlog:	'.$xsviewlog['filepath'].'

'; } }

0. <?php
1.  
2. /**
3.  * Plugin xsviewlog: simple plugin to view log files
4.  *
5.  * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
6.  * @author     Taggic <taggic@t-online.de>
7.  */
8.  
9. if(!defined('DOKU_INC')) define('DOKU_INC',realpath(dirname(__FILE__).'/../../').'/');
10. if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
11. require_once(DOKU_PLUGIN.'syntax.php');  
12.  
13. /**
14.  * All DokuWiki plugins to extend the parser/rendering mechanism
15.  * need to inherit from this class
16.  */
17. class syntax_plugin_xsviewlog extends DokuWiki_Syntax_Plugin {
18.  
19. /******************************************************************************/
20. /* return some info
21. */
22.     function getInfo(){
23.         return confToHash(dirname(__FILE__).'/plugin.info.txt');
24.     }
25.  
26.     function getType(){ return 'substition';}
27.     function getPType(){ return 'block';}
28.     function getSort(){ return 999;}
29.    
30. /******************************************************************************/
31. /* Connect pattern to lexer
32. */  
33.     function connectTo($mode){
34.         $this->Lexer->addSpecialPattern('\{\(xsviewlog\>.*?\)\}',$mode,'plugin_xsviewlog');
35.     }                                  
36.  
37. /******************************************************************************/
38. /* handle the match
39. */  
40.     function handle($match, $state, $pos, &$handler) {
41.         global $ID;
42.         $match = substr($match,strlen('{(xsviewlog>'),-2); //strip markup from start and end
43.  
44.         //handle params
45.         $data = array();
46.     /******************************************************************************/
47.     /*      parameters can be:
48.             {(xsviewlog>[file path],[from line],[to line],[type])}
49.             [file path]   ... path to the file (either it is in DokuWiki media directory or windows fileshare, etc.)
50.             [from line]   ... the first line, which should be displayed
51.             [to line]     ... the last line, which should be displayed
52.             [type]        ... the type of content to chose appropriate description ini file
53.     /******************************************************************************/
54.  
55.         $params = explode(",",$match);  // if you will have more parameters and choose ',' to delim them
56.        
57.        
58.         if ((!$params) || (count($params)<3)) {
59.           msg('Syntax of xsviewlog detected but to less parameters attached.', -1);          
60.         }
61.         else {
62.           // Values
63.           $xsviewlog                = array();
64.           $xsviewlog['filepath']    = $params[0];
65.           $xsviewlog['from']        = $params[1];
66.           $xsviewlog['until']       = $params[2];
67.           $xsviewlog['type']        = $params[3];
68.           return $xsviewlog;
69.         }        
70.      }
71. /******************************************************************************/
72. /* render output
73. * @author Taggic <taggic@t-online.de>
74. */  
75.     function render($mode, &$renderer, $xsviewlog) {
76.         global $ID;
77.         if($xsviewlog['filepath'] === '') $xsviewlog['filepath'] = DOKU_PLUGIN.'xsviewlog/testfiles/tst.log';
78.         if(!$xsviewlog['type'])     $xsviewlog['type'] = 'txt';
79.  
80.     // 1. check if $xsviewlog['filepath'] exist, else error message
81.         if(!file_exists($xsviewlog['filepath'])) {
82.           msg('file '.$xsviewlog['filepath'].' not found',-1);
83.           return false;
84.         }
85.    
86.     // 2. retrieve file content
87.         $records    = file($xsviewlog['filepath']);
88.  
89.     // 3. parse file content
90.         if(!$xsviewlog['until']) $xsviewlog['until']=count($records);
91.         foreach ($records as $line_num => $line) {
92.             if(($line_num>=$xsviewlog['from']-1) && ($line_num<=$xsviewlog['until']-1)) {
93.                 // check if left 3 sign are matching '>> ' or '<< ' to differ between send and receive
94.                 if(strpos($line, '>>')===0) {
95.                     $log_block .= '<tr><td class="xsviewlog_col1" align="right">'.$line_num.'</td>
96.                                       <td class="xsviewlog_col2"><img src="'.DOKU_BASE.'lib/plugins/xsviewlog/images/in.png" title="receive" /></td>
97.                                       <td><span class="xsviewlog0">'.substr($line,strlen(">>"),strlen($line)).'&nbsp;</span></td>
98.                                   </tr>'.NL;
99.                 }
100.                 elseif(strpos($line, '<<')===0) {
101.                     $log_block .= '<tr><td class="xsviewlog_col1" align="right">'.$line_num.'</td>
102.                                       <td class="xsviewlog_col2"><img src="'.DOKU_BASE.'lib/plugins/xsviewlog/images/out.png" title="send" /></td>
103.                                       <td><span class="xsviewlog1">'.substr($line,strlen("<<"),strlen($line)).'&nbsp;</span></td>
104.                                   </tr>'.NL;
105.                 }
106.                 else {
107.                   $log_block .= '<tr><td class="xsviewlog_col1" align="right">'.$line_num.'</td>
108.                                     <td class="xsviewlog_col2">&nbsp;</td>
109.                                     <td><span class="xsviewlog2">'.$line.'&nbsp;</span></td>
110.                                 </tr>'.NL;
111.                 }
112.             }
113.             if ($line_num>$xsviewlog['until']) break;
114.         }
115.  
116.     // 4. append output to renderer
117.        $renderer->doc .= '<div class="xsviewlog"><table class="xsviewlog">'.
118.                          '<tr><th><span class="viewlog_txt">viewlog:&nbsp;</span></th><th colspan="2">'.$xsviewlog['filepath'].'</th></tr>'.
119.                           $log_block.'</table></div>';
120.     }
121.   }
122.  

{(xsviewlog>[logfile path], [from line], [until line], [type])}

To get the complete plugin please download: xsviewlog.zip

• A very simple plugin
• A simple performance measurement
• Plugin Dev tutorial