Documentation/English (British)/developer-chapter2-convert.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 - 2.5: convert</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 convert</span><br><br>\r
  19 \r
  20 Converts the data passed into data that is compliant with the format used by the presentation module. All parameters in the subroutine will be used.<br><br>\r
  21 \r
  22 <span class="heading">Parameters:</span><br><br>\r
  23 \r
  24 <div class="code">\r
  25     $kiriwrite_presmodule->convert(data, type);\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_presmodule->convert(&quot;http://link/%7Epage%quot;, &quot;link&quot;);\r
  34 </div>\r
  35 \r
  36 <br>\r
  37 \r
  38 data<br>\r
  39 Specifies the data to convert.<br><br>\r
  40 \r
  41 type<br>\r
  42 Specifies the type of data to convert.<br><br>\r
  43 \r
  44 <table class="infotable">\r
  45     <tr>\r
  46         <td class="tableheading">Value</td>\r
  47         <td class="tableheading">Description</td>\r
  48     </tr>\r
  49     <tr>\r
  50         <td class="tabledata">content</td>\r
  51         <td class="tabledata">Specifies the data to convert is for content.</td>\r
  52     </tr>\r
  53     <tr>\r
  54         <td class="tabledata">link</td>\r
  55         <td class="tabledata">Specifies the data to convert is for a link.</td>\r
  56     </tr>\r
  57 </table>\r
  58 \r
  59 <br>\r
  60 \r
  61 Bear in mind that while convert is not used by the main Kiriwrite script it can be used internally to convert text to be used in links and forms.\r
  62                 </div>\r
  63         </body>\r
  64 </html>\r