Updated the documentation.

[kiriwrite/.git] / Documentation / English (British) / developer-chapter1-kiriwriteoutputconfig.html
diff --git a/Documentation/English (British)/developer-chapter1-kiriwriteoutputxml.html b/Documentation/English (British)/developer-chapter1-kiriwriteoutputconfig.html

similarity index 74%

rename from Documentation/English (British)/developer-chapter1-kiriwriteoutputxml.html

rename to Documentation/English (British)/developer-chapter1-kiriwriteoutputconfig.html

index 4d491ec..7c43b62 100644 (file)
--- a/Documentation/English (British)/developer-chapter1-kiriwriteoutputxml.html
+++ b/Documentation/English (British)/developer-chapter1-kiriwriteoutputconfig.html
@@ -3,7 +3,7 @@
         <head>\r
                 <link href="style.css" REL="stylesheet" TYPE="text/css" MEDIA="screen">\r
                 <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">\r
-               <title>Kiriwrite Documentation - Developer Documentation - 1.40: kiriwrite_output_xml</title>\r
+               <title>Kiriwrite Documentation - Developer Documentation - 1.40: kiriwrite_output_config</title>\r
         </head>\r
         <body>\r
                 <div class="menubarback">\r
@@ -15,14 +15,14 @@ Documentation</a> | <a href="tutorial.html">Tutorial Documentation</a> |
                         </div>\r
                 </div>\r
                 <div class="pageinformation">\r
-                       <span class="pagetitle">1.40 kiriwrite_output_xml</span><br><br>\r
+                       <span class="pagetitle">1.40 kiriwrite_output_config</span><br><br>\r
  \r
-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
+kiriwrite_output_config outputs a configuration file and is mainly used for writing an updated configuration file. All parameters in the subroutine are required.<br><br>\r
  \r
  <span class="heading">Parameters:</span><br><br>\r
  \r
  <div class="code">\r
-    kiriwrite_output_xml(filename, type, options);\r
+    kiriwrite_output_config(options);\r
  </div>\r
  \r
  <br>\r
@@ -30,7 +30,7 @@ kiriwrite_output_xml outputs a file in the XML format and is mainly used for wri
  <span class="heading">Usage:</span><br><br>\r
  \r
  <div class="code">\r
-    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
+    kiriwrite_output_config({ DatabaseDirectory => “db”, OutputDirectory => “output”, ImagesURIPath => “/images/kiriwrite”, DateTimeFormat => “DD/MM/YY (hh:mm:ss)”, SystemLanguage => “en-GB”, PresentationModule => “HTML4S”, TextAreaCols => 50, TextAreaRows => 10, DatabaseModule => “SQLite”, DatabaseServer => “localhost”, DatabasePort => “3306”, DatabaseProtocol => “tcp”, DatabaseSQLDatabase => “database”, DatabaseUsername => “username”, DatabasePassword => “password”, DatabaseTablePrefix => “tableprefix” });\r
  </div>\r
  \r
  <br>\r
@@ -73,6 +73,14 @@ Specifies the options to use as a hash.<br><br>
          <td class="tabledata">PresentationModule</td>\r
          <td class="tabledata">Specifies the presentation module in Kiriwrite to use.</td>\r
      </tr>\r
+    <tr>\r
+        <td class="tabledata">TextAreaCols</td>\r
+        <td class="tabledata">Specifies the width of the text area.</td>\r
+    </tr>\r
+    <tr>\r
+        <td class="tabledata">TextAreaRows</td>\r
+        <td class="tabledata">Specifies the height of the text area.</td>\r
+    </tr>\r
      <tr>\r
          <td class="tabledata">DatabaseModule</td>\r
          <td class="tabledata">Specifies the database module in Kiriwrite to use.</td>\r