1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
\r
4 <link href="style.css" REL="stylesheet" TYPE="text/css" MEDIA="screen">
\r
5 <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
\r
6 <title>Kiriwrite Documentation - Developer Documentation - 4.5: getoptions</title>
\r
9 <div class="menubarback">
\r
10 <div class="menubar">
\r
11 <span class="apptitle">Kiriwrite</span>
\r
12 <a href="index.html">Index</a> | <a href="user.html">User
\r
13 Documentation</a> | <a href="tutorial.html">Tutorial Documentation</a> |
\r
14 <a href="developer.html">Developer Documentation</a>
\r
17 <div class="pageinformation">
\r
18 <span class="pagetitle">4.5 getoptions</span><br><br>
\r
20 Gets the options that will be used in the compile pages confirmation screen.<br><br>
\r
22 <span class="heading">Parameters:</span><br><br>
\r
25 $kiriwrite_outputmodule->getoptions();
\r
30 <span class="heading">Usage:</span><br><br>
\r
33 %options = $kiriwrite_outputmodule->getoptions();
\r
38 In the getoptions subroutine, you build a hash up which is to be returned when the subroutine is finished.<br><br>
\r
41 $options{seperatedirdatabase}{type} = "checkbox";<br>
\r
42 $options{seperatedirdatabase}{string} = languagestrings("seperatedirdatabase");
\r
47 After the internal name of the option, you specify the type of option (and the options that go with that type of option):<br><br>
\r
50 Specifies that a checkbox should be added.<br><br>
\r
52 <table class="infotable">
\r
54 <td class="tableheading">Value</td>
\r
55 <td class="tableheading">Description</td>
\r
58 <td class="tabledata">string</td>
\r
59 <td class="tabledata">Specifies the description for the option.</td>
\r
66 Specifies that a text box should be added.<br><br>
\r
68 <table class="infotable">
\r
70 <td class="tableheading">Value</td>
\r
71 <td class="tableheading">Description</td>
\r
74 <td class="tabledata">string</td>
\r
75 <td class="tabledata">Specifies the description for the text box.</td>
\r
78 <td class="tabledata">value</td>
\r
79 <td class="tabledata">Specifies the default value of the text box.</td>
\r
82 <td class="tabledata">size</td>
\r
83 <td class="tabledata">Specifies the size of the text box.</td>
\r
86 <td class="tabledata">maxlength</td>
\r
87 <td class="tabledata">Specifies the maximum size of the value.</td>
\r
90 <td class="tabledata">password</td>
\r
91 <td class="tabledata">Specifies the text box is a password box.</td>
\r
98 Specifies that a drop down box should be added.<br><br>
\r
100 <table class="infotable">
\r
102 <td class="tableheading">Value</td>
\r
103 <td class="tableheading">Description</td>
\r
106 <td class="tabledata">optionnames</td>
\r
107 <td class="tabledata">The names for the options in the drop down box with each name separated by a pipe ( | )</td>
\r
110 <td class="tabledata">optionvalues</td>
\r
111 <td class="tabledata">The values for the options in the drop down box with each value separated by a pipe. ( | )</td>
\r
114 <td class="tabledata">string</td>
\r
115 <td class="tabledata">Specifies the string to provide a description of the drop down box.</td>
\r
122 Specifies that a option button should be added.<br><br>
\r
124 <table class="infotable">
\r
126 <td class="tableheading">Value</td>
\r
127 <td class="tableheading">Description</td>
\r
130 <td class="tabledata">StartFrom</td>
\r
131 <td class="tabledata">Specifies which filter entry to start from.</td>
\r
134 <td class="tabledata">Limit</td>
\r
135 <td class="tabledata">Specifies how many filters should be retrieved.</td>
\r