Documentation/English (British)/developer-chapter1-kiriwritecompilemakepages.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 - 1.23: kiriwrite_compile_makepages</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.23 kiriwrite_compile_makepages</span><br><br>\r
  19 \r
  20 kiriwrite_compile_makepages compiles the pages in the database with the templates (if they have one assigned), applies any filter settings (if any are in the filter database) and writes them to the output directory.<br><br>\r
  21 \r
  22 kiriwrite_compile_makepages will return data that is intended for kiriwrite_output_page.<br><br>\r
  23 \r
  24 <span class="heading">Parameters:</span><br><br>\r
  25 \r
  26 <div class="code">\r
  27     kiriwrite_compile_makepages(type, confirm, override, overridetemplate, selectedlist);\r
  28 </div>\r
  29 \r
  30 <br>\r
  31 \r
  32 <span class="heading">Usage:</span><br><br>\r
  33 \r
  34 <div class="code">\r
  35     $pagedata = kiriwrite_compile_makepages(&quot;single&quot;, 0, 0, &quot;&quot;, ['database1']);<br>\r
  36     $pagedata = kiriwrite_compile_makepages(&quot;single&quot;, 1, 0, &quot;&quot;, ['database1']);<br>\r
  37     $pagedata = kiriwrite_compile_makepages(&quot;multiple&quot;, 0, 1, &quot;template.html&quot;, ['database1','database2','database3','database4']);<br>\r
  38     $pagedata = kiriwrite_compile_makepages(&quot;multiple&quot;, 1, 0, &quot;&quot;, ['database1','database2','database3','database4']);\r
  39 </div>\r
  40 \r
  41 <br>\r
  42 \r
  43 type<br>\r
  44 Specifies the type meaning if a single or multiple databases should be compiled. This is required every time the subroutine is called.<br><br>\r
  45 \r
  46 <table class="infotable">\r
  47     <tr>\r
  48         <td class="tableheading">Value</td>\r
  49         <td class="tableheading">Description</td>\r
  50     </tr>\r
  51     <tr>\r
  52         <td class="tabledata">single</td>\r
  53         <td class="tabledata">Specifies that a single database should be compiled.</td>\r
  54     </tr>\r
  55     <tr>\r
  56         <td class="tabledata">multiple</td>\r
  57         <td class="tabledata">Specifies that multiple databases should be compiled.</td>\r
  58     </tr>\r
  59 </table>\r
  60 \r
  61 <br>\r
  62 \r
  63 confirm<br>\r
  64 Specifies if the action to compile the selected database should be confirmed by passing a '1'. This is required every time the subroutine is called.<br><br>\r
  65 \r
  66 override<br>\r
  67 Override the template being used with the overridetemplate value.<br><br>\r
  68 \r
  69 overridetemplate<br>\r
  70 Override the template using the filename given.<br><br>\r
  71 \r
  72 selectedlist<br>\r
  73 Specifies the list of databases to compile as an array. This is required every time the subroutine is called.\r
  74                 </div>\r
  75         </body>\r
  76 </html>\r