Documentation/English (British)/user-chapter2-compiling.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.5: Compiling</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.5 Compiling</span><br><br>\r
  19 \r
  20 Compiling combines the page data with the template layout and the filters that are in the filter database to create pages as if they were created manually.<br><br>\r
  21 \r
  22 To compile the pages from their databases, click on the 'Compile Pages' menu link. A list of databases will then appear which can be compiled. If no databases are available then a message will appear saying that no databases are available.<br><br>\r
  23 \r
  24 <span class="heading">2.5.1 Compiling a database</span><br><br>\r
  25 \r
  26 To compile a database, click on the 'Compile' link opposite the database name you want to compile, a message then appears asking if the database should really be compiled. Clicking on the 'Compile Database' button will display a log of pages that have been compiled and any error messages that might appear with the link to return to the list of databases to compile at the end of the log. <br><br>\r
  27 \r
  28 The output module selected is the default output module selected in the settings menu. To change the output module, select the output module from the drop down box and then click on the Select button that is next to it. The page will then refresh showing specific options for that output module.<br><br>\r
  29 \r
  30 When compiling a database, the template being used on the pages in the database selected can be overridden. To override the templates being used, click on the 'Override the template being used' box and select the template to override with.<br><br>\r
  31 \r
  32 Clicking on the 'Return to the compile database list.' will return to the list of databases to compile.<br><br>\r
  33 \r
  34 <span class="heading">2.5.2 Compiling multiple databases</span><br><br>\r
  35 \r
  36 To compile multiple databases click on the check-box to the left of the database name for each database that should have its pages compiled and click on the 'Compile Selected' button which will display a message asking to confirm if the selected databases shown should be compiled. Clicking on the 'Compile Selected Databases' button will display a log of pages that have been compiled and any error messages that might appear with the link to return to the list of databases to compile at the end of the log. <br><br>\r
  37 \r
  38 The output module selected is the default output module selected in the settings menu. To change the output module, select the output module from the drop down box and then click on the Select button that is next to it. The page will then refresh showing specific options for that output module.<br><br>\r
  39 \r
  40 When compiling a database, the templates being used on the pages in the databases selected can be overridden. To override the templates being used, click on the 'Override the template being used' box and select the template to override with.<br><br>\r
  41 \r
  42 Clicking on the 'Return to the compile database list.' will return to the list of databases to compile.<br><br>\r
  43 \r
  44 <span class="heading">2.5.3 Compiling all databases</span><br><br>\r
  45 \r
  46 To compile all of the available databases click on the 'Compile All' link in the Compile Pages sub-menu which will display a message asking to confirm if all of the databases should have its pages compiled. Clicking on the 'Compile All Databases' button will display a log of pages that have been compiled and any error messages that might appear with the link to return to the list of databases to compile at the end of the log.<br><br>\r
  47 \r
  48 The output module selected is the default output module selected in the settings menu. To change the output module, select the output module from the drop down box and then click on the Select button that is next to it. The page will then refresh showing specific options for that output module.<br><br>\r
  49 \r
  50 When compiling a database, the templates being used on the pages in all of the databases can be overridden. To override the templates being used, click on the 'Override the template being used' box and select the template to override with.<br><br>\r
  51 \r
  52 Clicking on the 'Return to the compile database list.' link will return to the list of databases to compile.<br><br>\r
  53 \r
  54 <span class="heading">2.5.4 Cleaning the output directory</span><br><br>\r
  55 \r
  56 Cleaning the output directory removes all of the contents that is in the output directory. To clean the output directory click on the 'Clean Output Directory' link which will display a message asking to confirm that the output directory should be cleaned. Clicking on the 'Yes, clean output directory' will display a confirmation message saying that the output directory was cleaned. Clicking on the 'Return to the compile database list.' link will return to the list of databases to compile.\r
  57                 </div>\r
  58         </body>\r
  59 </html>\r