HTML-Kit Build 292

Plugin authors are encouraged to place a default button on the hkp_c_Section_BatchActions section on the Actions Bar and use the following function to invoke the Batch Action Wizard in response to button clicks. Users can use this feature to invoke the BAW from the Actions Bar (without going through a Batch Actions menu) and to assign individual batch actions to keyboard shortcuts, for example.
FUNC_NAME = "Buffer" FUNC_PARAM1 = 4, FUNC_PARAM2 = Name of the plugin to select by default (pass an empty string ("") to select the batch action registered by the current plugin).

Plugin authors can use the hkp_MODE_INFO_KEYWORDS parameter to describe the type of plugin which in turn HTML-Kit will use to better position plugins on menus and other user interfaces. All keywords should be in lowercase, multiple keywords should be comma separated and there should not be any space in-between keywords. Following keywords are recognized at this time: batch, find, replace, validate and online.
Improved hkp_f_Buffer cancel function (sub function 3) now has two additional message box modes: 3 = Yes/No/Cancel (clicking No or Cancel will cancel the batch action) and 4 = OK/Cancel (Cancel will cancel the batch action). Optionally the hkp_FUNC_PARAM5 function parameter can be set to 0 to request the BAW not to display batch action parameters.

Plugin authors can use hkp_BUFFER_PARAM_HINT1, hkp_BUFFER_PARAM_HINT2, hkp_BUFFER_PARAM_HINT3, etc., parameters to provide more descriptive multi-line hints for input fields.

Plugin authors can use hkp_MODE_BUFFER_FILTER_REGEX_EXPR and hkp_MODE_BUFFER_FILTER_REGEX_OPT parameters to request the Batch Action Wizard to pre-filter files passed to batch actions. This can significantly improve the speed of batch actions that require filtering files based on file content (such as search and replace batch actions).

Plugin authors can now use hkp_BuffLen() and hkp_BuffCopy() functions defined in hkpcore.h and hkpcore.c to get the length of HKP_STBUFF string pointers and to copy string content without having to reinitialize HKP_STBUFF.

Plugin authors can use hkp_UNINSTALL_* related parameters to specify additional files and directories to uninstall, or to get a plugin callback to perform any special functions.

Plugin authors can use this feature to share character and integer data between calls to hkp_Register() and hkp_Main() within a single HTML-Kit session.
In hkp_Register(), set hkp_MODE_SESSION_ENABLE to 1 and hkp_SESSION_VAR_COUNT to the maximum number of session variables the plugin will use. Then hkp_SESSION_VAR1, hkp_SESSION_VAR2, hkp_SESSION_VAR3, etc., can be used to set and retrieve data between multiple calls.
For example, to set the first variable to "my string data" in hkScript:
hkp_DataAdd(pDataOut, "SESSION_VAR1", "my string data");
To retrieve it variable:
if( hkp_DataGet(pDataIn, "SESSION_VAR1", &sVal) ) { /* use sVal */ }

Plugin authors can include a plugin information comment block in hkScript plugins to allow easy handling of dependencies and version checks. Sample comment block:
/*
<PluginInformation><![CDATA[
<?xml version="1.0"?>
<plugin>
<requirements>
<info param='build' value='292' />
<info param='timestamp' value='20020705' />
<info param='lib' value='cm_lib_Dialogs.hks' />
</requirements>
</plugin>
]]></PluginInformation>
*/

By default batch actions will appear on the main menu and in the Workspace. Plugin authors can set hkp_MODE_BUFFER_VISIBLE_MAINMENU and/or hkp_MODE_BUFFER_VISIBLE_WORKSPACE to 0 to hide a batch action from a specific area.

Plugin authors can use following parameters to provide help, license and registration details: hkp_LICENSE_TYPE, hkp_LICENSE_DESCRIPTION, hkp_LICENSE_URL, hkp_REGISTRATION_TYPE, hkp_REGISTRATION_DESCRIPTION, hkp_REGISTRATION_FEE, hkp_REGISTRATION_URL and hkp_URL_HELP.

Plugin authors can now use the hkp_f_Preferences() function to retrieve following settings: edit_tab_char, edit_tab_stop, edit_tab_columns, edit_tab_optfill, edit_tab_smart, edit_indent_enabled, edit_indent_size, edit_margin_right_enabled, edit_margin_right_column, edit_wrap_enabled, and edit_wrap_column.

Plugin authors can set hkp_MODE_BUFFER_ACCESS_READ, hkp_MODE_BUFFER_ACCESS_WRITE and/or hkp_MODE_BUFFER_ACCESS_CREATE to specify the type of access required by a batch action plugin. hkp_MODE_BUFFER_ACCESS_READ is set for all batch actions by default. Plugins that intend to modify files (such as search and replace actions) must set hkp_MODE_BUFFER_ACCESS_WRITE to 1, and hkp_MODE_BUFFER_ACCESS_CREATE must be set to 1 if any files will be created either by directly creating new files, or as a result of other indirect actions such as rename, backup, restore, etc., actions.
The Batch Actions Wizard will use this information to increase performance now and to restrict access to files in the future.

Plugin authors can open browser windows in Gecko mode by passing "1" as the 3rd parameter to the hkp_f_OpenBrowser function.

Plugin developers can use the following function to delete or recycle the specified file:
FUNC_NAME = "File" FUNC_PARAM1 = 3, FUNC_PARAM2 = File name, FUNC_PARAM3 = (optional) 1 = recycle file (default), 0 = delete file. Output: FUNC_PARAM1 is set to 1 on success.

Plugin authors can use the following function to request the Batch Actions Wizard to cancel the action currently in progress. Optionally it can display a message or prompt the user before canceling the current action.
FUNC_NAME = "Buffer" FUNC_PARAM1 = 3, FUNC_PARAM2 = (optional) 1 = show OK message box, 2 = show Yes/No prompt and cancel only if Yes is clicked ("Are you sure? Yes/No" type prompt), FUNC_PARAM3 = (optional) message box text, FUNC_PARAM4 = (optional) message box title.
Output: FUNC_PARAM1 is set to 0 if the action is being cancelled and 1 if the action was not cancelled.
If FUNC_PARAM2 is not set or set to 0, the current action will be cancelled without prompting the user or showing further messages.

Now it's possible to use the hkScript function use() to include functions defined in external *.hks files/libraries. The file to be included should, in most cases, reside under the "HTML-Kit\Plugins\Lib" directory. When distributing plugins in a *.zip file, the plugin itself should be in the root of the ZIP file and any *.hks libraries should reside under a relative path named "Lib." The *.hks library must not include any global variables, it should define functions only. Any data should be wrapped in functions.
Sample hkScript code library in "HTML-Kit\Plugins\Lib\MyCode1.hks:"
--- cut here ---
function get_data() { return "string_data"; }
function do_something() { /* do something */ }
--- cut here ---
Now the "HTML-Kit\Plugins\MyPlugin1.hks" plugin can invoke functions in the MyCode1.hks file as follows:
--- cut here ---
if( use("MyCode1.hks", "mycodelib") )
{
Alert( mycodelib.get_data() );
mycodelib.do_something();
}
else { Alert( "Could not load MyCode1.hks" ); }
--- cut here ---

Currently it can be used to calculate X,Y coordinates using the character offset (returned by rpos() function for example, please see the demoMultiPageFind plugin for details).

Details on how to write Batch Actions can be found here.
Plugin authors can use the hkp_f_Buffer function to send event information to the Batch Actions Wizard and also to update the status message.
To send event information: FUNC_NAME = "Buffer" FUNC_PARAM1 = 1, FUNC_PARAM2 = row (0 if not applicable), FUNC_PARAM3 = column (0 if not applicable), FUNC_PARAM4 = event type ("Comment," "Message," "Warning" or "Error"), FUNC_PARAM5 = event description/message, FUNC_PARAM6 = length of the editor mark (optional, default = 0).
To update the status message: FUNC_NAME = "Buffer" FUNC_PARAM1 = 2, FUNC_PARAM2 = status message to be displayed while the current file is being processed.

Details on how to write Page Wizard plugins can be found here.

Plugin authors can use the hkp_f_Desktop function to open and save desktop files.
To open a desktop file: FUNC_NAME = "Desktop" FUNC_PARAM1 = 1, FUNC_PARAM2 = file name, FUNC_PARAM3 = 1/0 - open in interactive mode with the ability to cancel the process (optional, default = 1), FUNC_PARAM4 = maximum number of files to open, -1 = unlimited (optional, default = -1).
To save the current desktop to a file: FUNC_NAME = "Desktop" FUNC_PARAM1 = 2, FUNC_PARAM2 = file name, FUNC_PARAM3 = 1/0 - open in interactive mode with the ability to cancel the process (optional, default = 1).

Plugin authors can use the hkp_f_TimeTracker function to record time consuming plugin actions in the TimeTracker log.
To add an event: FUNC_NAME = "TimeTracker" FUNC_PARAM1 = 2, FUNC_PARAM2 = action ID (alphanumeric string without spaces), FUNC_PARAM3 = data field #1 (optional), FUNC_PARAM4 = data field #2 (optional), FUNC_PARAM5 = data field #3 (optional).
To change the user name: FUNC_NAME = "TimeTracker" FUNC_PARAM1 = 1, FUNC_PARAM1 = new user name.
Plugin authors interested in creating plugins that can generate more detailed and graphical reports can find TimeTracker logs in the HTML-Kit\Data\Logs\Default directory. The logs are in W3C Extended Log File Format, except the local timezone is used instead of GMT.

Plugin authors can use the hkp_f_RichHint function to access this new feature.
To display the RichHint window: FUNC_NAME = "RichHint", FUNC_PARAM1 = 1, FUNC_PARAM2 = HTML content to display. To hide it, FUNC_PARAM1 = 2. Both functions will return the output status in FUNC_PARAM1.

Plugin authors can use the hkp_f_Speech function to access speech functionality.
To read a block of text: FUNC_NAME = "Speech", FUNC_PARAM1 = 1, FUNC_PARAM2 = text to read, FUNC_PARAM3 = (optional) 0 - read text and wait for it to complete 1 - use the speech wizard dialog 2 - read text in the background, FUNC_PARAM4 = (optional) 1 to auto start speech, FUNC_PARAM5 = (optional) 1 to auto close the wizard after completing speech. Output: FUNC_PARAM1 = status.

Plugins Generator 2.94+ makes it easier to write plugins that can take advantage of the Command Prompt -- switch to the "Advanced" tab and enter a "Command Phrase." Details on how to write plugins that can handle Command Prompt related commands can be found here.

Note that hkp_PREVIEW_SOURCE_URL and hkp_PREVIEW_SOURCE_CONTENT parameters introduced in alpha 20020105 were renamed to hkp_PREVIEW_OUTPUT_URL and hkp_PREVIEW_OUTPUT_CONTENT. Preview plugins written for alpha 20020105 will need to update these parameter names.

Screen shot of HTML-Kit running on Linux

How to run HTML-Kit on Linux

To lookup help for a specific menu item, hold the mouse pointer over it and press the F1 key. To get help for a specific window or a button, click the "What's This" icon (mouse pointer with a question mark) and click the item in question. The F1 key in general can be used to get help for dialog boxes, preferences, etc.

By default, the help content will be displayed in an external browser window but can be directed to open in an internal browser window by turning the Scroll Lock on.

• This particular alpha version is recommended for plugin developers and users with experience in testing alpha/beta software only.
   


• Download size: 3 MB
   


• Minimum system requirements: Windows 95/98/ME/NT/2000/XP running on a Pentium or compatible processor. 8 MB of free disk space. 32 MB of memory. 256+ color VGA display. Pointing device.
   


• Can be installed on top of existing build 290 installations. Build 288 and prior installations must be uninstalled before running this setup.