Documentation/English (British)/user-chapter1-installerscript.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">\r
   2 <html>\r
   3         <head>\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 - User Documentation - 1.3: Kiriwrite Installer Script</title>\r
   7         </head>\r
   8         <body>\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
  15                         </div>\r
  16                 </div>\r
  17                 <div class="pageinformation">\r
  18                         <span class="pagetitle">1.3 Kiriwrite Installer Script</span><br><br>\r
  19 After pointing your browser to the installer script, a page appears which guides you through configuring the settings for Kiriwrite.<br><br>\r
  20 At the top of the page a drop down box is available to change the language of the installer script to another language which is more easier to understand, simply select the language from the drop down box and click on the Switch button, the script will then switch to the selected language.<br><br>\r
  21 The installer script will preform three tests, the first being to check if all the needed modules are there, the second test is to check if the modules needed for the database modules are there and finally a test to check if the directories have their correct permissions set.<br><br>\r
  22 Before the settings can be configured, checks are made to make sure that all of the needed modules are installed properly. If any of the needed modules are missing an error message will appear saying that one or more of the required Perl modules is missing and will need to be installed which can be done from the CPAN interface.<br><br>\r
  23 The installer script then checks to see if at least of the Perl modules for the database modules are installed. If none of the Perl modules needed for the database modules are found then an error message will appear saying that none of the Perl modules needed for the database modules are installed and will need to be installed which can be done from the CPAN interface.<br><br>\r
  24 Finally, the installer script then checks to see if the directories have the minimum correct permissions set. If one or more of the directories has an error, then a message appears saying to make sure that the correct permissions are set.<br><br>\r
  25 \r
  26 <div class="messagebox">\r
  27     <div class="message hint">\r
  28         <b>Hint</b><br>\r
  29         More information on solving problems that occur while installing Kiriwrite can be found in Chapter 5: Troubleshooting.\r
  30     </div>\r
  31 </div>\r
  32 \r
  33 <br>\r
  34 \r
  35 When the installer finds that everything is fine in regards to Perl modules and file permissions, a form appears allowing to configure the Kiriwrite installation to specific needs. Some default values are given which will work with the file-based database modules.<br><br>\r
  36 The configuration settings in detail:<br><br>\r
  37 <table class="infotable">\r
  38     <tr>\r
  39         <td class="tableheading">Setting</td>\r
  40         <td class="tableheading">Description</td>\r
  41     </tr>\r
  42     <tr>\r
  43         <td class="tabledata">Database Directory</td>\r
  44         <td class="tabledata">Specifies the database directory to use for storing databases that are created by the file-based database modules. This option is ignored by the server-based modules.</td>\r
  45     </tr>\r
  46     <tr>\r
  47         <td class="tabledata">Output Directory</td>\r
  48         <td class="tabledata">Specifies the output directory to use to store the compiled pages.</td>\r
  49     </tr>\r
  50     <tr>\r
  51         <td class="tabledata">Images (URI path)</td>\r
  52         <td class="tabledata">Specifies the Images (URI path) to use for displaying images when using the page template with Kiriwrite.</td>\r
  53     </tr>\r
  54     <tr>\r
  55         <td class="tabledata">Text Area Columns</td>\r
  56         <td class="tabledata">Specifies the width of the text area when editing notes, pages and templates.</td>\r
  57     </tr>\r
  58     <tr>\r
  59         <td class="tabledata">Text Area Rows</td>\r
  60         <td class="tabledata">Specifies the height of the text area when editing notes, pages and templates.</td>\r
  61     </tr>\r
  62     <tr>\r
  63         <td class="tabledata">Date Format</td>\r
  64         <td class="tabledata">Specifies the date format to use when list the pages from the database. A selection of date formats are available from the drop down box or a custom one can be entered into the text box next to the drop down box.</td>\r
  65     </tr>\r
  66     <tr>\r
  67         <td class="tabledata">Language</td>\r
  68         <td class="tabledata">Specifies the system language to use in Kiriwrite. If the language used in the installer script is available as language to use in Kiriwrite then that language will be selected by default.</td>\r
  69     </tr>\r
  70     <tr>\r
  71         <td class="tabledata">Presentation Module</td>\r
  72         <td class="tabledata">Specifies the presentation module to use in Kiriwrite.</td>\r
  73     </tr>\r
  74     <tr>\r
  75         <td class="tabledata">Database Module</td>\r
  76         <td class="tabledata">Specifies the database module to use in Kiriwrite. SQLite is a file-based database module which uses the database directory and the SQLite Perl module while MySQL5 is a server-based database module which uses a MySQL 5.x server from the MySQL Perl module.</td>\r
  77     </tr>\r
  78     <tr>\r
  79         <td class="tabledata">Output Module</td>\r
  80         <td class="tabledata">Specifies the output module to use in Kiriwrite. Normal is the only one available and replicates the hard coded functionality that was in Kiriwrite before version 0.5.0.</td>\r
  81     </tr>\r
  82 </table>\r
  83 \r
  84 <br>\r
  85 \r
  86 The following options are used only by the server-based database modules:<br><br>\r
  87 \r
  88 <table class="infotable">\r
  89     <tr>\r
  90         <td class="tableheading">Setting</td>\r
  91         <td class="tableheading">Description</td>\r
  92     </tr>\r
  93     <tr>\r
  94         <td class="tabledata">Database Server</td>\r
  95         <td class="tabledata">Specifies the database server to use.</td>\r
  96     </tr>\r
  97     <tr>\r
  98         <td class="tabledata">Database Port</td>\r
  99         <td class="tabledata">Specifies the database port to use.</td>\r
 100     </tr>\r
 101     <tr>\r
 102         <td class="tabledata">Database Protocol</td>\r
 103         <td class="tabledata">Specifies the database protocol to use.</td>\r
 104     </tr>\r
 105     <tr>\r
 106         <td class="tabledata">Database Name</td>\r
 107         <td class="tabledata">Specifies the database name to use.</td>\r
 108     </tr>\r
 109     <tr>\r
 110         <td class="tabledata">Database Username</td>\r
 111         <td class="tabledata">Specifies the database username to use.</td>\r
 112     </tr>\r
 113     <tr>\r
 114         <td class="tabledata">Database Password</td>\r
 115         <td class="tabledata">Specifies the database password to use.</td>\r
 116     </tr>\r
 117     <tr>\r
 118         <td class="tabledata">Database Table Prefix</td>\r
 119         <td class="tabledata">Specifies the table prefix to use. Multiple Kiriwrite installations can use the same server database so long as the table prefix is different.</td>\r
 120     </tr>\r
 121 </table>\r
 122 \r
 123 <br>\r
 124 \r
 125 There is an option that is enabled by default to attempt to delete the installation script after the configuration file has been written since the installation script would no longer be needed after that. Unchecking the box for this option disables this.<br><br>\r
 126 Click on the Save Settings button to write the configuration file or the Reset Settings button to restore the settings to their default values.<br><br>\r
 127 After clicking on the Save Settings button, some checks are made to make sure that data passed is correct, the configuration file is written (and the installer script deleted if requested) and a message appears saying that Kiriwrite can now be used by clicking on the link at the bottom of the page.\r
 128 \r
 129                 </div>\r
 130         </body>\r
 131 </html>\r