Documentation/English (British)/user-chapter3.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 - Chapter 3: Kiriwrite Settings</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">Chapter 3: Kiriwrite Settings</span><br><br>\r
  19 \r
  20 The settings that are used in Kiriwrite can be viewed by clicking on the 'View Settings' link in the menu which will display a list of settings that are currently in use.<br><br>\r
  21 \r
  22 <span class="heading">3.1 Editing the settings</span><br><br>\r
  23 \r
  24 To edit the settings, click on the 'Edit Settings' link in the View Settings sub-menu, a form then appears allowing the settings in Kiriwrite to be edited.<br><br>\r
  25 \r
  26 <table class="infotable">\r
  27     <tr>\r
  28         <td class="tableheading">Setting</td>\r
  29         <td class="tableheading">Description</td>\r
  30     </tr>\r
  31     <tr>\r
  32         <td class="tabledata">Database Directory</td>\r
  33         <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
  34     </tr>\r
  35     <tr>\r
  36         <td class="tabledata">Output Directory</td>\r
  37         <td class="tabledata">Specifies the output directory to use to store the compiled pages.</td>\r
  38     </tr>\r
  39     <tr>\r
  40         <td class="tabledata">Images (URI path)</td>\r
  41         <td class="tabledata">Specifies the Images (URI path) to use for displaying images when using the page template with Kiriwrite.</td>\r
  42     </tr>\r
  43     <tr>\r
  44         <td class="tabledata">Text Area Columns</td>\r
  45         <td class="tabledata">Specifies the width of the text area when editing notes, pages and templates.</td>\r
  46     </tr>\r
  47     <tr>\r
  48         <td class="tabledata">Text Area Rows</td>\r
  49         <td class="tabledata">Specifies the height of the text area when editing notes, pages and templates.</td>\r
  50     </tr>\r
  51     <tr>\r
  52         <td class="tabledata">Pages on browse</td>\r
  53         <td class="tabledata">Specifies the amount of pages that should be viewed when getting the list of pages in the database.</td>\r
  54     </tr>\r
  55     <tr>\r
  56         <td class="tabledata">Filters on browse</td>\r
  57         <td class="tabledata">Specifies the amount of filters that should be viewed when getting the list of filters in the database.</td>\r
  58     </tr>\r
  59     <tr>\r
  60         <td class="tabledata">Templates on browse</td>\r
  61         <td class="tabledata">Specifies the amount of templates that should be viewed when getting the list of templates in the database.</td>\r
  62     </tr>\r
  63     <tr>\r
  64         <td class="tabledata">Date Format</td>\r
  65         <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
  66     </tr>\r
  67     <tr>\r
  68         <td class="tabledata">Language</td>\r
  69         <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
  70     </tr>\r
  71     <tr>\r
  72         <td class="tabledata">Presentation Module</td>\r
  73         <td class="tabledata">Specifies the presentation module to use in Kiriwrite.</td>\r
  74     </tr>\r
  75     <tr>\r
  76         <td class="tabledata">Database Module</td>\r
  77         <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
  78     </tr>\r
  79     <tr>\r
  80         <td class="tabledata">Output Module</td>\r
  81         <td class="tabledata">Specifies the output module to use in Kiriwrite. Normal is the functionality that was hard-coded into Kiriwrite before version 0.5.0.</td>\r
  82     </tr>\r
  83 </table>\r
  84 \r
  85 <br>\r
  86 \r
  87 The following options are used only by the server-based database modules:<br><br>\r
  88 \r
  89 <table class="infotable">\r
  90     <tr>\r
  91         <td class="tableheading">Setting</td>\r
  92         <td class="tableheading">Description</td>\r
  93     </tr>\r
  94     <tr>\r
  95         <td class="tabledata">Database Server</td>\r
  96         <td class="tabledata">Specifies the database server to use.</td>\r
  97     </tr>\r
  98     <tr>\r
  99         <td class="tabledata">Database Port</td>\r
 100         <td class="tabledata">Specifies the database port to use.</td>\r
 101     </tr>\r
 102     <tr>\r
 103         <td class="tabledata">Database Protocol</td>\r
 104         <td class="tabledata">Specifies the database protocol to use.</td>\r
 105     </tr>\r
 106     <tr>\r
 107         <td class="tabledata">Database Name</td>\r
 108         <td class="tabledata">Specifies the database name to use.</td>\r
 109     </tr>\r
 110     <tr>\r
 111         <td class="tabledata">Database Username</td>\r
 112         <td class="tabledata">Specifies the database username to use.</td>\r
 113     </tr>\r
 114     <tr>\r
 115         <td class="tabledata">Database Password</td>\r
 116         <td class="tabledata">Specifies the database password to use.</td>\r
 117     </tr>\r
 118     <tr>\r
 119         <td class="tabledata">Database Table Prefix</td>\r
 120         <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
 121     </tr>\r
 122 </table>\r
 123 \r
 124 <br>\r
 125 \r
 126 To save the new settings, click on the 'Change Settings' button which will display a confirmation message saying that the settings were changed and will take effect on the next page load of Kiriwrite offering a link back to the updated list of settings. Clicking on the 'Restore current settings' button will undo any changes made and will restore the current settings. Clicking on the 'Return to the list of settings.' link will return to the list of currently used settings.\r
 127                 </div>\r
 128         </body>\r
 129 </html>\r