chown apache:apache dokuwiki/lib/plugins/* -Rc
===== Plugin Source =====
Here comes the [[http://www.gnu.org/licenses/gpl.html|GPLed]] PHP source((The comments within the [[#Plugin Source|source]] file are suitable for the OSS [[http://www.stack.nl/~dimitri/doxygen/index.html|doxygen]] tool, a documentation system for C++, C, Java, Objective-C, Python, IDL and to some extent PHP, C#, and D. ---
Since I'm working with different programming languages it's a great ease to have one tool that handles the docs for all of them.)) for those who'd like to scan it before actually installing it:
syntax_plugin_hr.php - A PHP4 class that implements
* a DokuWiki plugin for horizonal rule (HR)
* elements.
*
*
* Just put four (or more) consecutive hyphens (minus signs) on
* a separate line:
* ----
*
*
* Copyright (C) 2005, 2007 DFG/M.Watermann, D-10247 Berlin, FRG
* All rights reserved
* EMail : <support@mwat.de>
*
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either
* version 3 of the
* License, or (at your option) any later version.
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* @author Matthias Watermann
* @version $Id: syntax_plugin_hr.php,v 1.4 2007/08/15 12:36:19 matthias Exp $
* @since created 29-Aug-2005
*/
class syntax_plugin_hr extends DokuWiki_Syntax_Plugin {
/**
* @publicsection
*/
//@{
/**
* Tell the parser whether the plugin accepts syntax mode
* $aMode within its own markup.
*
* @param $aMode String The requested syntaxmode.
* @return Boolean TRUE unless $aMode is
* 'plugin_hr' (which would result in a
* FALSE method result).
* @public
* @see getAllowedTypes()
* @static
*/
function accepts($aMode) {
return FALSE;
} // accepts()
/**
* Connect lookup pattern to lexer.
*
* @param $aMode String The desired rendermode.
* @public
* @see render()
*/
function connectTo($aMode) {
$this->Lexer->addSpecialPattern('\n[\t\x20]*-{4,}[\t\x20]*(?=\n)',
$aMode, 'plugin_hr');
} // connectTo()
/**
* Get an associative array with plugin info.
*
*
* The returned array holds the following fields:
*
* - author
- Author of the plugin
* - email
- Email address to contact the author
* - date
- Last modified date of the plugin in
* YYYY-MM-DD format
* - name
- Name of the plugin
* - desc
- Short description of the plugin (Text only)
* - url
- Website with more information on the plugin
* (eg. syntax description)
*
* @return Array Information about this plugin class.
* @public
* @static
*/
function getInfo() {
return array(
'author' => 'Matthias Watermann',
'email' => 'support@mwat.de',
'date' => '2007-08-15',
'name' => 'Horizontal Rule Syntax Plugin',
'desc' => 'Add HTML Style Horizontal Rule [ ---- ]',
'url' => 'http://www.dokuwiki.org/plugin:hr');
} // getInfo()
/**
* Define how this plugin is handled regarding paragraphs.
*
*
* This method is important for correct XHTML nesting. It returns
* one of the following values:
*
*
* - 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.
*
* @return String 'block'.
* @public
* @static
*/
function getPType() {
return 'block';
} // getPType()
/**
* Where to sort in?
*
* @return Integer 6.
* @public
* @static
*/
function getSort() {
// class 'Doku_Parser_Mode_hr' returns 160
// class 'Doku_Parser_Mode_listblock' returns 10
// class 'syntax_plugin_lists' returns 8
return 6;
} // getSort()
/**
* Get the type of syntax this plugin defines.
*
* @return String 'substition' (i.e. 'substitution').
* @public
* @static
*/
function getType() {
return 'substition'; // sic! should be __substitution__
} // getType()
/**
* Handler to prepare matched data for the rendering process.
*
*
* The $aState parameter gives the type of pattern
* which triggered the call to this method:
*
*
* - DOKU_LEXER_ENTER
* - a pattern set by addEntryPattern()
* - DOKU_LEXER_MATCHED
* - a pattern set by addPattern()
* - DOKU_LEXER_EXIT
* - a pattern set by addExitPattern()
* - DOKU_LEXER_SPECIAL
* - a pattern set by addSpecialPattern()
* - DOKU_LEXER_UNMATCHED
* - ordinary text encountered within the plugin's syntax mode
* which doesn't match any pattern.
*
* @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($aMatch, $aState, $aPos, &$aHandler) {
return $aState;
} // handle()
/**
* Handle the actual output creation.
*
*
* The method checks for the given $aFormat and returns
* FALSE when a format isn't supported. $aRenderer
* contains a reference to the renderer object which is currently
* handling the rendering. The contents of $aData is the
* return value of the handle() method.
*
* @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 handle()
* method.
* @return Boolean TRUE if rendered successfully, or
* FALSE otherwise.
* @public
* @see handle()
*/
function render($aFormat, &$aRenderer, &$aData) {
if (DOKU_LEXER_SPECIAL == $aData) {
if ('xhtml' != $aFormat) {
return FALSE;
} // if
$hits = array();
$aRenderer->doc =
(preg_match('|\s*(?:\s*
)*\s*$|', $aRenderer->doc, $hits))
? substr($aRenderer->doc, 0, -strlen($hits[0])) . '
'
: preg_replace('|\s*\s*
\s*|', '',
$aRenderer->doc) . '
';
} // if
return TRUE;
} // render()
//@}
} // class syntax_plugin_hr
} // if
//Setup VIM: ex: et ts=2 enc=utf-8 :
?>
==== Changes ====
__2007-08-15__:\\
* added GPL link and fixed some doc problems;
__2007-01-05__:\\
* minor changes in empty paragraph handling;
__2005-08-29__:\\
+ initial release;
//[[support@mwat.de|Matthias Watermann]] 2007-08-15//
===== See also =====
==== Plugins by the same author ====
* [[bomfix|BOMfix Plugin]] -- ignore Byte-Order-Mark characters in your pages
* [[code2|Code Syntax Plugin]] -- use syntax highlighting of code fragments in your pages
* [[deflist|Definition List Syntax Plugin]] -- use the only complete definition lists in your pages
* [[diff|Diff Syntax Plugin]] -- use highlighting of diff files (aka "patches") in your pages((obsoleted by incorporating its ability into the [[code2|Code]] plugin))
* [[hr|HR Syntax Plugin]] -- use horizontal rules in nested block elements of your pages
* [[lang|LANGuage Syntax Plugin]] -- markup different languages in your pages
* [[lists|Lists Syntax Plugin]] -- use the only complete un-/ordered lists in your pages
* [[nbsp|NBSP Syntax Plugin]] -- use Non-Breakable-Spaces in your pages
* [[nstoc|NsToC Syntax Plugin]] -- use automatically generated namespace indices
* [[shy|Shy Syntax Plugin]] -- use soft hyphens in your pages
* [[tip|Tip Syntax Plugin]] -- add hint areas to your pages
===== Discussion =====
Hints, comments, suggestions ...
> This functionality is in DokuWiki already, use four dashes (''----'') for doing an horizontal line //(an HTML ''