====== Config:HTMLOk Plugin ======
---- plugin ----
description: Enables config:htmlok behaviour to use raw HTML
author : Luis Machuca Bezzaza
email : lambalicious [at] tuta [dot] io
type : syntax
lastupdate : 2023-07-12
compatible :
depends :
conflicts :
similar : htmlok
tags : html, dokuwiki-fixes markup_language, htmlok_replacement, formatting
securitywarning: allowsscript
downloadurl: https://codeberg.org/lmachucabezzaza0/dw-plugin-htmlok/archive/master.zip
bugtracker : https://codeberg.org/lmachucabezzaza0/dw-plugin-htmlok/issues
sourcerepo : https://codeberg.org/lmachucabezzaza0/dw-plugin-htmlok
donationurl: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=T44AQDXJQJTJQ&source=url
screenshot_img :
----
This is the Config:HTMLOk plugin. What it does is basically the same as the ''config:htmlok'' option in DokuWiki versions previous to //Igor//: if the plugin is enabled and configured, it allows you to use raw HTML sections in your wikicode.
This plugin does **not** offer raw PHP move (aka: the old ''config:phpok'' mode). For plugins that allow for executing PHP and rendering the result on the wikicode see eg.: [[:plugin:phpwikify]].
This plugin has been moved from [[:plugin:htmlokalt]]. If you have installed that plugin (and **not** [[:plugin:htmlok]]), the safest way to upgrade is to remove that plugin and install ''confightmlok'' instead.
===== Installation =====
Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.
Heed the security notice above. While it is possible to add your own sanitizer to the working of this plugin, __it is not the default behaviour__.
===== Configuration =====
* ''use_sure'', ''use_really_sure'':
If you have installed this plugin and want to use it, make sure to enable the two "are you sure" options in the configuration. **Both** options must be enabled for HTML wikicode to be parsed.
* ''sanitizer'':
The plugin gives you the option to run the HTML wikicode **through your own sanitizer** before rendering. If you have such sanitizer enabled, enter its **function name** in this box. The function name must be a valid PHP function name that has only uppercase or lowercase letters, digits and ''_'' (underscore), and the **function signature** must be of the form '' function($string) -> $string ''.
If no function name is provided, this feature does nothing, and HTML wikicode is passed to the renderer without modifications.
If an invalid function name is provided, the HTML is passed through without modifications, and a warning message is sent.
:!: In order for an external sanitizer function to be invoked, it has to exist or be included by the time the plugin loads. The safest way to do this is to ''include_once'' or ''require_once'' the header containing the sanitizer in ''[[:devel:preload|inc/preload.php]]''.
===== Examples/Usage =====
Once this plugin is installed and enabled as detailed below, old wikicode using '''' tags should be working correctly.
===== Syntax =====
Basic syntax:
some inline level HTML code
some block level HTML code
===== Development =====
==== Change Log ====
{{rss>https://codeberg.org/lmachucabezzaza0/dw-plugin-htmlok.atom date}}
==== Future Development ====
The following two features are planned to be added to the plugin at some point in the future:
* Enable inline level html and block level HTML separately.
* Implemented 2023-04-13. Allow the admin to invoke an external HTML sanitizer function.
===== Discussion =====
Issues can be raised at the issue tracker. Complaining behaviour that contributes nothing to the discussion will be moderated.