TWiki/TWikiUIRDiffDotPm.mdwn

   1 # <a name="Package &lt;code&gt;TWiki::UI::RDiff="></a> Package =TWiki::UI::RDiff
   2
   3 UI functions for diffing.
   4
   5 <div>
   6   <ul>
   7     <li><a href="#Package =TWiki::UI::RDiff="> Package TWiki::UI::RDiff</a><ul>
   8         <li><a href="#StaticMethod <strong>diff</strong> ($session,$w"> StaticMethod diff <tt>($session,$web,$topic,$query)</tt></a></li>
   9       </ul>
  10     </li>
  11   </ul>
  12 </div>
  13
  14 ## <a name="StaticMethod &lt;strong&gt;diff&lt;/strong&gt; ($session,$w"></a> [[StaticMethod]] **diff** `($session,$web,$topic,$query)`
  15
  16 `diff` command handler. This method is designed to be invoked via the `TWiki::UI::run` method.
  17
  18 Renders the differences between version of a [[TwikiTopic]]
  19
  20 <table border="1" cellpadding="0" cellspacing="0">
  21   <tr>
  22     <td> topic </td>
  23     <td> topic that we are showing the differences of </td>
  24   </tr>
  25   <tr>
  26     <td> rev1 </td>
  27     <td> the higher revision </td>
  28   </tr>
  29   <tr>
  30     <td> rev2 </td>
  31     <td> the lower revision </td>
  32   </tr>
  33   <tr>
  34     <td> render </td>
  35     <td> the rendering style {sequential, sidebyside, raw, debug} </td>
  36     <td> (preferences) DIFFRENDERSTYLE, <code>sequential</code></td>
  37   </tr>
  38   <tr>
  39     <td> type </td>
  40     <td> {history, diff, last} history diff, version to version, last version to previous </td>
  41     <td><code>history</code></td>
  42   </tr>
  43   <tr>
  44     <td> context </td>
  45     <td> number of lines of context </td>
  46   </tr>
  47   <tr>
  48     <td> skin </td>
  49     <td> the skin(s) to use to display the diff </td>
  50   </tr>
  51 </table>
  52
  53 TODO:
  54
  55 - add a \{word\} render style
  56 - move the common CGI param handling to one place
  57 - move defaults somewhere