Documentation/English (British)/user-chapter2-databases.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 - 2.1: Databases</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">2.1 Databases</span><br><br>\r
  19 Databases are used for storing the pages that are created in Kiriwrite. Before pages can be stored in a database, a database has to be created.<br><br>\r
  20 The default view when you run the Kiriwrite script is to show the list of databases. If there are no databases available, then a message appears saying that there are no databases than can be used.<br><br>\r
  21 <span class="heading">2.1.1 Add a database</span><br><br>\r
  22 To add a database, from the View Databases sub-menu click on the 'Add Database' link, a form then appears allowing to enter the information about the new database.<br><br>\r
  23 \r
  24 <table class="infotable">\r
  25     <tr>\r
  26         <td class="tableheading">Settings</td>\r
  27         <td class="tableheading">Description</td>\r
  28     </tr>\r
  29     <tr>\r
  30         <td class="tabledata">Database Name</td>\r
  31         <td class="tabledata">Specifies the database name of the new Kiriwrite database.</td>\r
  32     </tr>\r
  33     <tr>\r
  34         <td class="tabledata">Database Description</td>\r
  35         <td class="tabledata">Specifies the description of the new Kiriwrite database.</td>\r
  36     </tr>\r
  37     <tr>\r
  38         <td class="tabledata">Database Categories</td>\r
  39         <td class="tabledata">Specifies the categories the database should belong to.</td>\r
  40     </tr>\r
  41     <tr>\r
  42         <td class="tabledata">Database Notes</td>\r
  43         <td class="tabledata">The notes that gives information about the database.</td>\r
  44     </tr>\r
  45     <tr>\r
  46         <td class="tabledata">Database Filename</td>\r
  47         <td class="tabledata">Specifies the database filename to use. If nothing is entered for the filename than an attempt to automatically generate a filename will be done.</td>\r
  48     </tr>\r
  49 </table>\r
  50 \r
  51 <br>\r
  52 \r
  53 To add the database with the settings given, click on the 'Add Database' button and a confirmation message should then appear saying that the database has been added and offering a link back to the list of databases. To clear the settings, click on the 'Clear values' button.<br><br>\r
  54 \r
  55 <span class="heading">2.2 Edit a database</span><br><br>\r
  56 To edit a database, click on the 'Edit' link opposite the name and description of the database you want to edit. A form then appears similar to the form for adding a database.<br><br>\r
  57 \r
  58 <table class="infotable">\r
  59     <tr>\r
  60         <td class="tableheading">Settings</td>\r
  61         <td class="tableheading">Description</td>\r
  62     </tr>\r
  63     <tr>\r
  64         <td class="tabledata">Database Name</td>\r
  65         <td class="tabledata">Specifies the new database name of the Kiriwrite database.</td>\r
  66     </tr>\r
  67     <tr>\r
  68         <td class="tabledata">Database Description</td>\r
  69         <td class="tabledata">Specifies the new description of the Kiriwrite database.</td>\r
  70     </tr>\r
  71     <tr>\r
  72         <td class="tabledata">Database Categories</td>\r
  73         <td class="tabledata">Specifies the new categories the database should belong to.</td>\r
  74     </tr>\r
  75     <tr>\r
  76         <td class="tabledata">Database Notes</td>\r
  77         <td class="tabledata">The notes that gives information about the database.</td>\r
  78     </tr>\r
  79     <tr>\r
  80         <td class="tabledata">Database Filename</td>\r
  81         <td class="tabledata">Specifies the database filename to use.</td>\r
  82     </tr>\r
  83 </table>\r
  84 \r
  85 <br>\r
  86 \r
  87 To edit a database with the new settings given click on the 'Edit Database' button and a confirmation message should appear saying that the database has been edited and offering a link back to the database list. Clicking on the 'Restore current settings' button will undo any changes and revert to the currently used settings.<br><br>\r
  88 \r
  89 <span class="heading">2.3 Delete a database</span><br><br>\r
  90 To delete a database, click on the 'Delete' link opposite. A message then appears asking if the selected database should be deleted. Clicking on the 'Yes, delete the database' button will delete the database and display a confirmation message saying that the selected database has been deleted offering a link to return to the database list. Clicking on 'No, return to the database list.' link will make it return to the database list.<br><br>\r
  91 \r
  92 <div class="warningbox">\r
  93     <div class="message warning">\r
  94         <span class="warningtext">\r
  95             <b>Warning</b><br>\r
  96             When a database is deleted, the pages in the database are deleted as well.\r
  97         </span>\r
  98     </div>\r
  99 </div>\r
 100                 </div>\r
 101         </body>\r
 102 </html>\r