This shows you the differences between two versions of the page.
Both sides previous revision Previous revision | Last revision Both sides next revision | ||
installation [2015/10/05 06:57] tower [Downloading htmlOKay] |
installation [2015/10/14 14:05] tower |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ======Installing htmlOKay ====== | + | ====== Installing htmlOKay ====== |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
==== Downloading htmlOKay ==== | ==== Downloading htmlOKay ==== | ||
**htmlOKay** can be downloaded from:\\ | **htmlOKay** can be downloaded from:\\ | ||
- | [[https://github.com/turnermm/htmlOKay/archive/master.zip|]]. | + | [[https://github.com/turnermm/htmlOKay/archive/master.zip|https://github.com/turnermm/htmlOKay/archive/master.zip]]. |
It can be installed in the plugins directory using the download manager. It can also be installed directly into the plugins directory. Save it to lib/plugins and issue the following command from the command line: | It can be installed in the plugins directory using the download manager. It can also be installed directly into the plugins directory. Save it to lib/plugins and issue the following command from the command line: | ||
Line 57: | Line 13: | ||
The end result will be the directory structure and files shown in the following section on **Directory Structure**. | The end result will be the directory structure and files shown in the following section on **Directory Structure**. | ||
+ | ==== Directory Structure ==== | ||
- | ====Directory Structure==== | + | ^Directory ^File(s) ^Comments | |
- | ^Directory^File(s)^Comments^ | + | |**htmlOKay** |action.php |initializes current session | |
- | | **htmlOKay** |action.php| initializes current session| | + | | |syntax.php |enforces access levels | |
- | | |syntax.php| enforces access levels| | + | | |style.css |some styles for the admin panel | |
- | | |style.css| some styles for the admin panel| | + | | |admin.php |script for the administration panel | |
- | | |admin.php| script for the administration panel| | + | | |directory_scan-3.php |script for ajax calls from admin panel | |
- | | |directory_scan-3.php| script for ajax calls from admin panel| | + | | |script.js |javascript for admin panel | |
- | | |script.js|javascript for admin panel| | + | ^ ^ ^ | |
- | ^ ^ ^ | | + | |**htmlOKay/conf** |default.php |internal | |
- | | **htmlOKay/conf** |default.php|internal| | + | | |metadata.php |internal | |
- | | |metadata.php|internal| | + | ^ ^ ^ | |
- | ^ ^ ^ | | + | |**htmlOKay/conf/access** | |data directory for access control files | |
- | | **htmlOKay/conf/access** | |data directory for access control files| | + | | |get_inf.php |administrator's script for inspecting access control files | |
- | | |get_inf.php| administrator's script for inspecting access control files | | + | ^ ^ ^ | |
- | ^ ^ ^ | | + | |**htmlOKay/lang** | | | |
- | | **htmlOKay/lang** | | | | + | |**htmlOKay/lang/en** |intro.txt |internal | |
- | | **htmlOKay/lang/en**|intro.txt|internal| | + | | |settings.php |internal | |
- | | |settings.php|internal| | + | | |lang.php |internal | |
- | | |lang.php|internal| | + | |
+ | ==== Setup and Configuration ==== | ||
+ | === Setup === | ||
+ | **1.** In main.php, immediately below the body tag, include the following call to __trigger_event__: | ||
+ | <code> | ||
+ | <?php $temp=array(); trigger_event('HTMLOK_ACCESS_EVENT', $temp); ?> | ||
+ | </code> | ||
+ | main.php will be found in the template directory __inc/tpl/default__. | ||
+ | **2.** Make sure that the directory __plugins/htmlOKay/conf/access__ is writable by DokuWiki. This should work with the same permissions and ownership settings as the __data__ directory and the __conf__ directory. | ||
+ | **3.** Open the **Access Manager** from the Administration page and set up your permissions. | ||
+ | === Configuration === | ||
+ | There is currently one option setting in the Dokuwiki __Configuration Manager__ under **HtmlOKay Plugin Settings:** | ||
+ | * Check off this box if you are installing a custom error button for display of HTML errors. | ||
+ | For details on the custom errors buttons and how to install one, see the section [[:html:access:violations#show_errors_button|Show Errors Button]] on the __access violations__ page. | ||
+ | \\ | ||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | ====Setup and Configuration==== | ||
- | ===Setup=== | ||
- | **1.** In main.php, immediately below the body tag, include the following call to __trigger_event__: | ||
- | |||
- | <?php $temp=array(); trigger_event('HTMLOK_ACCESS_EVENT', $temp); ?> | ||
- | |||
- | main.php will be found in the template directory __inc/tpl/default__. | ||
- | |||
- | **2.** Make sure that the directory __plugins/htmlOKay/conf/access__ is writable by DokuWiki. This should work with the same permissions and ownership settings as the __data__ directory and the __conf__ directory. | ||
- | |||
- | **3.** Open the **Access Manager** from the Administration page and set up your permissions. | ||
- | |||
- | ===Configuration=== | ||
- | There is currently one option setting in the Dokuwiki __Configuration Manager__ under **HtmlOKay Plugin Settings:** | ||
- | |||
- | *Check off this box if you are installing a custom error button for display of HTML errors. | ||
- | For details on the custom errors buttons and how to install one, see the section [[html:access:violations#show_errors_button|Show Errors Button]] on the __access violations__ page. |