Documentation/English (British)/developer-chapter3-addtemplate.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 - Developer Documentation - 3.23: addtemplate</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">3.23 addtemplate</span><br><br>\r
  19 \r
  20 Add a template to the template database. If the template database doesn't exist then it should be created in this subroutine.<br><br>\r
  21 \r
  22 <span class="heading">Parameters:</span><br><br>\r
  23 \r
  24 <div class="code">\r
  25     $kiriwrite_dbmodule->addtemplate(options);\r
  26 </div>\r
  27 \r
  28 <br>\r
  29 \r
  30 <span class="heading">Usage:</span><br><br>\r
  31 \r
  32 <div class="code">\r
  33     $kiriwrite_dbmodule->addtemplate({ TemplateFilename => &quot;template.html&quot;, TemplateName => &quot;Template Name&quot;, TemplateDescription => &quot;Template Description&quot;, TemplateLayout => &quot;This is the template layout.&quot; });\r
  34 </div>\r
  35 \r
  36 <br>\r
  37 \r
  38 options<br>\r
  39 Specifies the following options as a hash in any order.<br><br>\r
  40 \r
  41 <table class="infotable">\r
  42     <tr>\r
  43         <td class="tableheading">Value</td>\r
  44         <td class="tableheading">Description</td>\r
  45     </tr>\r
  46     <tr>\r
  47         <td class="tabledata">TemplateFilename</td>\r
  48         <td class="tabledata">Specifies the template filename to use.</td>\r
  49     </tr>\r
  50     <tr>\r
  51         <td class="tabledata">TemplateName</td>\r
  52         <td class="tabledata">Specifies the template name to use.</td>\r
  53     </tr>\r
  54     <tr>\r
  55         <td class="tabledata">TemplateDescription</td>\r
  56         <td class="tabledata">Specifies the template description to use.</td>\r
  57     </tr>\r
  58     <tr>\r
  59         <td class="tabledata">TemplateLayout</td>\r
  60         <td class="tabledata">Specifies the template layout to use.</td>\r
  61     </tr>\r
  62 </table>\r
  63 \r
  64 <br>\r
  65 \r
  66 If the template filename already exists when adding the template then the error returned should be 'TemplatePageExists' in the $error scalar.<br><br>\r
  67 \r
  68 If the template database cannot be created when adding a template and the template database doesn't already exist then the error returned should be 'TemplateDatabaseFileUncreatable' in the $error scalar.<br><br>\r
  69 \r
  70 If (when using a file-based database module) the template database has invalid permissions set then the error returned should be 'TemplateDatabaseInvalidPermissionsSet' in the $error scalar.<br><br>\r
  71 \r
  72 If a database error occurs while adding a template to the template database then the error returned should be 'TemplateDatabaseError' in the $error scalar and information about the error should be placed in the $errorext scalar.\r
  73                 </div>\r
  74         </body>\r
  75 </html>\r