4.5 getoptions

Gets the options that will be used in the compile pages confirmation screen.

Parameters:

$kiriwrite_outputmodule->getoptions();

Usage:

%options = $kiriwrite_outputmodule->getoptions();

In the getoptions subroutine, you build a hash up which is to be returned when the subroutine is finished.

$options{seperatedirdatabase}{type} = "checkbox";
$options{seperatedirdatabase}{string} = languagestrings("seperatedirdatabase");

After the internal name of the option, you specify the type of option (and the options that go with that type of option):

checkbox
Specifies that a checkbox should be added.

Value Description
string Specifies the description for the option.

textbox
Specifies that a text box should be added.

Value Description
string Specifies the description for the text box.
value Specifies the default value of the text box.
size Specifies the size of the text box.
maxlength Specifies the maximum size of the value.
password Specifies the text box is a password box.

combobox
Specifies that a drop down box should be added.

Value Description
optionnames The names for the options in the drop down box with each name separated by a pipe ( | )
optionvalues The values for the options in the drop down box with each value separated by a pipe. ( | )
string Specifies the string to provide a description of the drop down box.

radio
Specifies that a option button should be added.

Value Description
StartFrom Specifies which filter entry to start from.
Limit Specifies how many filters should be retrieved.