Documentation/English (British)/developer-chapter3-editpage.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.29: editpage</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.29 editpage</span><br><br>\r
  19 \r
  20 Edits a page in the selected database.<br><br>\r
  21 \r
  22 <span class="heading">Parameters:</span><br><br>\r
  23 \r
  24 <div class="code">\r
  25     $kiriwrite_dbmodule->editpage(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->selectdb(&quot;database&quot;);<br>\r
  34     $kiriwrite_dbmodule->editpage({ PageFilename => &quot;page.html&quot;, PageNewFilename => &quot;editedpage.html&quot;, PageNewName => &quot;Edited Page Name&quot;, PageNewDescription => &quot;Edited Page Description&quot;, PageNewSection => &quot;Edited Page Section&quot;, PageNewTemplate => &quot;editedpagetemplate.html&quot;, PageNewContent => &quot;This is the edited page content.&quot;, PageNewSettings => 0 });\r
  35 </div>\r
  36 \r
  37 <br>\r
  38 \r
  39 options<br>\r
  40 Specifies the following options as a hash in any order.<br><br>\r
  41 \r
  42 <table class="infotable">\r
  43     <tr>\r
  44         <td class="tableheading">Value</td>\r
  45         <td class="tableheading">Description</td>\r
  46     </tr>\r
  47     <tr>\r
  48         <td class="tabledata">PageFilename</td>\r
  49         <td class="tabledata">Specifies the page with the filename to edit.</td>\r
  50     </tr>\r
  51     <tr>\r
  52         <td class="tabledata">PageNewFilename</td>\r
  53         <td class="tabledata">Specifies the new filename of the page.</td>\r
  54     </tr>\r
  55     <tr>\r
  56         <td class="tabledata">PageNewName</td>\r
  57         <td class="tabledata">Specifies the new name of the page.</td>\r
  58     </tr>\r
  59     <tr>\r
  60         <td class="tabledata">PageNewDescription</td>\r
  61         <td class="tabledata">Specifies the new description of the page.</td>\r
  62     </tr>\r
  63     <tr>\r
  64         <td class="tabledata">PageNewSection</td>\r
  65         <td class="tabledata">Specifies the new section of the page.</td>\r
  66     </tr>\r
  67     <tr>\r
  68         <td class="tabledata">PageNewTemplate</td>\r
  69         <td class="tabledata">Specifies the new template filename to use.</td>\r
  70     </tr>\r
  71     <tr>\r
  72         <td class="tabledata">PageNewContent</td>\r
  73         <td class="tabledata">Specifies the new page content to use.</td>\r
  74     </tr>\r
  75     <tr>\r
  76         <td class="tabledata">PageNewSettings</td>\r
  77         <td class="tabledata">Specifies the new page settings to use.<br>\r
  78             1: Use page name and section name.<br>\r
  79             2: Use the page name only.<br>\r
  80             3: Use the section name only.<br>\r
  81             0: Don't use page name or section name.\r
  82         </td>\r
  83     </tr>\r
  84 </table>\r
  85 \r
  86 <br>\r
  87 \r
  88 If the page does not already exist then the error returned should be 'PageDoesNotExist' in the $error scalar.<br><br>\r
  89 \r
  90 If a page with the filename given already exists when renaming the filename of the page then the error returned should be 'PageExists' in the $error scalar.<br><br>\r
  91 \r
  92 If a database error occurs while editing a page in the database then the error returned should be 'DatabaseError' in the $error scalar and information about the error should be in the $errorext scalar.\r
  93                 </div>\r
  94         </body>\r
  95 </html>\r