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 - 1.40: kiriwrite_output_xml</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">1.40 kiriwrite_output_xml</span><br><br>
\r
20 kiriwrite_output_xml outputs a file in the XML format and is mainly used for writing a configuration file. All parameters in the subroutine are required.<br><br>
\r
22 <span class="heading">Parameters:</span><br><br>
\r
25 kiriwrite_output_xml(filename, type, options);
\r
30 <span class="heading">Usage:</span><br><br>
\r
33 kiriwrite_output_xml("kiriwrite.xml", "config", { DatabaseDirectory => “db”, OutputDirectory => “output”, ImagesURIPath => “/images/kiriwrite”, DateTimeFormat => “DD/MM/YY (hh:mm:ss)”, SystemLanguage => “en-GB”, PresentationModule => “HTML4S”, DatabaseModule => “SQLite”, DatabaseServer => “localhost”, DatabasePort => “3306”, DatabaseProtocol => “tcp”, DatabaseSQLDatabase => “database”, DatabaseUsername => “username”, DatabasePassword => “password”, DatabaseTablePrefix => “tableprefix” });
\r
39 Specifies the filename to output the configuration file to.<br><br>
\r
42 Specifies the type of XML file to output (the only available option being 'config').<br><br>
\r
45 Specifies the options to use as a hash.<br><br>
\r
47 <table class="infotable">
\r
49 <td class="tableheading">Value</td>
\r
50 <td class="tableheading">Description</td>
\r
53 <td class="tabledata">DatabaseDirectory</td>
\r
54 <td class="tabledata">Specifies the database directory to use.</td>
\r
57 <td class="tabledata">OutputDirectory</td>
\r
58 <td class="tabledata">Specifies the output directory to use.</td>
\r
61 <td class="tabledata">ImagesURIPath</td>
\r
62 <td class="tabledata">Specifies the URI path of the images directory.</td>
\r
65 <td class="tabledata">DateTimeFormat</td>
\r
66 <td class="tabledata">Specifies the date and time format that should be used.</td>
\r
69 <td class="tabledata">SystemLanguage</td>
\r
70 <td class="tabledata">Specifies the language that Kiriwrite will use.</td>
\r
73 <td class="tabledata">PresentationModule</td>
\r
74 <td class="tabledata">Specifies the presentation module in Kiriwrite to use.</td>
\r
77 <td class="tabledata">DatabaseModule</td>
\r
78 <td class="tabledata">Specifies the database module in Kiriwrite to use.</td>
\r
84 The following settings are for the server-based database modules:<br><br>
\r
86 <table class="infotable">
\r
88 <td class="tableheading">Value</td>
\r
89 <td class="tableheading">Description</td>
\r
92 <td class="tabledata">DatabaseServer</td>
\r
93 <td class="tabledata">Specifies the location of the database server.</td>
\r
96 <td class="tabledata">DatabasePort</td>
\r
97 <td class="tabledata">Specifies the port of the database server.</td>
\r
100 <td class="tabledata">DatabaseProtocol</td>
\r
101 <td class="tabledata">Specifies the protocol to use with the database server.</td>
\r
104 <td class="tabledata">DatabaseSQLDatabase</td>
\r
105 <td class="tabledata">Specifies the database name to use.</td>
\r
108 <td class="tabledata">DatabaseUsername</td>
\r
109 <td class="tabledata">Specifies the database username to use.</td>
\r
112 <td class="tabledata">DatabasePasswordKeep</td>
\r
113 <td class="tabledata">Specifies if the current database password should be kept.</td>
\r
116 <td class="tabledata">DatabasePassword</td>
\r
117 <td class="tabledata">Specifies the database password to use.</td>
\r
120 <td class="tabledata">DatabaseTablePrefix</td>
\r
121 <td class="tabledata">Specifies the table prefix to use for the tables used in Kiriwrite when using a server-based database module.</td>
\r