VarREVINFO < System

You are here: Foswiki>System Web>Macros>VarREVINFOEditAttach

#VarREVINFO
---+++ REVINFO -- revision information of current topic
   * Syntax:
   * Date format defined as ={DefaultDateFormat}= in [[%SCRIPTURLPATH{"configure"}%#Locale$Internationalisation][configure]]
---+++ REVINFO{"format"} -- formatted revision information of topic
   * Syntax: =%<nop>REVINFO%= OR =%<nop>REVINFO{"format"}%=
   * =%<nop>REVINFO%= is equivalent to =%<nop>REVINFO{format="r1.$rev - $date - $wikiusername"}%=
      * Expands to: <code>%REVINFO%</code>
   * Supported parameters:
     | *Parameter:* | *Description:* | *Default:* |
     | ="format"= | Format of revision information, see supported formatting tokens below | ="r1.$rev - $date - $wikiusername"= |
     | =web="..."= | Name of web | Current web |
     | =topic="..."= | Topic name | Current topic |
     | =rev="1.5"= | Specific revision number | Latest revision |
   * Supported formatting tokens:
     | *Token:* | *Unit:* | *Example* |
     | =$web= | Name of web | Current web |
     | =$topic= | Topic name | Current topic |
     | =$rev= | Revision number. Prefix =r1.= to get the usual =r1.5= format | =5= |
     | =$username= | Login username of revision | =jsmith= |
     | =$wikiname= | WikiName of revision | =JohnSmith= |
     | =$wikiusername= | <nop>WikiName with %USERSWEB% web prefix | =%USERSWEB%.JohnSmith= |
     | =$date= | Revision date. Actual date format defined as {DefaultDateFormat} in [[%SCRIPTURLPATH{"configure"}%][configure]] | =21 Sep 2006= |
     | =$time= | Revision time | =23:24:25= |
     | =$iso= | Revision date in ISO date format | =2006-09-22T06:24:25Z= |
     | =$min=, =$sec=, etc. | Same date format qualifiers as [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarGMTIME][GMTIME{"format"}]] | |
   * Example, returns revision info of first revision: <verbatim class="tml">%REVINFO{"$date - $wikiusername" rev="1.1"}%</verbatim> 
   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarGMTIME][GMTIME{"format"}]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarREVINFO][REVINFO]]
<!--%JQREQUIRE{"chili"}%-->

Topic revision: r1 - 09 Jan 2009, ProjectContributor

System

Copyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback