TWiki/SpreadSheetPlugin.mdwn

   1 # <a name="TWiki Spreadsheet Plugin"></a><a name=" TWiki Spreadsheet Plugin"></a> TWiki Spreadsheet Plugin
   2
   3 This Plugin adds speadsheet capabilities to %WIKITOOLNAME% topics. Formulae like <code>**%CALC\{"$INT(7/3)"\}%**</code> are evaluated at page view time. They can be placed in table cells and outside of tables. In other words, this Plugin provides general formula evaluation capability, not just classic spreadsheet functions.
   4
   5 <table>
   6   <tr>
   7     <td valign="top"><strong><em>Example:</em></strong><p>
   8       </p>
   9       <table border="1" cellpadding="0" cellspacing="0">
  10         <tr>
  11           <th bgcolor="#99CCCC"><strong> Region: </strong></th>
  12           <th bgcolor="#99CCCC"><strong> Sales: </strong></th>
  13         </tr>
  14         <tr>
  15           <td> Northeast </td>
  16           <td align="right"> 320 </td>
  17         </tr>
  18         <tr>
  19           <td> Northwest </td>
  20           <td align="right"> 580 </td>
  21         </tr>
  22         <tr>
  23           <td> South </td>
  24           <td align="right"> 240 </td>
  25         </tr>
  26         <tr>
  27           <td> Europe </td>
  28           <td align="right"> 610 </td>
  29         </tr>
  30         <tr>
  31           <td> Asia </td>
  32           <td align="right"> 220 </td>
  33         </tr>
  34         <tr>
  35           <td> Total: </td>
  36           <td align="right"> 1970 </td>
  37         </tr>
  38       </table>
  39       <p>
  40       </p>
  41     </td>
  42     <td>     </td>
  43     <td valign="top"><strong><em>Interactive example:</em></strong><p>
  44       </p>
  45       <form action="http://www.dementia.org/twiki//view/%WEB%/%TOPIC%" method="get" name="interactive"> Formula: <code>%CALC{"</code><input name="formula" size="40" type="text" value="$PROPERSPACE(admin)" /><code>"}%</code>   <input type="submit" value="Go" /><br /> Result:     admin <p>
  46         </p>
  47       </form>
  48     </td>
  49   </tr>
  50   <tr>
  51     <td colspan="3"> The formula next to "Total" is <code><b>%CALC{"$SUM( $ABOVE() )"}%</b></code>. <br /> (you see the formula instead of the sum in case the Plugin is not installed or not enabled.) </td>
  52   </tr>
  53 </table>
  54
  55 <div>
  56   <ul>
  57     <li><a href="#Syntax Rules"> Syntax Rules</a></li>
  58     <li><a href="#Built-in Functions"> Built-in Functions</a><ul>
  59         <li><a href="#ABOVE( ) -- address range of cel"> ABOVE( ) -- address range of cells above the current cell</a></li>
  60         <li><a href="#ABS( num ) -- absolute value of"> ABS( num ) -- absolute value of a number</a></li>
  61         <li><a href="#AND( list ) -- logcial AND of a"> AND( list ) -- logcial AND of a list</a></li>
  62         <li><a href="#AVERAGE( list ) -- average of a"> AVERAGE( list ) -- average of a list or a range of cells</a></li>
  63         <li><a href="#CHAR( number ) -- ASCII characte"> CHAR( number ) -- ASCII character represented by number</a></li>
  64         <li><a href="#CODE( text ) -- ASCII numeric va"> CODE( text ) -- ASCII numeric value of character</a></li>
  65         <li><a href="#COLUMN( offset ) -- current colu"> COLUMN( offset ) -- current column number</a></li>
  66         <li><a href="#COUNTITEMS( list ) -- count indi"> COUNTITEMS( list ) -- count individual items in a list</a></li>
  67         <li><a href="#COUNTSTR( list, str ) -- count t"> COUNTSTR( list, str ) -- count the number of cells in a list equal to a given string</a></li>
  68         <li><a href="#DEF( list ) -- find first non-em"> DEF( list ) -- find first non-empty list item or cell</a></li>
  69         <li><a href="#EVAL( formula ) -- evaluate a si"> EVAL( formula ) -- evaluate a simple formula</a></li>
  70         <li><a href="#EXACT( text1, text2 ) -- compare"> EXACT( text1, text2 ) -- compare two text strings</a></li>
  71         <li><a href="#FIND( string, text, start ) -- f"> FIND( string, text, start ) -- find one string within another string</a></li>
  72         <li><a href="#FORMAT( type, prec, number ) --"> FORMAT( type, prec, number ) -- format a number to a certain type and precision</a></li>
  73         <li><a href="#FORMATTIME( serial, text ) -- co"> FORMATTIME( serial, text ) -- convert a serialized date into a date string</a></li>
  74         <li><a href="#FORMATGMTIME( serial, text ) --"> FORMATGMTIME( serial, text ) -- convert a serialized date into a GMT date string</a></li>
  75         <li><a href="#GET( name ) -- get the value of"> GET( name ) -- get the value of a previously set variable</a></li>
  76         <li><a href="#IF( condition, value if true, va"> IF( condition, value if true, value if 0 ) -- return a value based on a condition</a></li>
  77         <li><a href="#INT( formula ) -- evaluate formu"> INT( formula ) -- evaluate formula and round down to nearest integer</a></li>
  78         <li><a href="#LEFT( ) -- address range of cell"> LEFT( ) -- address range of cells to the left of the current cell</a></li>
  79         <li><a href="#LENGTH( text ) -- length of text"> LENGTH( text ) -- length of text in bytes</a></li>
  80         <li><a href="#LIST( range ) -- convert content"> LIST( range ) -- convert content of a cell range into a list</a></li>
  81         <li><a href="#LISTIF( condition, list ) -- rem"> LISTIF( condition, list ) -- remove elements from a list that do not meet a condition</a></li>
  82         <li><a href="#LISTITEM( index, list ) -- get o"> LISTITEM( index, list ) -- get one element of a list</a></li>
  83         <li><a href="#LISTMAP( formula, list ) -- eval"> LISTMAP( formula, list ) -- evaluate and update each element of a list</a></li>
  84         <li><a href="#LISTREVERSE( list ) -- opposite"> LISTREVERSE( list ) -- opposite order of a list</a></li>
  85         <li><a href="#LISTSIZE( list ) -- number of el"> LISTSIZE( list ) -- number of elements in a list</a></li>
  86         <li><a href="#LISTSORT( list ) -- sort a list"> LISTSORT( list ) -- sort a list</a></li>
  87         <li><a href="#LISTUNIQUE( list ) -- remove all"> LISTUNIQUE( list ) -- remove all duplicates from a list</a></li>
  88         <li><a href="#LOWER( text ) -- lower case stri"> LOWER( text ) -- lower case string of a text</a></li>
  89         <li><a href="#MAX( list ) - biggest value of a"> MAX( list ) - biggest value of a list or range of cells</a></li>
  90         <li><a href="#MEDIAN( list ) -- median of a li"> MEDIAN( list ) -- median of a list or range of cells</a></li>
  91         <li><a href="#MIN( list ) -- smallest value of"> MIN( list ) -- smallest value of a list or range of cells</a></li>
  92         <li><a href="#MOD( num, divisor ) -- reminder"> MOD( num, divisor ) -- reminder after dividing num by divisor</a></li>
  93         <li><a href="#NOP( text ) -- no-operation"> NOP( text ) -- no-operation</a></li>
  94         <li><a href="#NOT( num ) -- reverse logic of a"> NOT( num ) -- reverse logic of a number</a></li>
  95         <li><a href="#OR( list ) -- logcial OR of a li"> OR( list ) -- logcial OR of a list</a></li>
  96         <li><a href="#PRODUCT( list ) -- product of a"> PRODUCT( list ) -- product of a list or range of cells</a></li>
  97         <li><a href="#PROPER( text ) -- properly capit"> PROPER( text ) -- properly capitalize trxt</a></li>
  98         <li><a href="#PROPERSPACE( text ) -- properly"> PROPERSPACE( text ) -- properly space out WikiWords</a></li>
  99         <li><a href="#RAND( max ) -- random number"> RAND( max ) -- random number</a></li>
 100         <li><a href="#REPEAT(text) -- repeat text a nu"> REPEAT(text) -- repeat text a number of times</a></li>
 101         <li><a href="#REPLACE( text, start, num, new )"> REPLACE( text, start, num, new ) -- replace part of a text string</a></li>
 102         <li><a href="#RIGHT( ) -- address range of cel"> RIGHT( ) -- address range of cells to the right of the current cell</a></li>
 103         <li><a href="#ROUND( formula, digits ) -- roun"> ROUND( formula, digits ) -- round a number</a></li>
 104         <li><a href="#ROW( offset ) -- current row num"> ROW( offset ) -- current row number</a></li>
 105         <li><a href="#SEARCH( string, text, start ) --"> SEARCH( string, text, start ) -- search a string within a text</a></li>
 106         <li><a href="#SET( name, value ) -- set a vari"> SET( name, value ) -- set a variable for later use</a></li>
 107         <li><a href="#SETM( name, formula ) -- update"> SETM( name, formula ) -- update an existing variable based on a formula</a></li>
 108         <li><a href="#SIGN( num ) -- sign of a number"> SIGN( num ) -- sign of a number</a></li>
 109         <li><a href="#SUBSTITUTE( text, old, new, inst"> SUBSTITUTE( text, old, new, instance, option ) -- substitute text</a></li>
 110         <li><a href="#SUM( list ) -- sum of a list or"> SUM( list ) -- sum of a list or range of cells</a></li>
 111         <li><a href="#SUMDAYS( list ) -- sum the days"> SUMDAYS( list ) -- sum the days in a list or range of cells</a></li>
 112         <li><a href="#SUMPRODUCT( list, list ) -- scal"> SUMPRODUCT( list, list ) -- scalar product on ranges of cells</a></li>
 113         <li><a href="#T( address ) -- content of a cel"> T( address ) -- content of a cell</a></li>
 114         <li><a href="#TRANSLATE( text, from, to ) -- t"> TRANSLATE( text, from, to ) -- translate text from one set of characters to another</a></li>
 115         <li><a href="#TIME( text ) -- convert a date s"> TIME( text ) -- convert a date string into a serialized date number</a></li>
 116         <li><a href="#TIMEADD( serial, value, unit ) -"> TIMEADD( serial, value, unit ) -- add a value to a serialized date</a></li>
 117         <li><a href="#TIMEDIFF( serial_1, serial_2, un"> TIMEDIFF( serial_1, serial_2, unit ) -- time difference between two serialized dates</a></li>
 118         <li><a href="#TODAY( ) -- serialized date of t"> TODAY( ) -- serialized date of today at midnight GMT</a></li>
 119         <li><a href="#TRIM( text ) -- trim spaces from"> TRIM( text ) -- trim spaces from text</a></li>
 120         <li><a href="#UPPER( text ) -- upper case stri"> UPPER( text ) -- upper case string of a text</a></li>
 121         <li><a href="#VALUE( text ) -- convert text to"> VALUE( text ) -- convert text to number</a></li>
 122       </ul>
 123     </li>
 124     <li><a href="#Bug Tracking Example"> Bug Tracking Example</a></li>
 125     <li><a href="#Plugin Settings"> Plugin Settings</a></li>
 126     <li><a href="#Plugin Installation Instructions"> Plugin Installation Instructions</a></li>
 127     <li><a href="#Plugin Info"> Plugin Info</a></li>
 128   </ul>
 129 </div>
 130
 131 ## <a name="Syntax Rules"></a> Syntax Rules
 132
 133 The action of this Plugin is triggered by the <code>**%CALC\{"..."\}%**</code> variable, which gets rendered according to the built-in function(s) found between the quotes.
 134
 135 - Built-in function are of format <code>**$FUNCNAME(parameter)**</code>
 136 - Functions may be nested, e.g. <code>**%CALC\{"$SUM( R2:C$COLUMN(0)..R$ROW(-1):C$COLUMN(0) )"\}%**</code>
 137 - Functions are evaluated from left to right, and from inside to outside if nested
 138 - The function parameter can be text; a mathematical formula; a cell address; or a range of cell addresses
 139 - Multiple parameters form a list; they are separated by a comma, followed by optional space, e.g. <code>**%CALC\{"$SUM( 3, 5, 7 )"\}%**</code>
 140 - A table cell can be addressed as <code>**R1:C1**</code>. Table address matrix: <table border="1" cellpadding="0" cellspacing="0">
 141   <tr>
 142     <td><code><b>R1:C1</b></code></td>
 143     <td><code><b>R1:C2</b></code></td>
 144     <td><code><b>R1:C3</b></code></td>
 145     <td><code><b>R1:C4</b></code></td>
 146   </tr>
 147   <tr>
 148     <td><code><b>R2:C1</b></code></td>
 149     <td><code><b>R2:C2</b></code></td>
 150     <td><code><b>R2:C3</b></code></td>
 151     <td><code><b>R2:C4</b></code></td>
 152   </tr>
 153 </table>
 154 - A table cell range is defined by two cell addresses separated by <code>**".."**</code>, e.g. "row 1 through 20, column 3" is: <code>**R1:C3..R20:C3**</code>
 155 - Lists can refer to values and/or table cell ranges, e.g. <code>**%CALC\{"$SUM( 3, 5, $T(R1:C7), R1:C11..R1:C15 )"\}%**</code>
 156 - Formulae can only reference cells in the current or preceeding row of the current table; they may not reference cells below the current table row
 157 - Formulae can also be placed outside of tables; they can reference cells in the preceeding table
 158
 159 ## <a name="Built-in Functions"></a> Built-in Functions
 160
 161 Conventions for Syntax:
 162
 163 - Required parameters are indicated in <code>**( bold )**</code>
 164 - Optional parameters are indicated in <code>**( _bold italic_ )**</code>
 165
 166 <a name="FuncABOVE"></a>
 167
 168 ### <a name="ABOVE( ) -- address range of cel"></a> ABOVE( ) -- address range of cells above the current cell
 169
 170 - Syntax: <code>**$ABOVE( )**</code>
 171 - Example: <code>**%CALC\{"$SUM($ABOVE())"\}%**</code> returns the sum of cells above the current cell
 172 - Related: <code>[[$LEFT()|Main/WebHome#FuncLEFT]]</code>, <code>[[$RIGHT()|Main/WebHome#FuncRIGHT]]</code>
 173
 174 <a name="FuncABS"></a>
 175
 176 ### <a name="ABS( num ) -- absolute value of"></a><a name="ABS( num ) -- absolute value of "></a> ABS( num ) -- absolute value of a number
 177
 178 - Syntax: <code>**$ABS( num )**</code>
 179 - Example: <code>**%CALC\{"$ABS(-12.5)"\}%**</code> returns <code>**12\.5**</code>
 180 - Related: <code>[[$SIGN()|Main/WebHome#FuncSIGN]]</code>
 181
 182 <a name="FuncAND"></a>
 183
 184 ### <a name="AND( list ) -- logcial AND of a"></a><a name="AND( list ) -- logcial AND of a "></a> AND( list ) -- logcial AND of a list
 185
 186 - Syntax: <code>**$AND( list )**</code>
 187 - Example: <code>**%CALC\{"$AND(1, 0, 1)"\}%**</code> returns <code>****</code>
 188 - Related: <code>[[$NOT()|Main/WebHome#FuncNOT]]</code>, <code>[[$IF()|Main/WebHome#FuncIF]]</code>, <code>[[$OR()|Main/WebHome#FuncOR]]</code>
 189
 190 <a name="FuncAVERAGE"></a>
 191
 192 ### <a name="AVERAGE( list ) -- average of a"></a><a name="AVERAGE( list ) -- average of a "></a> AVERAGE( list ) -- average of a list or a range of cells
 193
 194 - Syntax: <code>**$AVERAGE( list )**</code>
 195 - Example: <code>**%CALC\{"$AVERAGE(R2:C5..R$ROW(-1):C5)"\}%**</code> returns the average of column 5, excluding the title row
 196 - Related: <code>[[$LIST()|Main/WebHome#FuncLIST]]</code>, <code>[[$MAX()|Main/WebHome#FuncMAX]]</code>, <code>[[$MEDIAN()|Main/WebHome#FuncMEDIAN]]</code>, <code>[[$MIN()|Main/WebHome#FuncMIN]]</code>
 197
 198 <a name="FuncCHAR"></a>
 199
 200 ### <a name="CHAR( number ) -- ASCII characte"></a> CHAR( number ) -- ASCII character represented by number
 201
 202 - Syntax: <code>**$CHAR( number )**</code>
 203 - Example: Example: <code>**%CALC\{"$CHAR(97)"\}%**</code> returns <code>**a**</code>
 204 - Related: <code>[[$CODE()|Main/WebHome#FuncCODE]]</code>
 205
 206 <a name="FuncCODE"></a>
 207
 208 ### <a name="CODE( text ) -- ASCII numeric va"></a> CODE( text ) -- ASCII numeric value of character
 209
 210 - The ASCII numeric value of the first character in text
 211 - Syntax: <code>**$CODE( text )**</code>
 212 - Example: <code>**%CALC\{"$CODE(abc)"\}%**</code> returns <code>**97**</code>
 213 - Related: <code>[[$CHAR()|Main/WebHome#FuncCHAR]]</code>
 214
 215 <a name="FuncCOLUMN"></a>
 216
 217 ### <a name="COLUMN( offset ) -- current colu"></a> COLUMN( offset ) -- current column number
 218
 219 - The current table column number with an optional offset
 220 - Syntax: <code>**$COLUMN( _offset_ )**</code>
 221 - Example: <code>**%CALC\{"$COLUMN()"\}%**</code> returns <code>**2**</code> for the second column
 222 - Related: <code>[[$ROW()|Main/WebHome#FuncROW]]</code>, <code>[[$T()|Main/WebHome#FuncT]]</code>
 223
 224 <a name="FuncCOUNTITEMS"></a>
 225
 226 ### <a name="COUNTITEMS( list ) -- count indi"></a> COUNTITEMS( list ) -- count individual items in a list
 227
 228 - Syntax: <code>**$COUNTITEMS( list )**</code>
 229 - Example: <code>**%CALC\{"$COUNTITEMS($ABOVE())"\}%**</code> returns <code>**Closed: 1, Open: 2**</code> assuming one cell above the current cell contains <code>**Closed**</code> and two cells contain <code>**Open**</code>
 230 - Related: <code>[[$COUNTSTR()|Main/WebHome#FuncCOUNTSTR]]</code>, <code>[[$LIST()|Main/WebHome#FuncLIST]]</code>
 231
 232 <a name="FuncCOUNTSTR"></a>
 233
 234 ### <a name="COUNTSTR( list, str ) -- count t"></a> COUNTSTR( list, str ) -- count the number of cells in a list equal to a given string
 235
 236 - Count the number of cells in a list equal to a given string (if str is specified), or counts the number of non empty cells in a list
 237 - Syntax: <code>**$COUNTSTR( list, _str_ )**</code>
 238 - Example: <code>**%CALC\{"$COUNTSTR($ABOVE())"\}%**</code> counts the number of non empty cells above the current cell
 239 - Example: <code>**%CALC\{"$COUNTSTR($ABOVE(), DONE)"\}%**</code> counts the number of cells equal to <code>**DONE**</code>
 240 - Related: <code>[[$COUNTITEMS()|Main/WebHome#FuncCOUNTITEMS]]</code>, <code>[[$LIST()|Main/WebHome#FuncLIST]]</code>
 241
 242 <a name="FuncDEF"></a>
 243
 244 ### <a name="DEF( list ) -- find first non-em"></a> DEF( list ) -- find first non-empty list item or cell
 245
 246 - Returns the first list item or cell reference that is not empty
 247 - Syntax: <code>**$DEF( list )**</code>
 248 - Example: <code>**%CALC\{"$DEF(R1:C1..R1:C3)"\}%**</code>
 249 - Related: <code>[[$COUNTSTR()|Main/WebHome#FuncCOUNTSTR]]</code>, <code>[[$LISTIF()|Main/WebHome#FuncLISTIF]]</code>, <code>[[$LIST()|Main/WebHome#FuncLIST]]</code>
 250
 251 <a name="FuncEVAL"></a>
 252
 253 ### <a name="EVAL( formula ) -- evaluate a si"></a> EVAL( formula ) -- evaluate a simple formula
 254
 255 - Addition, substraction, multiplication, division and modulus of numbers are supported. Any nesting is permitted
 256 - Syntax: <code>**$EVAL( formula )**</code>
 257 - Example: <code>**%CALC\{"$EVAL( (5 \* 3) / 2 + 1.1 )"\}%**</code> returns <code>**8\.6**</code>
 258 - Related: <code>[[$INT()|Main/WebHome#FuncINT]]</code>, <code>[[$MOD()|Main/WebHome#FuncMOD]]</code>, <code>[[$ROUND()|Main/WebHome#FuncROUND]]</code>, <code>[[$VALUE()|Main/WebHome#FuncVALUE]]</code>
 259
 260 <a name="FuncEXACT"></a>
 261
 262 ### <a name="EXACT( text1, text2 ) -- compare"></a> EXACT( text1, text2 ) -- compare two text strings
 263
 264 - Compares two text strings and returns <code>**1**</code> if they are exactly the same, or <code>****</code> if not
 265 - Syntax: <code>**$EXACT( text1, _text2_ )**</code>
 266 - Example: <code>**%CALC\{"$EXACT(foo, Foo)"\}%**</code> returns <code>****</code>
 267 - Example: <code>**%CALC\{"$EXACT(foo, $LOWER(Foo))"\}%**</code> returns <code>**1**</code>
 268 - Related: <code>[[$IF()|Main/WebHome#FuncIF]]</code>, <code>[[$TRIM()|Main/WebHome#FuncTRIM]]</code>
 269
 270 <a name="FuncFIND"></a>
 271
 272 ### <a name="FIND( string, text, start ) -- f"></a> FIND( string, text, start ) -- find one string within another string
 273
 274 - Finds one text `string`, within another `text`, and returns the number of the starting position of `string`, from the first character of `text`. This search is case sensitive and is not a regular expression search; use `$SEARCH()` for regular expression searching. Starting position is 1; a 0 is returned if nothing is matched.
 275 - Syntax: <code>**$FIND( string, text, _start_ )**</code>
 276 - Example: <code>**%CALC\{"$FIND(f, fluffy)"\}%**</code> returns <code>**1**</code>
 277 - Example: <code>**%CALC\{"$FIND(f, fluffy, 2)"\}%**</code> returns <code>**4**</code>
 278 - Example: <code>**%CALC\{"$FIND(@, fluffy, 1)"\}%**</code> returns <code>****</code>
 279 - Related: <code>[[$REPLACE()|Main/WebHome#FuncREPLACE]]</code>, <code>[[$SEARCH()|Main/WebHome#FuncSEARCH]]</code>
 280
 281 <a name="FuncFORMAT"></a>
 282
 283 ### <a name="FORMAT( type, prec, number ) --"></a><a name="FORMAT( type, prec, number ) -- "></a> FORMAT( type, prec, number ) -- format a number to a certain type and precision
 284
 285 - Type can be COMMA for comma format, DOLLAR for Dollar format, NUMBER for number, and PERCENT for percent format
 286 - Syntax: <code>**$FORMAT( type, prec, number )**</code>
 287 - Example: <code>**%CALC\{"$FORMAT(COMMA, 2, 12345.6789)"\}%**</code> returns <code>**12,345.68**</code>
 288 - Example: <code>**%CALC\{"$FORMAT(DOLLAR, 2, 12345.67)"\}%**</code> returns <code>**$12,345.68**</code>
 289 - Example: <code>**%CALC\{"$FORMAT(NUMBER, 1, 12345.67)"\}%**</code> returns <code>**12345\.7**</code>
 290 - Example: <code>**%CALC\{"$FORMAT(PERCENT, 1, 0.1234567)"\}%**</code> returns <code>**12\.3%**</code>
 291 - Related: <code>[[$ROUND()|Main/WebHome#FuncROUND]]</code>
 292
 293 <a name="FuncFORMATTIME"></a>
 294
 295 ### <a name="FORMATTIME( serial, text ) -- co"></a> FORMATTIME( serial, text ) -- convert a serialized date into a date string
 296
 297 - The following variables in `text` are expanded: `$second` (seconds, 00..59); `$minute` (minutes, 00..59); `$hour` (hours, 00..23); `$day` (day of month, 01..31); `$month` (month, 01..12); `$mon` (month in text format, Jan..Dec); `$year` (4 digit year, 1999); `$ye` (2 digit year, 99), `$wd` (day number of the week, 1 for Sunday, 2 for Monday, etc), `$wday` (day of the week, Sun..Sat), `$weekday` (day of the week, Sunday..Saturday), `$yearday` (day of the year, 1..365, or 1..366 in leap years). Date is assumed to be server time; add `GMT` to indicate Greenwich time zone.
 298 - Syntax: <code>**$FORMATTIME( serial, text )**</code>
 299 - Example: <code>**%CALC\{"$FORMATTIME(0, $year/$month/$day GMT)"\}%**</code> returns <code>**1970/01/01 GMT**</code>
 300 - Related: <code>[[$FORMATGMTIME()|Main/WebHome#FuncFORMATGMTIME]]</code>, <code>[[$TIME()|Main/WebHome#FuncTIME]]</code>, <code>[[$TIMEADD()|Main/WebHome#FuncTIMEADD]]</code>, <code>[[$TIMEDIFF()|Main/WebHome#FuncTIMEDIFF]]</code>, <code>[[$TODAY()|Main/WebHome#FuncTODAY]]</code>
 301
 302 <a name="FuncFORMATGMTIME"></a>
 303
 304 ### <a name="FORMATGMTIME( serial, text ) --"></a><a name="FORMATGMTIME( serial, text ) -- "></a> FORMATGMTIME( serial, text ) -- convert a serialized date into a GMT date string
 305
 306 - The date string represents the time in Greenwich time zone. Same variable expansion as in `$FORMATTIME()`.
 307 - Syntax: <code>**$FORMATGMTIME( serial, text )**</code>
 308 - Example: <code>**%CALC\{"$FORMATGMTIME(1041379200, $day $mon $year)"\}%**</code> returns <code>**01 Jan 2003**</code>
 309 - Related: <code>[[$FORMATTIME()|Main/WebHome#FuncFORMATTIME]]</code>, <code>[[$TIME()|Main/WebHome#FuncTIME]]</code>, <code>[[$TIMEADD()|Main/WebHome#FuncTIMEADD]]</code>, <code>[[$TIMEDIFF()|Main/WebHome#FuncTIMEDIFF]]</code>, <code>[[$TODAY()|Main/WebHome#FuncTODAY]]</code>
 310
 311 <a name="FuncGET"></a>
 312
 313 ### <a name="GET( name ) -- get the value of"></a><a name="GET( name ) -- get the value of "></a> GET( name ) -- get the value of a previously set variable
 314
 315 - Specify the variable name (alphanumeric characters and underscores). An empty string is returned if the variable does not exist. Use `$SET()` to set a variable first. Unlike table ranges, variables live for the time of the page view and persist across tables, i.e. you can use it to summarize results across several tables.
 316 - Syntax: <code>**$GET( name )**</code>
 317 - Example: <code>**%CALC\{"$GET(my\_total)"\}%**</code> returns the value of the `my_total` variable
 318 - Related: <code>[[$SET()|Main/WebHome#FuncSET]]</code>, <code>[[$SETM()|Main/WebHome#FuncSETM]]</code>
 319
 320 <a name="FuncIF"></a>
 321
 322 ### <a name="IF( condition, value if true, va"></a> IF( condition, value if true, value if 0 ) -- return a value based on a condition
 323
 324 - The condition can be a number (where <code>****</code> means condition not met), or two numbers with a comparison operator <code>**&lt;**</code> (less than), <code>**&lt;=**</code> (less than or equal), <code>**==**</code> (equal), <code>**!=**</code> (not equal), <code>**&gt;=**</code> (greater than or equal), <code>**&gt;**</code> (greater than).
 325 - Syntax: <code>**$IF( condition, value if true, value if 0 )**</code>
 326 - Example: <code>**%CALC\{"$IF($T(R1:C5) &gt; 1000, Over Budget, OK)"\}%**</code> returns <code>**Over Budget**</code> if value in R1:C5 is over 1000, <code>**OK**</code> if not
 327 - Example: <code>**%CALC\{"$IF($EXACT($T(R1:C2),), empty, $T(R1:C2))"\}%**</code> returns the content of R1:C2 or <code>**empty**</code> if empty
 328 - Example: <code>**%CALC\{"$SET(val, $IF($T(R1:C2) == 0, zero, $T(R1:C2)))"\}%**</code> sets a variable conditionally
 329 - Related: <code>[[$AND()|Main/WebHome#FuncAND]]</code>, <code>[[$EXACT()|Main/WebHome#FuncEXACT]]</code>, <code>[[$LISTIF()|Main/WebHome#FuncLISTIF]]</code>, <code>[[$NOT()|Main/WebHome#FuncNOT]]</code>, <code>[[$OR()|Main/WebHome#FuncOR]]</code>
 330
 331 <a name="FuncINT"></a>
 332
 333 ### <a name="INT( formula ) -- evaluate formu"></a> INT( formula ) -- evaluate formula and round down to nearest integer
 334
 335 - Addition, substraction, multiplication, division and modulus of numbers are supported. Any nesting is permitted
 336 - Syntax: <code>**$INT( formula )**</code>
 337 - Example: <code>**%CALC\{"$INT(10 / 4)"\}%**</code> returns <code>**2**</code>
 338 - Related: <code>[[$EVAL()|Main/WebHome#FuncEVAL]]</code>, <code>[[$ROUND()|Main/WebHome#FuncROUND]]</code>, <code>[[$VALUE()|Main/WebHome#FuncVALUE]]</code>
 339
 340 <a name="FuncLEFT"></a>
 341
 342 ### <a name="LEFT( ) -- address range of cell"></a> LEFT( ) -- address range of cells to the left of the current cell
 343
 344 - Syntax: <code>**$LEFT( )**</code>
 345 - Example: <code>**%CALC\{"$SUM($LEFT())"\}%**</code> returns the sum of cells to the left of the current cell
 346 - Related: <code>[[$ABOVE()|Main/WebHome#FuncABOVE]]</code>, <code>[[$RIGHT()|Main/WebHome#FuncRIGHT]]</code>
 347
 348 <a name="FuncLENGTH"></a>
 349
 350 ### <a name="LENGTH( text ) -- length of text"></a> LENGTH( text ) -- length of text in bytes
 351
 352 - Syntax: <code>**$LENGTH( text )**</code>
 353 - Example: <code>**%CALC\{"$LENGTH(abcd)"\}%**</code> returns <code>**4**</code>
 354 - Related: <code>[[$LISTSIZE()|Main/WebHome#FuncLISTSIZE]]</code>
 355
 356 <a name="FuncLIST"></a>
 357
 358 ### <a name="LIST( range ) -- convert content"></a> LIST( range ) -- convert content of a cell range into a list
 359
 360 - Convert the content of a range of cells into a flat list, delimited by comma. Cells containing commas are merged into the list
 361 - Syntax: <code>**$LIST( range )**</code>
 362 - Example: <code>**%CALC\{"$LIST($LEFT())"\}%**</code> returns <code>**Apples, Lemons, Oranges, Kiwis**</code> assuming the cells to the left contain <code>**| Apples | Lemons, Oranges | Kiwis |**</code>
 363 - Related: <code>[[$AVERAGE()|Main/WebHome#FuncAVERAGE]]</code>, <code>[[$COUNTITEMS()|Main/WebHome#FuncCOUNTITEMS]]</code>, <code>[[$COUNTSTR()|Main/WebHome#FuncCOUNTSTR]]</code>, <code>[[$DEF()|Main/WebHome#FuncDEF]]</code>, <code>[[$LISTIF()|Main/WebHome#FuncLISTIF]]</code>, <code>[[$LISTITEM()|Main/WebHome#FuncLISTITEM]]</code>, <code>[[$LISTMAP()|Main/WebHome#FuncLISTMAP]]</code>, <code>[[$LISTREVERSE()|Main/WebHome#FuncLISTREVERSE]]</code>, <code>[[$LISTSIZE()|Main/WebHome#FuncLISTSIZE]]</code>, <code>[[$LISTSORT()|Main/WebHome#FuncLISTSORT]]</code>, <code>[[$LISTUNIQUE()|Main/WebHome#FuncLISTUNIQUE]]</code>, <code>[[$MAX()|Main/WebHome#FuncMAX]]</code>, <code>[[$MEDIAN()|Main/WebHome#FuncMEDIAN]]</code>, <code>[[$MIN()|Main/WebHome#FuncMIN]]</code>, <code>[[$PRODUCT()|Main/WebHome#FuncPRODUCT]]</code>, <code>[[$SUM()|Main/WebHome#FuncSUM]]</code>, <code>[[$SUMDAYS()|Main/WebHome#FuncSUMDAYS]]</code>, <code>[[$SUMPRODUCT()|Main/WebHome#FuncSUMPRODUCT]]</code>
 364
 365 <a name="FuncLISTIF"></a>
 366
 367 ### <a name="LISTIF( condition, list ) -- rem"></a> LISTIF( condition, list ) -- remove elements from a list that do not meet a condition
 368
 369 - In addition to the condition described in <code>[[$IF()|Main/WebHome#FuncIF]]</code>, you can use <code>**$item**</code> to indicate the current element, and <code>**$index**</code> for the list index, starting at 1
 370 - Syntax: <code>**$LISTIF( condition, list )**</code>
 371 - Example: <code>**%CALC\{"$LISTIF($item &gt; 12, 14, 7, 25)"\}%**</code> returns <code>**14, 25**</code>
 372 - Example: <code>**%CALC\{"$LISTIF($NOT($EXACT($item,)), A, B, , E)"\}%**</code> returns non-empty elements <code>**A, B, E**</code>
 373 - Example: <code>**%CALC\{"$LISTIF($index &gt; 2, A, B, C, D)"\}%**</code> returns <code>**C, D**</code>
 374 - Related: <code>[[$IF()|Main/WebHome#FuncIF]]</code>, <code>[[$LIST()|Main/WebHome#FuncLIST]]</code>, <code>[[$LISTITEM()|Main/WebHome#FuncLISTITEM]]</code>, <code>[[$LISTMAP()|Main/WebHome#FuncLISTMAP]]</code>, <code>[[$LISTREVERSE()|Main/WebHome#FuncLISTREVERSE]]</code>, <code>[[$LISTSIZE()|Main/WebHome#FuncLISTSIZE]]</code>, <code>[[$LISTSORT()|Main/WebHome#FuncLISTSORT]]</code>, <code>[[$LISTUNIQUE()|Main/WebHome#FuncLISTUNIQUE]]</code>, <code>[[$SUM()|Main/WebHome#FuncSUM]]</code>
 375
 376 <a name="FuncLISTITEM"></a>
 377
 378 ### <a name="LISTITEM( index, list ) -- get o"></a> LISTITEM( index, list ) -- get one element of a list
 379
 380 - Index is 1 to size of list; use a negative number to count from the end of the list
 381 - Syntax: <code>**$LISTITEM( index, list )**</code>
 382 - Example: <code>**%CALC\{"$LISTITEM(2, Apple, Orange, Apple, Kiwi)"\}%**</code> returns <code>**Orange**</code>
 383 - Example: <code>**%CALC\{"$LISTITEM(-1, Apple, Orange, Apple, Kiwi)"\}%**</code> returns <code>**Kiwi**</code>
 384 - Related: <code>[[$COUNTITEMS()|Main/WebHome#FuncCOUNTITEMS]]</code>, <code>[[$COUNTSTR()|Main/WebHome#FuncCOUNTSTR]]</code>, <code>[[$LIST()|Main/WebHome#FuncLIST]]</code>, <code>[[$LISTIF()|Main/WebHome#FuncLISTIF]]</code>, <code>[[$LISTMAP()|Main/WebHome#FuncLISTMAP]]</code>, <code>[[$LISTREVERSE()|Main/WebHome#FuncLISTREVERSE]]</code>, <code>[[$LISTSIZE()|Main/WebHome#FuncLISTSIZE]]</code>, <code>[[$LISTSORT()|Main/WebHome#FuncLISTSORT]]</code>, <code>[[$LISTUNIQUE()|Main/WebHome#FuncLISTUNIQUE]]</code>, <code>[[$SUM()|Main/WebHome#FuncSUM]]</code>
 385
 386 <a name="FuncLISTMAP"></a>
 387
 388 ### <a name="LISTMAP( formula, list ) -- eval"></a> LISTMAP( formula, list ) -- evaluate and update each element of a list
 389
 390 - In the formula you can use <code>**$item**</code> to indicate the element; <code>**$index**</code> to show the index of the list, starting at 1
 391 - Syntax: <code>**$LISTMAP( formula, list )**</code>
 392 - Example: <code>**%CALC\{"$LISTMAP($index: $EVAL(2 \* $item), 3, 5, 7, 11)"\}%**</code> returns <code>**1: 6, 2: 10, 3: 14, 4: 22**</code>
 393 - Related: <code>[[$COUNTITEMS()|Main/WebHome#FuncCOUNTITEMS]]</code>, <code>[[$COUNTSTR()|Main/WebHome#FuncCOUNTSTR]]</code>, <code>[[$LIST()|Main/WebHome#FuncLIST]]</code>, <code>[[$LISTIF()|Main/WebHome#FuncLISTIF]]</code>, <code>[[$LISTITEM()|Main/WebHome#FuncLISTITEM]]</code>, <code>[[$LISTREVERSE()|Main/WebHome#FuncLISTREVERSE]]</code>, <code>[[$LISTSIZE()|Main/WebHome#FuncLISTSIZE]]</code>, <code>[[$LISTSORT()|Main/WebHome#FuncLISTSORT]]</code>, <code>[[$LISTUNIQUE()|Main/WebHome#FuncLISTUNIQUE]]</code>, <code>[[$SUM()|Main/WebHome#FuncSUM]]</code>
 394
 395 <a name="FuncLISTREVERSE"></a>
 396
 397 ### <a name="LISTREVERSE( list ) -- opposite"></a><a name="LISTREVERSE( list ) -- opposite "></a> LISTREVERSE( list ) -- opposite order of a list
 398
 399 - Syntax: <code>**$LISTREVERSE( list )**</code>
 400 - Example: <code>**%CALC\{"$LISTREVERSE(Apple, Orange, Apple, Kiwi)"\}%**</code> returns <code>**Kiwi, Apple, Orange, Apple**</code>
 401 - Related: <code>[[$COUNTITEMS()|Main/WebHome#FuncCOUNTITEMS]]</code>, <code>[[$COUNTSTR()|Main/WebHome#FuncCOUNTSTR]]</code>, <code>[[$LIST()|Main/WebHome#FuncLIST]]</code>, <code>[[$LISTIF()|Main/WebHome#FuncLISTIF]]</code>, <code>[[$LISTITEM()|Main/WebHome#FuncLISTITEM]]</code>, <code>[[$LISTMAP()|Main/WebHome#FuncLISTMAP]]</code>, <code>[[$LISTSIZE()|Main/WebHome#FuncLISTSIZE]]</code>, <code>[[$LISTSORT()|Main/WebHome#FuncLISTSORT]]</code>, <code>[[$LISTUNIQUE()|Main/WebHome#FuncLISTUNIQUE]]</code>, <code>[[$SUM()|Main/WebHome#FuncSUM]]</code>
 402
 403 <a name="FuncLISTSIZE"></a>
 404
 405 ### <a name="LISTSIZE( list ) -- number of el"></a> LISTSIZE( list ) -- number of elements in a list
 406
 407 - Syntax: <code>**$LISTSIZE( list )**</code>
 408 - Example: <code>**%CALC\{"$LISTSIZE(Apple, Orange, Apple, Kiwi)"\}%**</code> returns <code>**4**</code>
 409 - Related: <code>[[$COUNTITEMS()|Main/WebHome#FuncCOUNTITEMS]]</code>, <code>[[$COUNTSTR()|Main/WebHome#FuncCOUNTSTR]]</code>, <code>[[$LIST()|Main/WebHome#FuncLIST]]</code>, <code>[[$LISTIF()|Main/WebHome#FuncLISTIF]]</code>, <code>[[$LISTITEM()|Main/WebHome#FuncLISTITEM]]</code>, <code>[[$LISTMAP()|Main/WebHome#FuncLISTMAP]]</code>, <code>[[$LISTREVERSE()|Main/WebHome#FuncLISTREVERSE]]</code>, <code>[[$LISTSORT()|Main/WebHome#FuncLISTSORT]]</code>, <code>[[$LISTUNIQUE()|Main/WebHome#FuncLISTUNIQUE]]</code>, <code>[[$SUM()|Main/WebHome#FuncSUM]]</code>
 410
 411 <a name="FuncLISTSORT"></a>
 412
 413 ### <a name="LISTSORT( list ) -- sort a list"></a> LISTSORT( list ) -- sort a list
 414
 415 - Sorts a list in ASCII order, or numerically if all elements are numeric
 416 - Syntax: <code>**$LISTSORT( list )**</code>
 417 - Example: <code>**%CALC\{"$LISTSORT(Apple, Orange, Apple, Kiwi)"\}%**</code> returns <code>**Apple, Apple, Kiwi, Orange**</code>
 418 - Related: <code>[[$COUNTITEMS()|Main/WebHome#FuncCOUNTITEMS]]</code>, <code>[[$COUNTSTR()|Main/WebHome#FuncCOUNTSTR]]</code>, <code>[[$LIST()|Main/WebHome#FuncLIST]]</code>, <code>[[$LISTIF()|Main/WebHome#FuncLISTIF]]</code>, <code>[[$LISTITEM()|Main/WebHome#FuncLISTITEM]]</code>, <code>[[$LISTMAP()|Main/WebHome#FuncLISTMAP]]</code>, <code>[[$LISTREVERSE()|Main/WebHome#FuncLISTREVERSE]]</code>, <code>[[$LISTSIZE()|Main/WebHome#FuncLISTSIZE]]</code>, <code>[[$LISTUNIQUE()|Main/WebHome#FuncLISTUNIQUE]]</code>, <code>[[$SUM()|Main/WebHome#FuncSUM]]</code>
 419
 420 <a name="FuncLISTUNIQUE"></a>
 421
 422 ### <a name="LISTUNIQUE( list ) -- remove all"></a> LISTUNIQUE( list ) -- remove all duplicates from a list
 423
 424 - Syntax: <code>**$LISTUNIQUE( list )**</code>
 425 - Example: <code>**%CALC\{"$LISTUNIQUE(Apple, Orange, Apple, Kiwi)"\}%**</code> returns <code>**Apple, Orange, Kiwi**</code>
 426 - Related: <code>[[$COUNTITEMS()|Main/WebHome#FuncCOUNTITEMS]]</code>, <code>[[$COUNTSTR()|Main/WebHome#FuncCOUNTSTR]]</code>, <code>[[$LIST()|Main/WebHome#FuncLIST]]</code>, <code>[[$LISTIF()|Main/WebHome#FuncLISTIF]]</code>, <code>[[$LISTITEM()|Main/WebHome#FuncLISTITEM]]</code>, <code>[[$LISTMAP()|Main/WebHome#FuncLISTMAP]]</code>, <code>[[$LISTREVERSE()|Main/WebHome#FuncLISTREVERSE]]</code>, <code>[[$LISTSIZE()|Main/WebHome#FuncLISTSIZE]]</code>, <code>[[$LISTSORT()|Main/WebHome#FuncLISTSORT]]</code>, <code>[[$SUM()|Main/WebHome#FuncSUM]]</code>
 427
 428 <a name="FuncLOWER"></a>
 429
 430 ### <a name="LOWER( text ) -- lower case stri"></a> LOWER( text ) -- lower case string of a text
 431
 432 - Syntax: <code>**$LOWER(text)**</code>
 433 - Example: <code>**%CALC\{"$LOWER( $T(R1:C5) )"\}%**</code> returns the lower case string of the text in cell <code>**R1:C5**</code>
 434 - Related: <code>[[$PROPER()|Main/WebHome#FuncPROPER]]</code>, <code>[[$PROPERSPACE()|Main/WebHome#FuncPROPERSPACE]]</code>, <code>[[$TRIM()|Main/WebHome#FuncTRIM]]</code>, <code>[[$UPPER()|Main/WebHome#FuncUPPER]]</code>
 435
 436 <a name="FuncMAX"></a>
 437
 438 ### <a name="MAX( list ) - biggest value of a"></a> MAX( list ) - biggest value of a list or range of cells
 439
 440 - Syntax: <code>**$MAX( list )**</code>
 441 - Example: To find the biggest number to the left of the current cell, write: <code>**%CALC\{"$MAX($LEFT())"\}%**</code>
 442 - Related: <code>[[$LIST()|Main/WebHome#FuncLIST]]</code>, <code>[[$MEDIAN()|Main/WebHome#FuncMEDIAN]]</code>, <code>[[$MIN()|Main/WebHome#FuncMIN]]</code>
 443
 444 <a name="FuncMEDIAN"></a>
 445
 446 ### <a name="MEDIAN( list ) -- median of a li"></a> MEDIAN( list ) -- median of a list or range of cells
 447
 448 - Syntax: <code>**$MEDIAN( list )**</code>
 449 - Example: <code>**%CALC\{"$MEDIAN(3, 9, 4, 5)"\}%**</code> returns <code>**4\.5**</code>
 450 - Related: <code>[[$LIST()|Main/WebHome#FuncLIST]]</code>, <code>[[$MAX()|Main/WebHome#FuncMAX]]</code>, <code>[[$MIN()|Main/WebHome#FuncMIN]]</code>
 451
 452 <a name="FuncMIN"></a>
 453
 454 ### <a name="MIN( list ) -- smallest value of"></a> MIN( list ) -- smallest value of a list or range of cells
 455
 456 - Syntax: <code>**$MIN( list )**</code>
 457 - Example: <code>**%CALC\{"$MIN(15, 3, 28)"\}%**</code> returns <code>**3**</code>
 458 - Related: <code>[[$LIST()|Main/WebHome#FuncLIST]]</code>, <code>[[$MAX()|Main/WebHome#FuncMAX]]</code>, <code>[[$MEDIAN()|Main/WebHome#FuncMEDIAN]]</code>
 459
 460 <a name="FuncMOD"></a>
 461
 462 ### <a name="MOD( num, divisor ) -- reminder"></a><a name="MOD( num, divisor ) -- reminder "></a> MOD( num, divisor ) -- reminder after dividing <code>**num**</code> by <code>**divisor**</code>
 463
 464 - Syntax: <code>**$MOD( num, divisor )**</code>
 465 - Example: <code>**%CALC\{"$MOD(7, 3)"\}%**</code> returns <code>**1**</code>
 466 - Related: <code>[[$EVAL()|Main/WebHome#FuncEVAL]]</code>, <code>[[$()|Main/WebHome#Func]]</code>
 467
 468 <a name="FuncNOP"></a>
 469
 470 ### <a name="NOP( text ) -- no-operation"></a> NOP( text ) -- no-operation
 471
 472 - Useful to change the order of Plugin execution. For example, it allows preprossing to be done before `%SEARCH{}%` is evaluated. The percent character '%' can be escaped with `$per`
 473 - Syntax: <code>**$NOP( text )**</code>
 474
 475 <a name="FuncNOT"></a>
 476
 477 ### <a name="NOT( num ) -- reverse logic of a"></a> NOT( num ) -- reverse logic of a number
 478
 479 - Returns 0 if <code>**num**</code> is not zero, 1 if zero
 480 - Syntax: <code>**$NOT( num )**</code>
 481 - Example: <code>**%CALC\{"$NOT(0)"\}%**</code> returns <code>**1**</code>
 482 - Related: <code>[[$AND()|Main/WebHome#FuncAND]]</code>, <code>[[$IF()|Main/WebHome#FuncIF]]</code>, <code>[[$OR()|Main/WebHome#FuncOR]]</code>
 483
 484 <a name="FuncOR"></a>
 485
 486 ### <a name="OR( list ) -- logcial OR of a li"></a> OR( list ) -- logcial OR of a list
 487
 488 - Syntax: <code>**$OR( list )**</code>
 489 - Example: <code>**%CALC\{"$OR(1, 0, 1)"\}%**</code> returns <code>**1**</code>
 490 - Related: <code>[[$AND()|Main/WebHome#FuncAND]]</code>, <code>[[$IF()|Main/WebHome#FuncIF]]</code>, <code>[[$NOT()|Main/WebHome#FuncNOT]]</code>
 491
 492 <a name="FuncPRODUCT"></a>
 493
 494 ### <a name="PRODUCT( list ) -- product of a"></a><a name="PRODUCT( list ) -- product of a "></a> PRODUCT( list ) -- product of a list or range of cells
 495
 496 - Syntax: <code>**$PRODUCT( list )**</code>
 497 - Example: To calculate the product of the cells to the left of the current one use <code>**%CALC\{"$PRODUCT($LEFT())"\}%**</code>
 498 - Related: <code>[[$LIST()|Main/WebHome#FuncLIST]]</code>, <code>[[$PRODUCT()|Main/WebHome#FuncPRODUCT]]</code>, <code>[[$SUM()|Main/WebHome#FuncSUM]]</code>, <code>[[$SUMPRODUCT()|Main/WebHome#FuncSUMPRODUCT]]</code>
 499
 500 <a name="FuncPROPER"></a>
 501
 502 ### <a name="PROPER( text ) -- properly capit"></a> PROPER( text ) -- properly capitalize trxt
 503
 504 - Capitalize letters that follow any character other than a letter; convert all other letters to lowercase letters
 505 - Syntax: <code>**$PROPER( text )**</code>
 506 - Example: <code>**%CALC\{"PROPER(a small STEP)"\}%**</code> returns <code>**A Small Step**</code>
 507 - Example: <code>**%CALC\{"PROPER(f1 (formula-1))"\}%**</code> returns <code>**F1 (Formula-1)**</code>
 508 - Related: <code>[[$LOWER()|Main/WebHome#FuncLOWER]]</code>, <code>[[$PROPERSPACE()|Main/WebHome#FuncPROPERSPACE]]</code>, <code>[[$TRIM()|Main/WebHome#FuncTRIM]]</code>, <code>[[$UPPER()|Main/WebHome#FuncUPPER]]</code>
 509
 510 <a name="FuncPROPERSPACE"></a>
 511
 512 ### <a name="PROPERSPACE( text ) -- properly"></a><a name="PROPERSPACE( text ) -- properly "></a> PROPERSPACE( text ) -- properly space out WikiWords
 513
 514 - Properly spaces out [[WikiWords]] preceeded by white space, parenthesis, or <code>**]\[**</code>. Words listed in the DONTSPACE [[TWikiPreferences]] variable or DONTSPACE Plugins setting are excluded
 515 - Syntax: <code>**$PROPERSPACE( text )**</code>
 516 - Example: Assuming DONTSPACE contains MacDonald: <code>**%CALC\{"PROPERSPACE(Old MacDonald had a ServerFarm, EeEyeEeEyeOh"\}%**</code> returns <code>**Old MacDonald had a Server Farm, Ee Eye Ee Eye Oh**</code>
 517 - Related: <code>[[$LOWER()|Main/WebHome#FuncLOWER]]</code>, <code>[[$PROPER()|Main/WebHome#FuncPROPER]]</code>, <code>[[$TRIM()|Main/WebHome#FuncTRIM]]</code>, <code>[[$UPPER()|Main/WebHome#FuncUPPER]]</code>
 518
 519 <a name="FuncRAND"></a>
 520
 521 ### <a name="RAND( max ) -- random number"></a> RAND( max ) -- random number
 522
 523 - Random number, evenly distributed between 0 and <code>**max**</code>, or 0 and 1 if max is not specified
 524 - Syntax: <code>**$RAND( max )**</code>
 525 - Related: <code>[[$EVAL()|Main/WebHome#FuncEVAL]]</code>
 526
 527 <a name="FuncREPEAT"></a>
 528
 529 ### <a name="REPEAT(text) -- repeat text a nu"></a> REPEAT(text) -- repeat text a number of times
 530
 531 - Syntax: <code>**$REPEAT( text )**</code>
 532 - Example: <code>**%CALC\{"$REPEAT(/\\, 5)"\}%**</code> returns <code>**/\\/\\/\\/\\/\\**</code>
 533
 534 <a name="FuncREPLACE"></a>
 535
 536 ### <a name="REPLACE( text, start, num, new )"></a> REPLACE( text, start, num, new ) -- replace part of a text string
 537
 538 - Replace `num` number of characters of text string `text`, starting at `start`, with new text `new`. Starting position is 1; use a negative `start` to count from the end of the text
 539 - Syntax: <code>**$REPLACE( text, start, num, new )**</code>
 540 - Example: <code>**%CALC\{"$REPLACE(abcdefghijk,6,5,\*)"\}%**</code> returns <code>**abcde\*k**</code>
 541 - Related: <code>[[$FIND()|Main/WebHome#FuncFIND]]</code>, <code>[[$SEARCH()|Main/WebHome#FuncSEARCH]]</code>, <code>[[$SUBSTITUTE()|Main/WebHome#FuncSUBSTITUTE]]</code>, <code>[[$TRANSLATE()|Main/WebHome#FuncTRANSLATE]]</code>
 542
 543 <a name="FuncRIGHT"></a>
 544
 545 ### <a name="RIGHT( ) -- address range of cel"></a> RIGHT( ) -- address range of cells to the right of the current cell
 546
 547 - Syntax: <code>**$RIGHT( )**</code>
 548 - Example: <code>**%CALC\{"$SUM($RIGHT())"\}%**</code> returns the sum of cells to the right of the current cell
 549 - Related: <code>[[$ABOVE()|Main/WebHome#FuncABOVE]]</code>, <code>[[$LEFT()|Main/WebHome#FuncLEFT]]</code>
 550
 551 <a name="FuncROUND"></a>
 552
 553 ### <a name="ROUND( formula, digits ) -- roun"></a> ROUND( formula, digits ) -- round a number
 554
 555 - Evaluates a simple <code>**formula**</code> and rounds the result up or down to the number of digits if <code>**digits**</code> is positive; to the nearest integer if digits is missing; or to the left of the decimal point if digits is negative
 556 - Syntax: <code>**$ROUND( formula, digits )**</code>
 557 - Example: <code>**%CALC\{"$ROUND(3.15, 1)"\}%**</code> returns <code>**3\.2**</code>
 558 - Example: <code>**%CALC\{"$ROUND(3.149, 1)"\}%**</code> returns <code>**3\.1**</code>
 559 - Example: <code>**%CALC\{"$ROUND(-2.475, 2)"\}%**</code> returns <code>**-2.48**</code>
 560 - Example: <code>**%CALC\{"$ROUND(34.9, -1)"\}%**</code> returns <code>**30**</code>
 561 - Related: <code>[[$INT()|Main/WebHome#FuncINT]]</code>, <code>[[$FORMAT()|Main/WebHome#FuncFORMAT]]</code>
 562
 563 <a name="FuncROW"></a>
 564
 565 ### <a name="ROW( offset ) -- current row num"></a> ROW( offset ) -- current row number
 566
 567 - The current table row number with an optional offset
 568 - Syntax: <code>**$ROW( _offset_ )**</code>
 569 - Example: To get the number of rows excluding table heading (first row) and summary row (last row you are in), write: <code>**%CALC\{"$ROW(-2)"\}%**</code>
 570 - Related: <code>[[$COLUMN()|Main/WebHome#FuncCOLUMN]]</code>, <code>[[$T()|Main/WebHome#FuncT]]</code>
 571
 572 <a name="FuncSEARCH"></a>
 573
 574 ### <a name="SEARCH( string, text, start ) --"></a> SEARCH( string, text, start ) -- search a string within a text
 575
 576 - Finds one text `string`, within another `text`, and returns the number of the starting position of `string`, from the first character of `text`. This search is a [[RegularExpression]] search; use `$FIND()` for non-regular expression searching. Starting position is 1; a 0 is returned if nothing is matched
 577 - Syntax: <code>**$SEARCH( string, text, _start_ )**</code>
 578 - Example: <code>**%CALC\{"$SEARCH([uy], fluffy)"\}%**</code> returns <code>**3**</code>
 579 - Example: <code>**%CALC\{"$SEARCH([uy], fluffy, 3)"\}%**</code> returns <code>**6**</code>
 580 - Example: <code>**%CALC\{"$SEARCH([abc], fluffy,)"\}%**</code> returns <code>****</code>
 581 - Related: <code>[[$FIND()|Main/WebHome#FuncFIND]]</code>, <code>[[$REPLACE()|Main/WebHome#FuncREPLACE]]</code>
 582
 583 <a name="FuncSET"></a>
 584
 585 ### <a name="SET( name, value ) -- set a vari"></a> SET( name, value ) -- set a variable for later use
 586
 587 - Specify the variable name (alphanumeric characters and underscores) and the value. The value may contain a formula; formulas are evaluated before the variable assignment. This function returns no output. Use `$GET()` to retrieve variables. Unlike table ranges, variables live for the time of the page view and persist across tables, i.e. you can use it to summarize results across several tables
 588 - Syntax: <code>**$SET( name, value )**</code>
 589 - Example: <code>**%CALC\{"$SET(my\_total, $SUM($ABOVE()))"\}%**</code> sets the `my_total` variable to the sum of all table cells located above the current cell and returns an empty string
 590 - Related: <code>[[$GET()|Main/WebHome#FuncGET]]</code>, <code>[[SETM()|Main/WebHome#FuncSETM]]</code>
 591
 592 <a name="FuncSETM"></a>
 593
 594 ### <a name="SETM( name, formula ) -- update"></a><a name="SETM( name, formula ) -- update "></a> SETM( name, formula ) -- update an existing variable based on a formula
 595
 596 - Specify the variable name (alphanumeric characters and underscores) and the formula. The formula must start with an operator to <code>**+**</code> (add), <code>**-**</code> (subtract), <code>**\***</code> (multiply), or <code>**/**</code> (divide) something to the variable. This function returns no output. Use `$GET()` to retrieve variables
 597 - Syntax: <code>**$SETM( name, formula )**</code>
 598 - Example: <code>**%CALC\{"$SETM(total, + $SUM($LEFT()))"\}%**</code> adds the sum of all table cells on the left to the `total` variable, and returns an empty string
 599 - Related: <code>[[$GET()|Main/WebHome#FuncGET]]</code>, <code>[[$SET()|Main/WebHome#FuncSET]]</code>
 600
 601 <a name="FuncSIGN"></a>
 602
 603 ### <a name="SIGN( num ) -- sign of a number"></a> SIGN( num ) -- sign of a number
 604
 605 - Returns -1 if <code>**num**</code> is negative, 0 if zero, or 1 if positive
 606 - Syntax: <code>**$SIGN( num )**</code>
 607 - Example: <code>**%CALC\{"$SIGN(-12.5)"\}%**</code> returns <code>**-1**</code>
 608 - Related: <code>[[$ABS()|Main/WebHome#FuncABS]]</code>, <code>[[$EVAL()|Main/WebHome#FuncEVAL]]</code>, <code>[[$INT()|Main/WebHome#FuncINT]]</code>, <code>[[$NOT()|Main/WebHome#FuncNOT]]</code>
 609
 610 <a name="FuncSUBSTITUTE"></a>
 611
 612 ### <a name="SUBSTITUTE( text, old, new, inst"></a> SUBSTITUTE( text, old, new, instance, option ) -- substitute text
 613
 614 - Substitutes `new` text for `old` text in a `text` string. `instance` specifies which occurance of `old` you want to replace. If you specify `instance`, only that instance is replaced. Otherwise, every occurance is changed to the new text. A literal search is performed by default; a [[RegularExpression]] search if the `option` is set to <code>**r**</code>
 615 - Syntax: <code>**$SUBSTITUTE( text, old, _new_, _instance_, _option_ )**</code>
 616 - Example: <code>**%CALC\{"$SUBSTITUTE(Good morning, morning, day)"\}%**</code> returns <code>**Good day**</code>
 617 - Example: <code>**%CALC\{"$SUBSTITUTE(Q2-2002,2,3)"\}%**</code> returns <code>**Q3-3003**</code>
 618 - Example: <code>**%CALC\{"$SUBSTITUTE(Q2-2002,2,3,3)"\}%**</code> returns <code>**Q2-2003**</code>
 619 - Example: <code>**%CALC\{"$SUBSTITUTE(abc123def,[0-9],9,,r)"\}%**</code> returns <code>**abc999def**</code>
 620 - Related: <code>[[$REPLACE()|Main/WebHome#FuncREPLACE]]</code>, <code>[[$TRANSLATE()|Main/WebHome#FuncTRANSLATE]]</code>
 621
 622 <a name="FuncSUM"></a>
 623
 624 ### <a name="SUM( list ) -- sum of a list or"></a><a name="SUM( list ) -- sum of a list or "></a> SUM( list ) -- sum of a list or range of cells
 625
 626 - Syntax: <code>**$SUM( list )**</code>
 627 - Example: To sum up column 5 excluding the title row, write <code>**%CALC\{"$SUM(R2:C5..R$ROW(-1):C5)"\}%**</code> in the last row; or simply <code>**%CALC\{"$SUM($ABOVE())"\}%**</code>
 628 - Related: <code>[[$LIST()|Main/WebHome#FuncLIST]]</code>, <code>[[$PRODUCT()|Main/WebHome#FuncPRODUCT]]</code>, <code>[[$SUMPRODUCT()|Main/WebHome#FuncSUMPRODUCT]]</code>
 629
 630 <a name="FuncSUMDAYS"></a>
 631
 632 ### <a name="SUMDAYS( list ) -- sum the days"></a><a name="SUMDAYS( list ) -- sum the days "></a> SUMDAYS( list ) -- sum the days in a list or range of cells
 633
 634 - The total number of days in a list or range of cells containing numbers of hours, days or weeks. The default unit is days; units are indicated by a <code>**h**</code>, <code>**hours**</code>, <code>**d**</code>, <code>**days**</code>, <code>**w**</code>, <code>**weeks**</code> suffix. One week is assumed to have 5 working days, one day 8 hours
 635 - Syntax: <code>**$SUMDAYS( list )**</code>
 636 - Example: <code>**%CALC\{"$SUMDAYS(2w, 1, 2d, 4h)"\}%**</code> returns <code>**13\.5**</code>, the evaluation of `(2*5 + 1 + 2 + 4/8)`
 637 - Related: <code>[[$SUM()|Main/WebHome#FuncSUM]]</code>, <code>[[$TIME()|Main/WebHome#FuncTIME]]</code>, <code>[[$FORMATTIME()|Main/WebHome#FuncFORMATTIME]]</code>
 638
 639 <a name="FuncSUMPRODUCT"></a>
 640
 641 ### <a name="SUMPRODUCT( list, list ) -- scal"></a> SUMPRODUCT( list, list ) -- scalar product on ranges of cells
 642
 643 - Syntax: <code>**$SUMPRODUCT( list, list, _list..._ )**</code>
 644 - Example: <code>**%CALC\{"$SUM(R2:C1..R4:C1, R2:C5..R4:C5)"\}%**</code> evaluates and returns the result of <code>**($T(R2:C1) \* $T(R2:C5) + $T(R3:C1) \* $T(R3:C5) + $T(R4:C1) \* $T(R4:C5))**</code>
 645 - Related: <code>[[$LIST()|Main/WebHome#FuncLIST]]</code>, <code>[[$PRODUCT()|Main/WebHome#FuncPRODUCT]]</code>, <code>[[$SUM()|Main/WebHome#FuncSUM]]</code>
 646
 647 <a name="FuncT"></a>
 648
 649 ### <a name="T( address ) -- content of a cel"></a> T( address ) -- content of a cell
 650
 651 - Syntax: <code>**$T( address )**</code>
 652 - Example: <code>**%CALC\{"$T(R1:C5)"\}%**</code> returns the text in cell <code>**R1:C5**</code>
 653 - Related: <code>[[$COLUMN()|Main/WebHome#FuncCOLUMN]]</code>, <code>[[$ROW()|Main/WebHome#FuncROW]]</code>
 654
 655 <a name="FuncTRANSLATE"></a>
 656
 657 ### <a name="TRANSLATE( text, from, to ) -- t"></a> TRANSLATE( text, from, to ) -- translate text from one set of characters to another
 658
 659 - The translation is done `from` a set `to` a set, one character by one. The `text` may contain commas; all three parameters are required. In the `from` and `to` parameters you can write `$comma` to escape comma, `$sp` to escape space
 660 - Syntax: <code>**$TRANSLATE( text, from, to )**</code>
 661 - Example: <code>**%CALC\{"$TRANSLATE(boom,bm,cl)"\}%**</code> returns <code>**cool**</code>
 662 - Example: <code>**%CALC\{"$TRANSLATE(one, two,$comma,;)"\}%**</code> returns <code>**one; two**</code>
 663 - Related: <code>[[$REPLACE()|Main/WebHome#FuncREPLACE]]</code>, <code>[[$SUBSTITUTE()|Main/WebHome#FuncSUBSTITUTE]]</code>
 664
 665 <a name="FuncTIME"></a>
 666
 667 ### <a name="TIME( text ) -- convert a date s"></a> TIME( text ) -- convert a date string into a serialized date number
 668
 669 - Serialized date is seconds since the Epoch, e.g. midnight, 01 Jan 1970. Current time is taken if the date string is empty. Supported date formats: `31 Dec 2009`; `31 Dec 2009 GMT`; `31 Dec 09`; `31-Dec-2009`; `31/Dec/2009`; `2009/12/31`; `2009-12-31`; `2009/12/31`; `2009/12/31 23:59`; `2009/12/31 - 23:59`; `2009-12-31-23-59`; `2009/12/31 - 23:59:59`; `2009.12.31.23.59.59`. Date is assumed to be server time; add `GMT` to indicate Greenwich time zone
 670 - Syntax: <code>**$TIME( _text_ )**</code>
 671 - Example: <code>**%CALC\{"$TIME(2003/10/14 GMT)"\}%**</code> returns <code>**1066089600**</code>
 672 - Related: <code>[[$FORMATTIME()|Main/WebHome#FuncFORMATTIME]]</code>, <code>[[$FORMATGMTIME()|Main/WebHome#FuncFORMATGMTIME]]</code>, <code>[[$TIMEADD()|Main/WebHome#FuncTIMEADD]]</code>, <code>[[$TIMEDIFF()|Main/WebHome#FuncTIMEDIFF]]</code>, <code>[[$TODAY()|Main/WebHome#FuncTODAY]]</code>
 673
 674 <a name="FuncTIMEADD"></a>
 675
 676 ### <a name="TIMEADD( serial, value, unit ) -"></a> TIMEADD( serial, value, unit ) -- add a value to a serialized date
 677
 678 - The unit is seconds if not specified; unit can be `second`, `minute`, `hour`, `day`, `week`, `month`, `year`. Note: An approximation is used for month and year calculations
 679 - Syntax: <code>**$TIMEADD( serial, value, _unit_ )**</code>
 680 - Example: <code>**%CALC\{"$TIMEADD($TIME(), 2, week)"\}%**</code>
 681 - Related: <code>[[$()|Main/WebHome#Func]]</code>, <code>[[$()|Main/WebHome#Func]]</code> returns the serialized date two weeks from now
 682 - Related: <code>[[$FORMATTIME()|Main/WebHome#FuncFORMATTIME]]</code>, <code>[[$FORMATGMTIME()|Main/WebHome#FuncFORMATGMTIME]]</code>, <code>[[$TIME()|Main/WebHome#FuncTIME]]</code>, <code>[[$TIMEDIFF()|Main/WebHome#FuncTIMEDIFF]]</code>, <code>[[$TODAY()|Main/WebHome#FuncTODAY]]</code>
 683
 684 <a name="FuncTIMEDIFF"></a>
 685
 686 ### <a name="TIMEDIFF( serial_1, serial_2, un"></a> TIMEDIFF( serial\_1, serial\_2, unit ) -- time difference between two serialized dates
 687
 688 - The unit is seconds if not specified; unit can be specified as in `$TIMEADD()`. Note: An approximation is used for month and year calculations. Use `$FORMAT()` or `$INT()` to format real numbers
 689 - Syntax: <code>**$TIMEDIFF( serial\_1, serial\_2, _unit_ )**</code>
 690 - Example: <code>**%CALC\{"$TIMEDIFF($TIME(), $EVAL($TIME()+90), minute)"\}%**</code> returns <code>**1\.5**</code>
 691 - Related: <code>[[$FORMAT()|Main/WebHome#FuncFORMAT]]</code>, <code>[[$FORMATTIME()|Main/WebHome#FuncFORMATTIME]]</code>, <code>[[$FORMATGMTIME()|Main/WebHome#FuncFORMATGMTIME]]</code>, <code>[[$INT()|Main/WebHome#FuncINT]]</code>, <code>[[$TIME()|Main/WebHome#FuncTIME]]</code>, <code>[[$TIMEADD()|Main/WebHome#FuncTIMEADD]]</code>, <code>[[$TODAY()|Main/WebHome#FuncTODAY]]</code>
 692
 693 <a name="FuncTODAY"></a>
 694
 695 ### <a name="TODAY( ) -- serialized date of t"></a> TODAY( ) -- serialized date of today at midnight GMT
 696
 697 - In contrast, the related `$TIME()` returns the serialized date of today at the current time, e.g. it includes the number of seconds since midnight GMT
 698 - Syntax: <code>**$TODAY( )**</code>
 699 - Example: <code>**%CALC\{"$TODAY()"\}%**</code> returns the number of seconds since Epoch
 700 - Related: <code>[[$FORMATTIME()|Main/WebHome#FuncFORMATTIME]]</code>, <code>[[$FORMATGMTIME()|Main/WebHome#FuncFORMATGMTIME]]</code>, <code>[[$TIME()|Main/WebHome#FuncTIME]]</code>, <code>[[$TIMEADD()|Main/WebHome#FuncTIMEADD]]</code>, <code>[[$TIMEDIFF()|Main/WebHome#FuncTIMEDIFF]]</code>
 701
 702 <a name="FuncTRIM"></a>
 703
 704 ### <a name="TRIM( text ) -- trim spaces from"></a> TRIM( text ) -- trim spaces from text
 705
 706 - Removes all spaces from text except for single spaces between words
 707 - Syntax: <code>**$TRIM( text )**</code>
 708 - Example: <code>**%CALC\{"$TRIM( eat  spaces  )"\}%**</code> returns <code>**eat spaces**</code>
 709 - Related: <code>[[$EXACT()|Main/WebHome#FuncEXACT]]</code>, <code>[[$PROPERSPACE()|Main/WebHome#FuncPROPERSPACE]]</code>
 710
 711 <a name="FuncUPPER"></a>
 712
 713 ### <a name="UPPER( text ) -- upper case stri"></a> UPPER( text ) -- upper case string of a text
 714
 715 - Syntax: <code>**$UPPER( text )**</code>
 716 - Example: <code>**%CALC\{"$UPPER($T(R1:C5))"\}%**</code> returns the upper case string of the text in cell <code>**R1:C5**</code>
 717 - Related: <code>[[$LOWER()|Main/WebHome#FuncLOWER]]</code>, <code>[[$PROPER()|Main/WebHome#FuncPROPER]]</code>, <code>[[$PROPERSPACE()|Main/WebHome#FuncPROPERSPACE]]</code>, <code>[[$TRIM()|Main/WebHome#FuncTRIM]]</code>
 718
 719 <a name="FuncVALUE"></a>
 720
 721 ### <a name="VALUE( text ) -- convert text to"></a> VALUE( text ) -- convert text to number
 722
 723 - Extracts a number from <code>**text**</code>. Returns <code>****</code> if not found
 724 - Syntax: <code>**$VALUE( text )**</code>
 725 - Example: <code>**%CALC\{"$VALUE(US$1,200)"\}%**</code> returns <code>**1200**</code>
 726 - Example: <code>**%CALC\{"$VALUE(PrjNotebook1234)"\}%**</code> returns <code>**1234**</code>
 727 - Example: <code>**%CALC\{"$VALUE(Total: -12.5)"\}%**</code> returns <code>**-12.5**</code>
 728 - Related: <code>[[$EVAL()|Main/WebHome#FuncEVAL]]</code>, <code>[[$INT()|Main/WebHome#FuncINT]]</code>
 729
 730 ## <a name="Bug Tracking Example"></a> Bug Tracking Example
 731
 732 <table border="1" cellpadding="0" cellspacing="0">
 733   <tr>
 734     <th bgcolor="#99CCCC"><strong> Bug#: </strong></th>
 735     <th bgcolor="#99CCCC"><strong> Priority: </strong></th>
 736     <th bgcolor="#99CCCC"><strong> Subject: </strong></th>
 737     <th bgcolor="#99CCCC"><strong> Status: </strong></th>
 738     <th bgcolor="#99CCCC"><strong> Days to fix </strong></th>
 739   </tr>
 740   <tr>
 741     <td> Bug:1231 </td>
 742     <td> Low </td>
 743     <td> File Open ... </td>
 744     <td> Open </td>
 745     <td align="right"> 3 </td>
 746   </tr>
 747   <tr>
 748     <td> Bug:1232 </td>
 749     <td> High </td>
 750     <td> Memory Window ... </td>
 751     <td> Fixed </td>
 752     <td align="right"> 2 </td>
 753   </tr>
 754   <tr>
 755     <td> Bug:1233 </td>
 756     <td> Medium </td>
 757     <td> Usability issue ... </td>
 758     <td> Assigned </td>
 759     <td align="right"> 5 </td>
 760   </tr>
 761   <tr>
 762     <td> Bug:1234 </td>
 763     <td> High </td>
 764     <td> No arrange ... </td>
 765     <td> Fixed </td>
 766     <td align="right"> 1 </td>
 767   </tr>
 768   <tr>
 769     <td> Total: 4 </td>
 770     <td> High: 2<br /> Low: 1<br /> Medium: 1 </td>
 771     <td> . </td>
 772     <td> Assigned: 1<br /> Fixed: 2<br /> Open: 1 </td>
 773     <td align="right"> Total: 11 </td>
 774   </tr>
 775 </table>
 776
 777 The last row is defined as:
 778
 779     | Total: %CALC{"$ROW(-2)"}% \
 780       | %CALC{"$COUNTITEMS( R2:C$COLUMN()..R$ROW(-1):C$COLUMN() )"}% | . \
 781       | %CALC{"$COUNTITEMS( R2:C$COLUMN()..R$ROW(-1):C$COLUMN() )"}% \
 782       |  Total: %CALC{"$SUM( R2:C$COLUMN()..R$ROW(-1):C$COLUMN() )"}% |
 783
 784 Above table is created manually. Another Plugin could build the table dynamically, e.g. by pulling data out of a bug tracking system. The Spreadsheet Plugin can be used to display table data statistics.
 785
 786 ## <a name="Plugin Settings"></a> Plugin Settings
 787
 788 Plugin settings are stored as preferences variables. To reference a plugin setting write <code>**%&lt;plugin&gt;\_&lt;setting&gt;%**</code>, i.e. <code>**%SPREADSHEETPLUGIN\_SHORTDESCRIPTION%**</code>
 789
 790 - One line description, is shown in the [[TextFormattingRules]] topic:
 791   - Set SHORTDESCRIPTION = Add spreadsheet calculation like `"$SUM( $ABOVE() )"` to tables located in %WIKITOOLNAME% topics.
 792
 793 - Debug plugin: (See output in `data/debug.txt`)
 794   - Set DEBUG = 0
 795
 796 - Do not handle `%CALC{}%` tag in included topic while including topic: (default: 1)
 797   - Set SKIPINCLUDE = 1
 798
 799 - [[WikiWords|TWiki/WikiWord]] to exclude from being spaced out by the <code>**$PROPERSPACE(text)**</code> function. This comma delimited list can be overloaded by a DONTSPACE preferences variable:
 800   - Set DONTSPACE = CodeWarrior, MacDonald, McIntosh, RedHat, SuSE
 801
 802 ## <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
 803
 804 **_Note:_** You do not need to install anything on the browser to use this plugin. Below installation instructions are for the administrator who needs to install this plugin on the TWiki server.
 805
 806 - Download the ZIP file from the %TOPIC% home
 807 - Unzip <code>**SpreadSheetPlugin.zip**</code> in your twiki installation directory. Content: <table border="1" cellpadding="0" cellspacing="0">
 808   <tr>
 809     <th bgcolor="#99CCCC"><strong> File: </strong></th>
 810     <th bgcolor="#99CCCC"><strong> Description: </strong></th>
 811   </tr>
 812   <tr>
 813     <td><code><b>data/TWiki/%TOPIC%.txt</b></code></td>
 814     <td> Plugin topic </td>
 815   </tr>
 816   <tr>
 817     <td><code><b>data/TWiki/%TOPIC%.txt,v</b></code></td>
 818     <td> Plugin topic repository </td>
 819   </tr>
 820   <tr>
 821     <td><code><b>lib/TWiki/Plugins/%TOPIC%.pm</b></code></td>
 822     <td> Plugin Perl module </td>
 823   </tr>
 824 </table>
 825 - Test if the "Total" in the first table in this topic is correct.
 826
 827 ## <a name="Plugin Info"></a> Plugin Info
 828
 829 <table border="1" cellpadding="0" cellspacing="0">
 830   <tr>
 831     <td align="right"> Plugin Author: </td>
 832     <td> TWiki:Main/PeterThoeny </td>
 833   </tr>
 834   <tr>
 835     <td align="right"> Plugin Version: </td>
 836     <td> 24 May 2004 </td>
 837   </tr>
 838   <tr>
 839     <td align="right"> Change History: </td>
 840     <td>  </td>
 841   </tr>
 842   <tr>
 843     <td align="right"> 24 May 2004: </td>
 844     <td> Refactored documentation (no code changes) </td>
 845   </tr>
 846   <tr>
 847     <td align="right"> 03 Apr 2004: </td>
 848     <td> Added $ABS(), $LISTIF(); fixed $VALUE() to remove leading zeros; changed $FIND() and $SEARCH() to return 0 instead of empty string if no match </td>
 849   </tr>
 850   <tr>
 851     <td align="right"> 21 Mar 2004: </td>
 852     <td> Added $LISTITEM(); fixed call to unofficial function </td>
 853   </tr>
 854   <tr>
 855     <td align="right"> 16 Mar 2004: </td>
 856     <td> Added $LISTMAP(), $LISTREVERSE(), $LISTSIZE(), $LISTSORT(), $LISTUNIQUE(), $SETM(); retired $COUNTUNIQUE() in favor of $COUNTITEMS($LISTUNIQUE()); fixed evaluation order issue of $IF(); fixed missing eval error messages suppressed since version 06 Mar 2004; redirect stderr messages to warning </td>
 857   </tr>
 858   <tr>
 859     <td align="right"> 08 Mar 2004: </td>
 860     <td> Added $LIST() </td>
 861   </tr>
 862   <tr>
 863     <td align="right"> 06 Mar 2004: </td>
 864     <td> Added $AND(), $MOD(), $NOT(), $OR(), $PRODUCT(), $PROPER(), $PROPERSPACE(), $RAND(), $REPEAT(), $SIGN(), $VALUE(); added digits parameter to $ROUND(); renamed $MULT() to $PRODUCT(); $MULT() is deprecated and undocumented </td>
 865   </tr>
 866   <tr>
 867     <td align="right"> 27 Feb 2004: </td>
 868     <td> Added $COUNTUNIQUE() </td>
 869   </tr>
 870   <tr>
 871     <td align="right"> 24 Oct 2003: </td>
 872     <td> Added $SET(), $GET(), $MEDIAN(); added $SUMPRODUCT(), inspired by TWiki:Main/RobertWithrow; added $SUMDAYS(), contributed by TWiki:Main/SvenDowideit </td>
 873   </tr>
 874   <tr>
 875     <td align="right"> 21 Oct 2003: </td>
 876     <td> Added support for lists <code>(1, 2, 3)</code> and lists of table ranges <code>(R1:C1..R1:C5, R3:C1..R3:C5)</code> for all functions that accept a table range; added $TIMEADD(); in $TIMEDIFF() added week unit; in $FORMATTIME() changed $weekday to $wd and added $wday and $weekday </td>
 877   </tr>
 878   <tr>
 879     <td align="right"> 14 Oct 2003: </td>
 880     <td> Added $TIME(), $TODAY(), $FORMATTIME(), $FORMATGMTIME(), $TIMEDIFF() </td>
 881   </tr>
 882   <tr>
 883     <td align="right"> 13 Oct 2003: </td>
 884     <td> Added $MULT(), contributed by TWiki:Main/GerritJanBaarda </td>
 885   </tr>
 886   <tr>
 887     <td align="right"> 30 Jul 2003: </td>
 888     <td> Added $TRANSLATE() </td>
 889   </tr>
 890   <tr>
 891     <td align="right"> 19 Jul 2003: </td>
 892     <td> Added $FIND(), $NOP(), $REPLACE(), $SEARCH(), $SUBSTITUTE(), contributed by TWiki:Main/PaulineCheung </td>
 893   </tr>
 894   <tr>
 895     <td align="right"> 19 Apr 2003: </td>
 896     <td> Added $COUNTSTR(), $EXACT(), $IF(), $ROUND(), $TRIM(); added $FORMAT(), contributed by TWiki:Main/JimStraus; support <code>%</code> modulus operator in $EVAL, $INT, and $ROUND; fixed bug in $DEF </td>
 897   </tr>
 898   <tr>
 899     <td align="right"> 07 Jun 2002: </td>
 900     <td> Added $DEF(), contributed by TWiki:Main/MartinFuzzey; allow values with HTML formatting like <code>&lt;u&gt;102&lt;/u&gt;</code>, suggested by TWiki:Main/GladeDiviney; added SKIPINCLUDE setting </td>
 901   </tr>
 902   <tr>
 903     <td align="right"> 12 Mar 2002: </td>
 904     <td> Support for multiple functions per nesting level </td>
 905   </tr>
 906   <tr>
 907     <td align="right"> 15 Jan 2002: </td>
 908     <td> Added $CHAR(), $CODE() and $LENGTH() </td>
 909   </tr>
 910   <tr>
 911     <td align="right"> 12 Nov 2001: </td>
 912     <td> Added $RIGHT() </td>
 913   </tr>
 914   <tr>
 915     <td align="right"> 12 Aug 2001: </td>
 916     <td> Fixed bug of disappearing multi-column cells </td>
 917   </tr>
 918   <tr>
 919     <td align="right"> 19 Jul 2001: </td>
 920     <td> Fixed incorrect $SUM calculation of cell with value <code>0</code></td>
 921   </tr>
 922   <tr>
 923     <td align="right"> 14 Jul 2001: </td>
 924     <td> Changed to plug &amp; play </td>
 925   </tr>
 926   <tr>
 927     <td align="right"> 01 Jun 2001: </td>
 928     <td> Fixed insecure dependencies for $MIN and $MAX </td>
 929   </tr>
 930   <tr>
 931     <td align="right"> 16 Apr 2001: </td>
 932     <td> Fixed div by 0 bug in $AVERAGE </td>
 933   </tr>
 934   <tr>
 935     <td align="right"> 17 Mar 2001: </td>
 936     <td> Initial version </td>
 937   </tr>
 938   <tr>
 939     <td align="right"> CPAN Dependencies: </td>
 940     <td> none </td>
 941   </tr>
 942   <tr>
 943     <td align="right"> TWiki:Plugins/Benchmark: </td>
 944     <td>[[TWiki/GoodStyle]] 99%, [[TWiki/FormattedSearch]] 99%, %TOPIC% 95% </td>
 945   </tr>
 946   <tr>
 947     <td align="right"> Other Dependencies: </td>
 948     <td> none </td>
 949   </tr>
 950   <tr>
 951     <td align="right"> Perl Version: </td>
 952     <td> 5.000 and up </td>
 953   </tr>
 954   <tr>
 955     <td align="right"> Plugin Home: </td>
 956     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
 957   </tr>
 958   <tr>
 959     <td align="right"> Feedback: </td>
 960     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev</a></td>
 961   </tr>
 962 </table>
 963
 964 **_Related Topics:_** [[TWikiPreferences]], [[TWikiPlugins]]
 965
 966 -- TWiki:Main/PeterThoeny - 24 May 2004 \`