Documentation/English (British)/developer-chapter1-kiriwritepageedit.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.4: kiriwrite_page_edit</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.4 kiriwrite_page_edit</span><br><br>\r
  19 \r
  20 kiriwrite_page_edit will edit a page from the selected database. If the confirm value is not supplied then it will write a form for editing a page and if no database and page filename is specified then an error is returned saying no database was specified.<br><br>\r
  21 \r
  22 kiriwrite_page_edit 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_page_edit(database, filename, newfilename, newname, newdescription, newsection, newtemplate, newsettings, newcontent, confirm);\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_page_edit(&quot;database&quot;, &quot;oldfilename.html&quot;);<br>\r
  36 $pagedata = kiriwrite_page_edit(&quot;database&quot;, &quot;oldfilename.html&quot;, &quot;newfilename.html&quot;, &quot;New Page Filename&quot;, &quot;New Page Description&quot;, &quot;New Page Section&quot;, &quot;newtemplate.html&quot;, 0, &quot;New Page Content, blah, blah, blah, blah&quot;, 1);\r
  37 </div>\r
  38 \r
  39 <br>\r
  40 \r
  41 database<br>\r
  42 Specifies the database to edit the page from. This is required every time the subroutine is called.<br><br>\r
  43 \r
  44 filename<br>\r
  45 Specifies the page with the filename to edit. This is required every time the subroutine is called.<br><br>\r
  46 \r
  47 <i>newfilename</i><br>\r
  48 Specifies the new page filename to use when editing a page. If you specify the same filename as the one given in the filename parameter then the filename of the page is not changed. This is required when actually editing a page and cannot be blank.<br><br>\r
  49 \r
  50 <i>newname</i><br>\r
  51 Specifies the new page name to use when editing a page. This is required when actually editing a page.<br><br>\r
  52 \r
  53 <i>newdescription</i><br>\r
  54 Specifies the new description to use when editing a page. This is required when actually editing a page.<br><br>\r
  55 \r
  56 <i>newsection</i><br>\r
  57 Specifies the new section to use when editing a page. This is required when actually editing a page.<br><br>\r
  58 \r
  59 <i>newtemplate</i><br>\r
  60 Specifies the new template filename to use when editing a page. This is required when actually editing a page and cannot be blank.<br><br>\r
  61 \r
  62 <i>newsettings</i><br>\r
  63 Specifies the new settings to use when editing a page. This is required when actually editing a page and cannot be blank. The following values specify what should be done to the page when using the &lt;kiriwrite:pagetitle&gt; and &lt;kiriwrite:autosection&gt; tags.<br><br>\r
  64 \r
  65 <table class="infotable">\r
  66     <tr>\r
  67         <td class="tableheading">Value</td>\r
  68         <td class="tableheading">Description</td>\r
  69     </tr>\r
  70     <tr>\r
  71         <td class="tabledata">0</td>\r
  72         <td class="tabledata">Don't use the page name or section name.</td>\r
  73     </tr>\r
  74     <tr>\r
  75         <td class="tabledata">1</td>\r
  76         <td class="tabledata">Use the page name and section name.</td>\r
  77     </tr>\r
  78     <tr>\r
  79         <td class="tabledata">2</td>\r
  80         <td class="tabledata">Use the page name only.</td>\r
  81     </tr>\r
  82     <tr>\r
  83         <td class="tabledata">3</td>\r
  84         <td class="tabledata">Use the section name only.</td>\r
  85     </tr>\r
  86 </table>\r
  87 \r
  88 <br>\r
  89 \r
  90 <i>newcontent</i><br>\r
  91 Specifies the new content to use when editing a page. This is required when actually editing a page.<br><br>\r
  92 \r
  93 <i>confirm</i><br>\r
  94 Specifies if the action to edit the page should be confirmed by passing a '1'.\r
  95                 </div>\r
  96         </body>\r
  97 </html>\r