====== HtmlOKay Plugin ======


---- plugin ----
description: Controls HTML access, so that only designated users and groups may use HTML at one of four access levels
author     : Myron Turner
email      : turnermm02@shaw.ca
type       : admin, action
lastupdate : 2017-12-07
compatible : Binky, Ponder Stibbons, Hrun, Detritus, Elenor of Tsort, Frusterick Manners, Greebo, !Jack Jackrum
depends    : 
conflicts  : 
similar    : 
sourcerepo :  https://github.com/turnermm/htmlOKay 
bugtracker :  https://github.com/turnermm/htmlOKay/issues
tags       :  acl, groups, users, html, htmlok, configuration
downloadurl : https://github.com/turnermm/htmlOKay/archive/master.zip
donationurl: http://mturner.org/userfiles/donate.php
----


===== Installation =====
Search and install ​the plugin using the [[plugin:extension|Extension ​Manager]]. Or download from gitHub: [[https://github.com/turnermm/htmlOKay/archive/master.tar.gz|]] and install manually.

**Note:**  When installing from the extension manager, you might get a message that the extension has not been installed.  This is probably not true; reload the extension manager and check to see if the extension is listed.  Then if it is not, you can install it by using the manual install tab of the extension manager and the above github url.

If you install from the command line, you must make the plugin's ''conf/access'' directory writable by the web server.

===== Instructions =====
For instructions on use, you can go to the plugin's [[http://www.mturner.org/htmlOKay/doku.php|htmlOKay web site]] or consult either the pdf file or the ebook which comes bundled with the htmlOKay plugin in the ''docs'' directory.

A backup of the web site is at: [[http://web.archive.org/web/20160606131125/http://www.mturner.org/htmlOKay/doku.php?id=start|web.archive.org]].

==== Briefly ====
To begin with, to use this plugin, the [[config:htmlok|]] configuration option must be set to true.  The documentation for the ''htmlok'' option warns of the security risk in setting this option to true.  The htmlOKay plugin is designed to address those risks by enabling HTML access only to restricted users and pages and at different levels.  

These restriction are set in the plugin's access manager, where the different levels of HTML access can be set on files and namespaces for different users.  

=== Note on performance ===
Access can be restricted by page and by namespace.  That is, you can set HTML access permissions on one or more files in a namespace, or  you can choose the ''ALL'' option which sets the permissions for all of the pages in a selected namespace.  Whichever method you choose, you cannot set different permissions for the pages of a namespace: all of the pages in a namespace will have the same permissions whether or not you choose the ''ALL'' option.

You should try to use the ''ALL'' option only for those namespaces where all of the pages are going to be using HTML.  The reason for this is that the plugin advises the browser not to cache pages with ''htmlok'' markup, forcing the browser to re-fetch these pages each time they are accessed.  This is necessary to assure that Dokuwiki retains htmlOKay's access settings between page loads. 

It might be good policy to designate selected namespaces for HTML usage for selected users.  Then it is not necessary to reset the permissions each time a new  page is created.  
=====Refresh Button=====
More than one ''access level'' can be applied to the same namespace. For visitors to such a namespace, **htmlOKay** uses the the ''display_level''to determine the access level at which to display the pages in that namespace.  

Because DokuWiki caches its pages, sometimes the HTML displayed to a visitor may be that of the last cached version of a page, instead of the version assigned to the __display level__.  Because DokuWiki caches its pages, the HTML displayed to a visitor may be that of the last cached version of a page, instead of the version assigned to the __display level__.  To get around this problem if you see it as a problem, you can create a refresh button, to re-parse the page after the developer has logged out:
 
<code php button.php> 
    <form class="button" method="get" action=<?php  echo DOKU_BASE ."/doku.php"?>>
      <div class="no">
        <input type="hidden" name="do" value="show" />
        <input type="hidden" name="refresh" value="yes" />
        <input type="hidden" name="id" value="<?php echo $ID; ?>" />
        <input type="submit" value="Refresh" class="button"  />
      </div>
    </form>

</code>
===== Change Log =====
{{rss>https://github.com/turnermm/htmlokay/commits/master.atom date count=15}}