TWiki/TWikiUIEditDotPm.mdwn

   1 # <a name="Package &lt;code&gt;TWiki::UI::Edit="></a> Package =TWiki::UI::Edit
   2
   3 Edit command handler
   4
   5 <div>
   6   <ul>
   7     <li><a href="#Package =TWiki::UI::Edit="> Package TWiki::UI::Edit</a><ul>
   8         <li><a href="#StaticMethod <strong>edit</strong> ($session)"> StaticMethod edit <tt>($session)</tt></a></li>
   9       </ul>
  10     </li>
  11   </ul>
  12 </div>
  13
  14 ## <a name="StaticMethod &lt;strong&gt;edit&lt;/strong&gt; ($session)"></a> [[StaticMethod]] **edit** `($session)`
  15
  16 Edit command handler. This method is designed to be invoked via the `UI::run` method. Most parameters are in the CGI query:
  17
  18 <table border="1" cellpadding="0" cellspacing="0">
  19   <tr>
  20     <td><code>cmd</code></td>
  21     <td> Undocumented save command, passed on to save script </td>
  22   </tr>
  23   <tr>
  24     <td><code>onlywikiname</code></td>
  25     <td> if defined, requires a wiki name for the topic name if this is a new topic </td>
  26   </tr>
  27   <tr>
  28     <td><code>onlynewtopic</code></td>
  29     <td> if defined, and the topic exists, then moans </td>
  30   </tr>
  31   <tr>
  32     <td><code>formtemplate</code></td>
  33     <td> name of the form for the topic; will replace existing form </td>
  34   </tr>
  35   <tr>
  36     <td><code>templatetopic</code></td>
  37     <td> name of the topic to copy if creating a new topic </td>
  38   </tr>
  39   <tr>
  40     <td><code>skin</code></td>
  41     <td> skin(s) to use </td>
  42   </tr>
  43   <tr>
  44     <td><code>topicparent</code></td>
  45     <td> what to put in the topic prent meta data </td>
  46   </tr>
  47   <tr>
  48     <td><code>text</code></td>
  49     <td> text that will replace the old topic text if a formtemplate is defined (what the heck is this for?) </td>
  50   </tr>
  51   <tr>
  52     <td><code>contenttype</code></td>
  53     <td> optional parameter that defines the application type to write into the CGI header. Defaults to text/html. </td>
  54   </tr>
  55   <tr>
  56     <td><code>action</code></td>
  57     <td> Optional. If supplied, use the edit${action} template instead of the standard edit template. An empty value means edit both form and text, "form" means edit form only, "text" means edit text only </td>
  58   </tr>
  59 </table>