syntax_plugin_bomfix.php - A PHP4 class that implements * a DokuWiki plugin for UTF8 "magic" bytes. * *
* External editors (i.e. separate standalone programs like word processing * software) usually mark a file in UTF8 format by prepending its content * with a "magic" byte sequence at the very start of file. While there is * no harm in it as far as DokuWiki is concerned those "magic" bytes * (Byte Order Mark) do appear in the page presented to the user. *
* Depending on a page's actual content and the respective CSS rules in * effect this may lead to undesired results. One way to get rid of this * problem would be to open the affected page(s) with DokuWiki's built-in * edit feature and simply remove those bytes. However, such an approach * would cause the word processor to open the file as plain text assuming * it's in ASCII or, say, ISO-8859-1 format - whatever may be configured * as the default text format. That, in consequence, would invalidate (or * at least render strangely) all UTF8 character sequences. *
* Actually that is the recommended approach if (i.e. if) * you never intend to edit the wiki pages by an external editor. *
* As it happens, personally I prefer to edit the pages (of a local DokuWiki * installation) by OpenOffice.org for various reasons. (And, yes, I know * that I bypass DokuWiki's changes-system this way.) Therefor I need those * "magic" bytes but I don't want them to show up in the pages * presented to the end user (reader). Enter syntax_plugin_bomfix. * The whole purpose of this plugin is to suppress the output of that * "magic" byte sequence. And nothing more. There are no new wiki language * features introduced by this plugin. Nor is there anything special you * have to remember when editing one of your already existing or newly * created pages. *
* To use it just install the plugin in your DokuWiki's plugin folder. * That's all. *
* Copyright (C) 2006, 2010 M.Watermann, D-10247 Berlin, FRG * All rights reserved * EMail : <support@mwat.de> **
* The returned array holds the following fields: *
* The $aState parameter gives the type of pattern * which triggered the call to this method: *
** This implementation does nothing (ignoring the passed arguments) * and just returns the given $aState. *
* @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. * @public * @see render() * @static */ function handle($aMatch, $aState, $aPos, &$aHandler) { return $aState; // doesn't really matter as it's ignored anyway ... } // 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. *
* Besides "eating" the BOM implicitely this implementation does * nothing (ignoring all passed arguments) and always returns * TRUE. *
* @param $aFormat String The output format to generate. * @param $aRenderer Object A reference to the renderer object. * @param $aData Integer The data created/returned by the * handle() method. * @return Boolean TRUE always since there's no actual * rendering done and hence can't ever fail. * @public * @see handle() * @static */ function render($aFormat, &$aRenderer, $aData) { // nothing to do here - just 'eat' the BOM return TRUE; } // render() //@} } // class syntax_plugin_bomfix } // if ?>