TWiki/VarREVINFO2.mdwn

   1 <a name="VarREVINFO2"></a>
   2
   3 ### <a name="REVINFO{&quot;format&quot;} -- formatted r"></a> REVINFO\{"format"\} -- formatted revision information of topic
   4
   5 - Syntax: `%REVINFO{"format"}%`
   6 - Supported parameters: <table border="1" cellpadding="0" cellspacing="0">
   7   <tr>
   8     <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
   9     <th bgcolor="#99CCCC"><strong> Description: </strong></th>
  10     <th bgcolor="#99CCCC"><strong> Default: </strong></th>
  11   </tr>
  12   <tr>
  13     <td><code>"format"</code></td>
  14     <td> Format of revision information, see supported variables below </td>
  15     <td><code>"r1.$rev - $date - $wikiusername"</code></td>
  16   </tr>
  17   <tr>
  18     <td><code>web="..."</code></td>
  19     <td> Name of web </td>
  20     <td> Current web </td>
  21   </tr>
  22   <tr>
  23     <td><code>topic="..."</code></td>
  24     <td> Topic name </td>
  25     <td> Current topic </td>
  26   </tr>
  27   <tr>
  28     <td><code>rev="1.5"</code></td>
  29     <td> Specific revison number </td>
  30     <td> Latest revision </td>
  31   </tr>
  32 </table>
  33 - Supported variables in format: <table border="1" cellpadding="0" cellspacing="0">
  34   <tr>
  35     <th bgcolor="#99CCCC"><strong> Variable: </strong></th>
  36     <th bgcolor="#99CCCC"><strong> Unit: </strong></th>
  37     <th bgcolor="#99CCCC"><strong> Example </strong></th>
  38   </tr>
  39   <tr>
  40     <td><code>$web</code></td>
  41     <td> Name of web </td>
  42     <td> Current web </td>
  43   </tr>
  44   <tr>
  45     <td><code>$topic</code></td>
  46     <td> Topic name </td>
  47     <td> Current topic </td>
  48   </tr>
  49   <tr>
  50     <td><code>$rev</code></td>
  51     <td> Revison number. Prefix <code>r1.</code> to get the usual <code>r1.5</code> format </td>
  52     <td><code>5</code></td>
  53   </tr>
  54   <tr>
  55     <td><code>$username</code></td>
  56     <td> Login username of revision </td>
  57     <td><code>jsmith</code></td>
  58   </tr>
  59   <tr>
  60     <td><code>$wikiname</code></td>
  61     <td>[[Main/WikiName]] of revision </td>
  62     <td><code>JohnSmith</code></td>
  63   </tr>
  64   <tr>
  65     <td><code>$wikiusername</code></td>
  66     <td> WikiName with %USERSWEB% web prefix </td>
  67     <td><code>%USERSWEB%.JohnSmith</code></td>
  68   </tr>
  69   <tr>
  70     <td><code>$date</code></td>
  71     <td> Revision date. Actual date format defined as {DefaultDateFormat} in <a href="http://www.dementia.org/twiki/configure" target="_top">configure</a></td>
  72     <td><code>21 Sep 2006</code></td>
  73   </tr>
  74   <tr>
  75     <td><code>$time</code></td>
  76     <td> Revision time </td>
  77     <td><code>23:24:25</code></td>
  78   </tr>
  79   <tr>
  80     <td><code>$iso</code></td>
  81     <td> Revision date in ISO date format </td>
  82     <td><code>2006-09-22T06:24:25Z</code></td>
  83   </tr>
  84   <tr>
  85     <td><code>$min</code>, <code>$sec</code>, etc. </td>
  86     <td> Same date format qualifiers as [[Main/VarGMTIME2]]</td>
  87     <td>   </td>
  88   </tr>
  89 </table>
  90 - Example: `%REVINFO{"$date - $wikiusername" rev="1.1"}%` returns revision info of first revision
  91 - Related: [[GMTIME{"format"}|Main/VarGMTIME2]], [[REVINFO|Main/VarREVINFO]]