TWiki/TWikiUIViewDotPm.mdwn

   1 # <a name="Package &lt;code&gt;TWiki::UI::View="></a> Package =TWiki::UI::View
   2
   3 UI delegate for view function
   4
   5 <div>
   6   <ul>
   7     <li><a href="#Package =TWiki::UI::View="> Package TWiki::UI::View</a><ul>
   8         <li><a href="#StaticMethod <strong>view</strong> ($session)"> StaticMethod view <tt>($session)</tt></a></li>
   9         <li><a href="#StaticMethod <strong>viewfile</strong> ($sessio"> StaticMethod viewfile <tt>($session,$web,$topic,$query)</tt></a></li>
  10       </ul>
  11     </li>
  12   </ul>
  13 </div>
  14
  15 ## <a name="StaticMethod &lt;strong&gt;view&lt;/strong&gt; ($session)"></a> [[StaticMethod]] **view** `($session)`
  16
  17 `view` command handler. This method is designed to be invoked via the `UI::run` method.
  18
  19 Generate a complete HTML page that represents the viewed topics. The view is controlled by CGI parameters as follows:
  20
  21 <table border="1" cellpadding="0" cellspacing="0">
  22   <tr>
  23     <td><code>rev</code></td>
  24     <td> topic revision to view </td>
  25   </tr>
  26   <tr>
  27     <td><code>section</code></td>
  28     <td> restrict view to a named section </td>
  29   </tr>
  30   <tr>
  31     <td><code>raw</code></td>
  32     <td> no format body text if set </td>
  33   </tr>
  34   <tr>
  35     <td><code>skin</code></td>
  36     <td> comma-separated list of skin(s) to use </td>
  37   </tr>
  38   <tr>
  39     <td><code>contenttype</code></td>
  40     <td> Allows you to specify an alternate content type </td>
  41   </tr>
  42 </table>
  43
  44 ## <a name="StaticMethod &lt;strong&gt;viewfile&lt;/strong&gt; ($sessio"></a> [[StaticMethod]] **viewfile** `($session,$web,$topic,$query)`
  45
  46 `viewfile` command handler. This method is designed to be invoked via the `UI::run` method. Command handler for viewfile. View a file in the browser. Some parameters are passed in CGI query:
  47
  48 <table border="1" cellpadding="0" cellspacing="0">
  49   <tr>
  50     <td><code>filename</code></td>
  51     <td> Attachment to view </td>
  52   </tr>
  53   <tr>
  54     <td><code>rev</code></td>
  55     <td> Revision to view </td>
  56   </tr>
  57 </table>