TWiki/SpreadSheetPlugin.mdwn

   1 # <a name="TWiki Spreadsheet Plugin"></a><a name=" TWiki Spreadsheet Plugin"></a> TWiki Spreadsheet Plugin
   2
   3 This Plugin adds spreadsheet 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 mathematical formula</a></li>
  70         <li><a href="#EVEN( num ) -- test for even num"> EVEN( num ) -- test for even number</a></li>
  71         <li><a href="#EXACT( text1, text2 ) -- compare"> EXACT( text1, text2 ) -- compare two text strings</a></li>
  72         <li><a href="#EXEC( formula ) -- execute a spr"> EXEC( formula ) -- execute a spreadsheet formula</a></li>
  73         <li><a href="#EXISTS( topic ) -- check if topi"> EXISTS( topic ) -- check if topic exists</a></li>
  74         <li><a href="#FIND( string, text, start ) -- f"> FIND( string, text, start ) -- find one string within another string</a></li>
  75         <li><a href="#FORMAT( type, prec, number ) --"> FORMAT( type, prec, number ) -- format a number to a certain type and precision</a></li>
  76         <li><a href="#FORMATTIME( serial, text ) -- co"> FORMATTIME( serial, text ) -- convert a serialized date into a date string</a></li>
  77         <li><a href="#FORMATGMTIME( serial, text ) --"> FORMATGMTIME( serial, text ) -- convert a serialized date into a GMT date string</a></li>
  78         <li><a href="#GET( name ) -- get the value of"> GET( name ) -- get the value of a previously set variable</a></li>
  79         <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>
  80         <li><a href="#INT( formula ) -- evaluate formu"> INT( formula ) -- evaluate formula and round down to nearest integer</a></li>
  81         <li><a href="#LEFT( ) -- address range of cell"> LEFT( ) -- address range of cells to the left of the current cell</a></li>
  82         <li><a href="#LENGTH( text ) -- length of text"> LENGTH( text ) -- length of text in bytes</a></li>
  83         <li><a href="#LIST( range ) -- convert content"> LIST( range ) -- convert content of a cell range into a list</a></li>
  84         <li><a href="#LISTIF( condition, list ) -- rem"> LISTIF( condition, list ) -- remove elements from a list that do not meet a condition</a></li>
  85         <li><a href="#LISTITEM( index, list ) -- get o"> LISTITEM( index, list ) -- get one element of a list</a></li>
  86         <li><a href="#LISTJOIN( separator, list ) -- c"> LISTJOIN( separator, list ) -- convert a list into a string</a></li>
  87         <li><a href="#LISTMAP( formula, list ) -- eval"> LISTMAP( formula, list ) -- evaluate and update each element of a list</a></li>
  88         <li><a href="#LISTREVERSE( list ) -- opposite"> LISTREVERSE( list ) -- opposite order of a list</a></li>
  89         <li><a href="#LISTSIZE( list ) -- number of el"> LISTSIZE( list ) -- number of elements in a list</a></li>
  90         <li><a href="#LISTSORT( list ) -- sort a list"> LISTSORT( list ) -- sort a list</a></li>
  91         <li><a href="#LISTUNIQUE( list ) -- remove all"> LISTUNIQUE( list ) -- remove all duplicates from a list</a></li>
  92         <li><a href="#LOWER( text ) -- lower case stri"> LOWER( text ) -- lower case string of a text</a></li>
  93         <li><a href="#MAX( list ) - biggest value of a"> MAX( list ) - biggest value of a list or range of cells</a></li>
  94         <li><a href="#MEDIAN( list ) -- median of a li"> MEDIAN( list ) -- median of a list or range of cells</a></li>
  95         <li><a href="#MIN( list ) -- smallest value of"> MIN( list ) -- smallest value of a list or range of cells</a></li>
  96         <li><a href="#MOD( num, divisor ) -- reminder"> MOD( num, divisor ) -- reminder after dividing num by divisor</a></li>
  97         <li><a href="#NOEXEC( formula ) -- do not exec"> NOEXEC( formula ) -- do not execute a spreadsheet formula</a></li>
  98         <li><a href="#NOP( text ) -- no-operation"> NOP( text ) -- no-operation</a></li>
  99         <li><a href="#NOT( num ) -- reverse logic of a"> NOT( num ) -- reverse logic of a number</a></li>
 100         <li><a href="#ODD( num ) -- test for odd numbe"> ODD( num ) -- test for odd number</a></li>
 101         <li><a href="#OR( list ) -- logcial OR of a li"> OR( list ) -- logcial OR of a list</a></li>
 102         <li><a href="#PERCENTILE( num, list ) -- perce"> PERCENTILE( num, list ) -- percentile of a list or range of cells</a></li>
 103         <li><a href="#PRODUCT( list ) -- product of a"> PRODUCT( list ) -- product of a list or range of cells</a></li>
 104         <li><a href="#PROPER( text ) -- properly capit"> PROPER( text ) -- properly capitalize text</a></li>
 105         <li><a href="#PROPERSPACE( text ) -- properly"> PROPERSPACE( text ) -- properly space out WikiWords</a></li>
 106         <li><a href="#RAND( max ) -- random number"> RAND( max ) -- random number</a></li>
 107         <li><a href="#REPEAT(text) -- repeat text a nu"> REPEAT(text) -- repeat text a number of times</a></li>
 108         <li><a href="#REPLACE( text, start, num, new )"> REPLACE( text, start, num, new ) -- replace part of a text string</a></li>
 109         <li><a href="#RIGHT( ) -- address range of cel"> RIGHT( ) -- address range of cells to the right of the current cell</a></li>
 110         <li><a href="#ROUND( formula, digits ) -- roun"> ROUND( formula, digits ) -- round a number</a></li>
 111         <li><a href="#ROW( offset ) -- current row num"> ROW( offset ) -- current row number</a></li>
 112         <li><a href="#SEARCH( string, text, start ) --"> SEARCH( string, text, start ) -- search a string within a text</a></li>
 113         <li><a href="#SET( name, value ) -- set a vari"> SET( name, value ) -- set a variable for later use</a></li>
 114         <li><a href="#SETM( name, formula ) -- update"> SETM( name, formula ) -- update an existing variable based on a formula</a></li>
 115         <li><a href="#SIGN( num ) -- sign of a number"> SIGN( num ) -- sign of a number</a></li>
 116         <li><a href="#SUBSTITUTE( text, old, new, inst"> SUBSTITUTE( text, old, new, instance, option ) -- substitute text</a></li>
 117         <li><a href="#SUM( list ) -- sum of a list or"> SUM( list ) -- sum of a list or range of cells</a></li>
 118         <li><a href="#SUMDAYS( list ) -- sum the days"> SUMDAYS( list ) -- sum the days in a list or range of cells</a></li>
 119         <li><a href="#SUMPRODUCT( list, list ) -- scal"> SUMPRODUCT( list, list ) -- scalar product on ranges of cells</a></li>
 120         <li><a href="#T( address ) -- content of a cel"> T( address ) -- content of a cell</a></li>
 121         <li><a href="#TRANSLATE( text, from, to ) -- t"> TRANSLATE( text, from, to ) -- translate text from one set of characters to another</a></li>
 122         <li><a href="#TIME( text ) -- convert a date s"> TIME( text ) -- convert a date string into a serialized date number</a></li>
 123         <li><a href="#TIMEADD( serial, value, unit ) -"> TIMEADD( serial, value, unit ) -- add a value to a serialized date</a></li>
 124         <li><a href="#TIMEDIFF( serial_1, serial_2, un"> TIMEDIFF( serial_1, serial_2, unit ) -- time difference between two serialized dates</a></li>
 125         <li><a href="#TODAY( ) -- serialized date of t"> TODAY( ) -- serialized date of today at midnight GMT</a></li>
 126         <li><a href="#TRIM( text ) -- trim spaces from"> TRIM( text ) -- trim spaces from text</a></li>
 127         <li><a href="#UPPER( text ) -- upper case stri"> UPPER( text ) -- upper case string of a text</a></li>
 128         <li><a href="#VALUE( text ) -- convert text to"> VALUE( text ) -- convert text to number</a></li>
 129         <li><a href="#WORKINGDAYS( serial_1, serial_2"> WORKINGDAYS( serial_1, serial_2 ) -- working days between two serialized dates</a></li>
 130       </ul>
 131     </li>
 132     <li><a href="#Bug Tracking Example"> Bug Tracking Example</a></li>
 133     <li><a href="#Plugin Settings"> Plugin Settings</a></li>
 134     <li><a href="#Plugin Installation Instructions"> Plugin Installation Instructions</a></li>
 135     <li><a href="#Plugin Info"> Plugin Info</a></li>
 136   </ul>
 137 </div>
 138
 139 ## <a name="Syntax Rules"></a> Syntax Rules
 140
 141 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.
 142
 143 - Built-in function are of format <code>**$FUNCNAME(parameter)**</code>
 144 - Functions may be nested, e.g. <code>**%CALC\{"$SUM( R2:C$COLUMN(0)..R$ROW(-1):C$COLUMN(0) )"\}%**</code>
 145 - Functions are evaluated from left to right, and from inside to outside if nested
 146 - The function parameter can be text; a mathematical formula; a cell address; or a range of cell addresses
 147 - Multiple parameters form a list; they are separated by a comma, followed by optional space, e.g. <code>**%CALC\{"$SUM( 3, 5, 7 )"\}%**</code>
 148 - A table cell can be addressed as <code>**R1:C1**</code>. Table address matrix: <table border="1" cellpadding="0" cellspacing="0">
 149   <tr>
 150     <td><code><b>R1:C1</b></code></td>
 151     <td><code><b>R1:C2</b></code></td>
 152     <td><code><b>R1:C3</b></code></td>
 153     <td><code><b>R1:C4</b></code></td>
 154   </tr>
 155   <tr>
 156     <td><code><b>R2:C1</b></code></td>
 157     <td><code><b>R2:C2</b></code></td>
 158     <td><code><b>R2:C3</b></code></td>
 159     <td><code><b>R2:C4</b></code></td>
 160   </tr>
 161 </table>
 162 - 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>
 163 - 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>
 164 - 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
 165 - Formulae can also be placed outside of tables; they can reference cells in the preceeding table
 166
 167 ## <a name="Built-in Functions"></a> Built-in Functions
 168
 169 Conventions for Syntax:
 170
 171 - Required parameters are indicated in <code>**( bold )**</code>
 172 - Optional parameters are indicated in <code>**( _bold italic_ )**</code>
 173
 174 <a name="FuncABOVE"></a>
 175
 176 ### <a name="ABOVE( ) -- address range of cel"></a> ABOVE( ) -- address range of cells above the current cell
 177
 178 - Syntax: <code>**$ABOVE( )**</code>
 179 - Example: <code>**%CALC\{"$SUM($ABOVE())"\}%**</code> returns the sum of cells above the current cell
 180 - Related: <code>[[$LEFT()|Main/WebHome#FuncLEFT]]</code>, <code>[[$RIGHT()|Main/WebHome#FuncRIGHT]]</code>
 181
 182 <a name="FuncABS"></a>
 183
 184 ### <a name="ABS( num ) -- absolute value of"></a><a name="ABS( num ) -- absolute value of "></a> ABS( num ) -- absolute value of a number
 185
 186 - Syntax: <code>**$ABS( num )**</code>
 187 - Example: <code>**%CALC\{"$ABS(-12.5)"\}%**</code> returns <code>**12\.5**</code>
 188 - Related: <code>[[$SIGN()|Main/WebHome#FuncSIGN]]</code>, <code>[[$EVEN()|Main/WebHome#FuncEVEN]]</code>, <code>[[$ODD()|Main/WebHome#FuncODD]]</code>
 189
 190 <a name="FuncAND"></a>
 191
 192 ### <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
 193
 194 - Syntax: <code>**$AND( list )**</code>
 195 - Example: <code>**%CALC\{"$AND(1, 0, 1)"\}%**</code> returns <code>****</code>
 196 - Related: <code>[[$NOT()|Main/WebHome#FuncNOT]]</code>, <code>[[$IF()|Main/WebHome#FuncIF]]</code>, <code>[[$OR()|Main/WebHome#FuncOR]]</code>
 197
 198 <a name="FuncAVERAGE"></a>
 199
 200 ### <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
 201
 202 - Syntax: <code>**$AVERAGE( list )**</code>
 203 - Example: <code>**%CALC\{"$AVERAGE(R2:C5..R$ROW(-1):C5)"\}%**</code> returns the average of column 5, excluding the title row
 204 - 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>
 205
 206 <a name="FuncCHAR"></a>
 207
 208 ### <a name="CHAR( number ) -- ASCII characte"></a> CHAR( number ) -- ASCII character represented by number
 209
 210 - Syntax: <code>**$CHAR( number )**</code>
 211 - Example: Example: <code>**%CALC\{"$CHAR(97)"\}%**</code> returns <code>**a**</code>
 212 - Related: <code>[[$CODE()|Main/WebHome#FuncCODE]]</code>
 213
 214 <a name="FuncCODE"></a>
 215
 216 ### <a name="CODE( text ) -- ASCII numeric va"></a> CODE( text ) -- ASCII numeric value of character
 217
 218 - The ASCII numeric value of the first character in text
 219 - Syntax: <code>**$CODE( text )**</code>
 220 - Example: <code>**%CALC\{"$CODE(abc)"\}%**</code> returns <code>**97**</code>
 221 - Related: <code>[[$CHAR()|Main/WebHome#FuncCHAR]]</code>
 222
 223 <a name="FuncCOLUMN"></a>
 224
 225 ### <a name="COLUMN( offset ) -- current colu"></a> COLUMN( offset ) -- current column number
 226
 227 - The current table column number with an optional offset
 228 - Syntax: <code>**$COLUMN( _offset_ )**</code>
 229 - Example: <code>**%CALC\{"$COLUMN()"\}%**</code> returns <code>**2**</code> for the second column
 230 - Related: <code>[[$ROW()|Main/WebHome#FuncROW]]</code>, <code>[[$T()|Main/WebHome#FuncT]]</code>
 231
 232 <a name="FuncCOUNTITEMS"></a>
 233
 234 ### <a name="COUNTITEMS( list ) -- count indi"></a> COUNTITEMS( list ) -- count individual items in a list
 235
 236 - Syntax: <code>**$COUNTITEMS( list )**</code>
 237 - 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>
 238 - Related: <code>[[$COUNTSTR()|Main/WebHome#FuncCOUNTSTR]]</code>, <code>[[$LIST()|Main/WebHome#FuncLIST]]</code>
 239
 240 <a name="FuncCOUNTSTR"></a>
 241
 242 ### <a name="COUNTSTR( list, str ) -- count t"></a> COUNTSTR( list, str ) -- count the number of cells in a list equal to a given string
 243
 244 - 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
 245 - Syntax: <code>**$COUNTSTR( list, _str_ )**</code>
 246 - Example: <code>**%CALC\{"$COUNTSTR($ABOVE())"\}%**</code> counts the number of non empty cells above the current cell
 247 - Example: <code>**%CALC\{"$COUNTSTR($ABOVE(), DONE)"\}%**</code> counts the number of cells equal to <code>**DONE**</code>
 248 - Related: <code>[[$COUNTITEMS()|Main/WebHome#FuncCOUNTITEMS]]</code>, <code>[[$LIST()|Main/WebHome#FuncLIST]]</code>
 249
 250 <a name="FuncDEF"></a>
 251
 252 ### <a name="DEF( list ) -- find first non-em"></a> DEF( list ) -- find first non-empty list item or cell
 253
 254 - Returns the first list item or cell reference that is not empty
 255 - Syntax: <code>**$DEF( list )**</code>
 256 - Example: <code>**%CALC\{"$DEF(R1:C1..R1:C3)"\}%**</code>
 257 - Related: <code>[[$COUNTSTR()|Main/WebHome#FuncCOUNTSTR]]</code>, <code>[[$LISTIF()|Main/WebHome#FuncLISTIF]]</code>, <code>[[$LIST()|Main/WebHome#FuncLIST]]</code>
 258
 259 <a name="FuncEVAL"></a>
 260
 261 ### <a name="EVAL( formula ) -- evaluate a si"></a> EVAL( formula ) -- evaluate a simple mathematical formula
 262
 263 - Addition, substraction, multiplication, division and modulus of numbers are supported. Any nesting is permitted
 264 - Syntax: <code>**$EVAL( formula )**</code>
 265 - Example: <code>**%CALC\{"$EVAL( (5 \* 3) / 2 + 1.1 )"\}%**</code> returns <code>**8\.6**</code>
 266 - Related: <code>[[$EXEC()|Main/WebHome#FuncEXEC]]</code>, <code>[[$INT()|Main/WebHome#FuncINT]]</code>, <code>[[$MOD()|Main/WebHome#FuncMOD]]</code>, <code>[[$ROUND()|Main/WebHome#FuncROUND]]</code>, <code>[[$VALUE()|Main/WebHome#FuncVALUE]]</code>
 267
 268 <a name="FuncEVEN"></a>
 269
 270 ### <a name="EVEN( num ) -- test for even num"></a> EVEN( num ) -- test for even number
 271
 272 - Syntax: <code>**$EVEN( num )**</code>
 273 - Example: <code>**%CALC\{"$EVEN(2)"\}%**</code> returns <code>**1**</code>
 274 - Related: <code>[[$ABS()|Main/WebHome#FuncABS]]</code>, <code>[[$MOD()|Main/WebHome#FuncMOD]]</code>, <code>[[$ODD()|Main/WebHome#FuncODD]]</code>, <code>[[$SIGN()|Main/WebHome#FuncSIGN]]</code>
 275
 276 <a name="FuncEXACT"></a>
 277
 278 ### <a name="EXACT( text1, text2 ) -- compare"></a> EXACT( text1, text2 ) -- compare two text strings
 279
 280 - Compares two text strings and returns <code>**1**</code> if they are exactly the same, or <code>****</code> if not
 281 - Syntax: <code>**$EXACT( text1, _text2_ )**</code>
 282 - Example: <code>**%CALC\{"$EXACT(foo, Foo)"\}%**</code> returns <code>****</code>
 283 - Example: <code>**%CALC\{"$EXACT(foo, $LOWER(Foo))"\}%**</code> returns <code>**1**</code>
 284 - Related: <code>[[$IF()|Main/WebHome#FuncIF]]</code>, <code>[[$TRIM()|Main/WebHome#FuncTRIM]]</code>
 285
 286 <a name="FuncEXEC"></a>
 287
 288 ### <a name="EXEC( formula ) -- execute a spr"></a> EXEC( formula ) -- execute a spreadsheet formula
 289
 290 - Execute a spreadsheet formula, typically retrieved from a variable. This can be used to store a formula in a variable once and execute it many times using different parameters.
 291 - Syntax: <code>**$EXEC( formula )**</code>
 292 - Example: <code>**%CALC\{"$SET(msg, $NOEXEC(Hi $GET(name)))"\}%**</code> sets the `msg` variable with raw formula `Hi $GET(name)`
 293 - Example: <code>**%CALC\{"$SET(name, Tom) $EXEC($GET(msg))"\}%**</code> executes content of `msg` variable and returns `Hi Tom`
 294 - Example: <code>**%CALC\{"$SET(name, Jerry) $EXEC($GET(msg))"\}%**</code> returns `Hi Jerry`
 295 - Related: <code>[[$EVAL()|Main/WebHome#FuncEVAL]]</code>, <code>[[$GET()|Main/WebHome#FuncGET]]</code>, <code>[[$NOEXEC()|Main/WebHome#FuncNOEXEC]]</code>, <code>[[$SET()|Main/WebHome#FuncSET]]</code>
 296
 297 <a name="FuncEXISTS"></a>
 298
 299 ### <a name="EXISTS( topic ) -- check if topi"></a> EXISTS( topic ) -- check if topic exists
 300
 301 - Topic can be `TopicName` or a `Web.TopicName`
 302 - Syntax: <code>**$EXISTS( topic )**</code>
 303 - Example: <code>**%CALC\{"$EXISTS(WebHome)"\}%**</code> returns <code>**1**</code>
 304 - Example: <code>**%CALC\{"$EXISTS(ThisDoesNotExist)"\}%**</code> returns <code>****</code>
 305
 306 <a name="FuncFIND"></a>
 307
 308 ### <a name="FIND( string, text, start ) -- f"></a> FIND( string, text, start ) -- find one string within another string
 309
 310 - 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.
 311 - Syntax: <code>**$FIND( string, text, _start_ )**</code>
 312 - Example: <code>**%CALC\{"$FIND(f, fluffy)"\}%**</code> returns <code>**1**</code>
 313 - Example: <code>**%CALC\{"$FIND(f, fluffy, 2)"\}%**</code> returns <code>**4**</code>
 314 - Example: <code>**%CALC\{"$FIND(@, fluffy, 1)"\}%**</code> returns <code>****</code>
 315 - Related: <code>[[$REPLACE()|Main/WebHome#FuncREPLACE]]</code>, <code>[[$SEARCH()|Main/WebHome#FuncSEARCH]]</code>
 316
 317 <a name="FuncFORMAT"></a>
 318
 319 ### <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
 320
 321 - Type can be COMMA for comma format, DOLLAR for Dollar format, KB for Kilo Byte format, MB for Mega Byte format, KBMB for Kilo/Mega/Giga/Tera Byte auto-adjust format, NUMBER for number, and PERCENT for percent format
 322 - Syntax: <code>**$FORMAT( type, prec, number )**</code>
 323 - Example: <code>**%CALC\{"$FORMAT(COMMA, 2, 12345.6789)"\}%**</code> returns <code>**12,345.68**</code>
 324 - Example: <code>**%CALC\{"$FORMAT(DOLLAR, 2, 12345.67)"\}%**</code> returns <code>**$12,345.68**</code>
 325 - Example: <code>**%CALC\{"$FORMAT(KB, 2, 1234567)"\}%**</code> returns <code>**1205\.63 KB**</code>
 326 - Example: <code>**%CALC\{"$FORMAT(MB, 2, 1234567)"\}%**</code> returns <code>**1\.18 MB**</code>
 327 - Example: <code>**%CALC\{"$FORMAT(KBMB, 2, 1234567)"\}%**</code> returns <code>**1\.18 MB**</code>
 328 - Example: <code>**%CALC\{"$FORMAT(KBMB, 2, 1234567890)"\}%**</code> returns <code>**1\.15 GB**</code>
 329 - Example: <code>**%CALC\{"$FORMAT(NUMBER, 1, 12345.67)"\}%**</code> returns <code>**12345\.7**</code>
 330 - Example: <code>**%CALC\{"$FORMAT(PERCENT, 1, 0.1234567)"\}%**</code> returns <code>**12\.3%**</code>
 331 - Related: <code>[[$ROUND()|Main/WebHome#FuncROUND]]</code>
 332
 333 <a name="FuncFORMATTIME"></a>
 334
 335 ### <a name="FORMATTIME( serial, text ) -- co"></a> FORMATTIME( serial, text ) -- convert a serialized date into a date string
 336
 337 - 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.
 338 - Syntax: <code>**$FORMATTIME( serial, text )**</code>
 339 - Example: <code>**%CALC\{"$FORMATTIME(0, $year/$month/$day GMT)"\}%**</code> returns <code>**1970/01/01 GMT**</code>
 340 - 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>
 341
 342 <a name="FuncFORMATGMTIME"></a>
 343
 344 ### <a name="FORMATGMTIME( serial, text ) --"></a><a name="FORMATGMTIME( serial, text ) -- "></a> FORMATGMTIME( serial, text ) -- convert a serialized date into a GMT date string
 345
 346 - The date string represents the time in Greenwich time zone. Same variable expansion as in `$FORMATTIME()`.
 347 - Syntax: <code>**$FORMATGMTIME( serial, text )**</code>
 348 - Example: <code>**%CALC\{"$FORMATGMTIME(1041379200, $day $mon $year)"\}%**</code> returns <code>**01 Jan 2003**</code>
 349 - 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>
 350
 351 <a name="FuncGET"></a>
 352
 353 ### <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
 354
 355 - 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.
 356 - Syntax: <code>**$GET( name )**</code>
 357 - Example: <code>**%CALC\{"$GET(my\_total)"\}%**</code> returns the value of the `my_total` variable
 358 - Related: <code>[[$EXEC()|Main/WebHome#FuncEXEC]]</code>, <code>[[$NOEXEC()|Main/WebHome#FuncNOEXEC]]</code>, <code>[[$SET()|Main/WebHome#FuncSET]]</code>, <code>[[$SETM()|Main/WebHome#FuncSETM]]</code>
 359
 360 <a name="FuncIF"></a>
 361
 362 ### <a name="IF( condition, value if true, va"></a> IF( condition, value if true, value if 0 ) -- return a value based on a condition
 363
 364 - 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).
 365 - Syntax: <code>**$IF( condition, value if true, value if 0 )**</code>
 366 - 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
 367 - 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
 368 - Example: <code>**%CALC\{"$SET(val, $IF($T(R1:C2) == 0, zero, $T(R1:C2)))"\}%**</code> sets a variable conditionally
 369 - 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>
 370
 371 <a name="FuncINT"></a>
 372
 373 ### <a name="INT( formula ) -- evaluate formu"></a> INT( formula ) -- evaluate formula and round down to nearest integer
 374
 375 - Addition, substraction, multiplication, division and modulus of numbers are supported. Any nesting is permitted
 376 - Syntax: <code>**$INT( formula )**</code>
 377 - Example: <code>**%CALC\{"$INT(10 / 4)"\}%**</code> returns <code>**2**</code>
 378 - Related: <code>[[$EVAL()|Main/WebHome#FuncEVAL]]</code>, <code>[[$ROUND()|Main/WebHome#FuncROUND]]</code>, <code>[[$VALUE()|Main/WebHome#FuncVALUE]]</code>
 379
 380 <a name="FuncLEFT"></a>
 381
 382 ### <a name="LEFT( ) -- address range of cell"></a> LEFT( ) -- address range of cells to the left of the current cell
 383
 384 - Syntax: <code>**$LEFT( )**</code>
 385 - Example: <code>**%CALC\{"$SUM($LEFT())"\}%**</code> returns the sum of cells to the left of the current cell
 386 - Related: <code>[[$ABOVE()|Main/WebHome#FuncABOVE]]</code>, <code>[[$RIGHT()|Main/WebHome#FuncRIGHT]]</code>
 387
 388 <a name="FuncLENGTH"></a>
 389
 390 ### <a name="LENGTH( text ) -- length of text"></a> LENGTH( text ) -- length of text in bytes
 391
 392 - Syntax: <code>**$LENGTH( text )**</code>
 393 - Example: <code>**%CALC\{"$LENGTH(abcd)"\}%**</code> returns <code>**4**</code>
 394 - Related: <code>[[$LISTSIZE()|Main/WebHome#FuncLISTSIZE]]</code>
 395
 396 <a name="FuncLIST"></a>
 397
 398 ### <a name="LIST( range ) -- convert content"></a> LIST( range ) -- convert content of a cell range into a list
 399
 400 - Convert the content of a range of cells into a flat list, delimited by comma. Cells containing commas are merged into the list
 401 - Syntax: <code>**$LIST( range )**</code>
 402 - 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>
 403 - 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>[[$LISTJOIN()|Main/WebHome#FuncLISTJOIN]]</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>
 404
 405 <a name="FuncLISTIF"></a>
 406
 407 ### <a name="LISTIF( condition, list ) -- rem"></a> LISTIF( condition, list ) -- remove elements from a list that do not meet a condition
 408
 409 - 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
 410 - Syntax: <code>**$LISTIF( condition, list )**</code>
 411 - Example: <code>**%CALC\{"$LISTIF($item &gt; 12, 14, 7, 25)"\}%**</code> returns <code>**14, 25**</code>
 412 - Example: <code>**%CALC\{"$LISTIF($NOT($EXACT($item,)), A, B, , E)"\}%**</code> returns non-empty elements <code>**A, B, E**</code>
 413 - Example: <code>**%CALC\{"$LISTIF($index &gt; 2, A, B, C, D)"\}%**</code> returns <code>**C, D**</code>
 414 - 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>
 415
 416 <a name="FuncLISTITEM"></a>
 417
 418 ### <a name="LISTITEM( index, list ) -- get o"></a> LISTITEM( index, list ) -- get one element of a list
 419
 420 - Index is 1 to size of list; use a negative number to count from the end of the list
 421 - Syntax: <code>**$LISTITEM( index, list )**</code>
 422 - Example: <code>**%CALC\{"$LISTITEM(2, Apple, Orange, Apple, Kiwi)"\}%**</code> returns <code>**Orange**</code>
 423 - Example: <code>**%CALC\{"$LISTITEM(-1, Apple, Orange, Apple, Kiwi)"\}%**</code> returns <code>**Kiwi**</code>
 424 - 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>
 425
 426 <a name="FuncLISTJOIN"></a>
 427
 428 ### <a name="LISTJOIN( separator, list ) -- c"></a> LISTJOIN( separator, list ) -- convert a list into a string
 429
 430 - By default, list items are separated by a comma and a space. Use this function to indicate a specific `separator` string, which may include `$comma` for comma, `$n` for newline, and `$sp` for space.
 431 - Syntax: <code>**$LISTJOIN( separator, list )**</code>
 432 - Example: <code>**%CALC\{"$LISTJOIN($n, Apple, Orange, Apple, Kiwi)"\}%**</code> returns the four items separated by new lines
 433 - Related: <code>[[$LIST()|Main/WebHome#FuncLIST]]</code>, <code>[[$LISTSIZE()|Main/WebHome#FuncLISTSIZE]]</code>
 434
 435 <a name="FuncLISTMAP"></a>
 436
 437 ### <a name="LISTMAP( formula, list ) -- eval"></a> LISTMAP( formula, list ) -- evaluate and update each element of a list
 438
 439 - 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
 440 - Syntax: <code>**$LISTMAP( formula, list )**</code>
 441 - Example: <code>**%CALC\{"$LISTMAP($index: $EVAL(2 \* $item), 3, 5, 7, 11)"\}%**</code> returns <code>**1: 6, 2: 10, 3: 14, 4: 22**</code>
 442 - 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>
 443
 444 <a name="FuncLISTREVERSE"></a>
 445
 446 ### <a name="LISTREVERSE( list ) -- opposite"></a><a name="LISTREVERSE( list ) -- opposite "></a> LISTREVERSE( list ) -- opposite order of a list
 447
 448 - Syntax: <code>**$LISTREVERSE( list )**</code>
 449 - Example: <code>**%CALC\{"$LISTREVERSE(Apple, Orange, Apple, Kiwi)"\}%**</code> returns <code>**Kiwi, Apple, Orange, Apple**</code>
 450 - 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>
 451
 452 <a name="FuncLISTSIZE"></a>
 453
 454 ### <a name="LISTSIZE( list ) -- number of el"></a> LISTSIZE( list ) -- number of elements in a list
 455
 456 - Syntax: <code>**$LISTSIZE( list )**</code>
 457 - Example: <code>**%CALC\{"$LISTSIZE(Apple, Orange, Apple, Kiwi)"\}%**</code> returns <code>**4**</code>
 458 - 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>[[$LISTJOIN()|Main/WebHome#FuncLISTJOIN]]</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>
 459
 460 <a name="FuncLISTSORT"></a>
 461
 462 ### <a name="LISTSORT( list ) -- sort a list"></a> LISTSORT( list ) -- sort a list
 463
 464 - Sorts a list in ASCII order, or numerically if all elements are numeric
 465 - Syntax: <code>**$LISTSORT( list )**</code>
 466 - Example: <code>**%CALC\{"$LISTSORT(Apple, Orange, Apple, Kiwi)"\}%**</code> returns <code>**Apple, Apple, Kiwi, Orange**</code>
 467 - 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>
 468
 469 <a name="FuncLISTUNIQUE"></a>
 470
 471 ### <a name="LISTUNIQUE( list ) -- remove all"></a> LISTUNIQUE( list ) -- remove all duplicates from a list
 472
 473 - Syntax: <code>**$LISTUNIQUE( list )**</code>
 474 - Example: <code>**%CALC\{"$LISTUNIQUE(Apple, Orange, Apple, Kiwi)"\}%**</code> returns <code>**Apple, Orange, Kiwi**</code>
 475 - 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>
 476
 477 <a name="FuncLOWER"></a>
 478
 479 ### <a name="LOWER( text ) -- lower case stri"></a> LOWER( text ) -- lower case string of a text
 480
 481 - Syntax: <code>**$LOWER(text)**</code>
 482 - Example: <code>**%CALC\{"$LOWER( $T(R1:C5) )"\}%**</code> returns the lower case string of the text in cell <code>**R1:C5**</code>
 483 - 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>
 484
 485 <a name="FuncMAX"></a>
 486
 487 ### <a name="MAX( list ) - biggest value of a"></a> MAX( list ) - biggest value of a list or range of cells
 488
 489 - Syntax: <code>**$MAX( list )**</code>
 490 - Example: To find the biggest number to the left of the current cell, write: <code>**%CALC\{"$MAX($LEFT())"\}%**</code>
 491 - Related: <code>[[$LIST()|Main/WebHome#FuncLIST]]</code>, <code>[[$MEDIAN()|Main/WebHome#FuncMEDIAN]]</code>, <code>[[$MIN()|Main/WebHome#FuncMIN]]</code>, <code>[[$PERCENTILE()|Main/WebHome#FuncPERCENTILE]]</code>
 492
 493 <a name="FuncMEDIAN"></a>
 494
 495 ### <a name="MEDIAN( list ) -- median of a li"></a> MEDIAN( list ) -- median of a list or range of cells
 496
 497 - Syntax: <code>**$MEDIAN( list )**</code>
 498 - Example: <code>**%CALC\{"$MEDIAN(3, 9, 4, 5)"\}%**</code> returns <code>**4\.5**</code>
 499 - Related: <code>[[$LIST()|Main/WebHome#FuncLIST]]</code>, <code>[[$MAX()|Main/WebHome#FuncMAX]]</code>, <code>[[$MIN()|Main/WebHome#FuncMIN]]</code>, <code>[[$PERCENTILE()|Main/WebHome#FuncPERCENTILE]]</code>
 500
 501 <a name="FuncMIN"></a>
 502
 503 ### <a name="MIN( list ) -- smallest value of"></a> MIN( list ) -- smallest value of a list or range of cells
 504
 505 - Syntax: <code>**$MIN( list )**</code>
 506 - Example: <code>**%CALC\{"$MIN(15, 3, 28)"\}%**</code> returns <code>**3**</code>
 507 - Related: <code>[[$LIST()|Main/WebHome#FuncLIST]]</code>, <code>[[$MAX()|Main/WebHome#FuncMAX]]</code>, <code>[[$MEDIAN()|Main/WebHome#FuncMEDIAN]]</code>, <code>[[$PERCENTILE()|Main/WebHome#FuncPERCENTILE]]</code>
 508
 509 <a name="FuncMOD"></a>
 510
 511 ### <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>
 512
 513 - Syntax: <code>**$MOD( num, divisor )**</code>
 514 - Example: <code>**%CALC\{"$MOD(7, 3)"\}%**</code> returns <code>**1**</code>
 515 - Related: <code>[[$EVAL()|Main/WebHome#FuncEVAL]]</code>
 516
 517 <a name="FuncNOEXEC"></a>
 518
 519 ### <a name="NOEXEC( formula ) -- do not exec"></a> NOEXEC( formula ) -- do not execute a spreadsheet formula
 520
 521 - Prevent a formula from getting executed. This is typically used to store a raw formula in a variable for later use as described in <code>[[$EXEC()|Main/WebHome#FuncEXEC]]</code>.
 522 - Syntax: <code>**$NOEXEC( formula )**</code>
 523 - Example: <code>**%CALC\{"$SET(msg, $NOEXEC(Hi $GET(name)))"\}%**</code> sets the `msg` variable with the formula `Hi $GET(name)` without executing it
 524 - Related: <code>[[$EVAL()|Main/WebHome#FuncEVAL]]</code>, <code>[[$EXEC()|Main/WebHome#FuncEXEC]]</code>, <code>[[$GET()|Main/WebHome#FuncGET]]</code>, <code>[[$SET()|Main/WebHome#FuncSET]]</code>
 525
 526 <a name="FuncNOP"></a>
 527
 528 ### <a name="NOP( text ) -- no-operation"></a> NOP( text ) -- no-operation
 529
 530 - 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`
 531 - Syntax: <code>**$NOP( text )**</code>
 532
 533 <a name="FuncNOT"></a>
 534
 535 ### <a name="NOT( num ) -- reverse logic of a"></a> NOT( num ) -- reverse logic of a number
 536
 537 - Returns 0 if <code>**num**</code> is not zero, 1 if zero
 538 - Syntax: <code>**$NOT( num )**</code>
 539 - Example: <code>**%CALC\{"$NOT(0)"\}%**</code> returns <code>**1**</code>
 540 - Related: <code>[[$AND()|Main/WebHome#FuncAND]]</code>, <code>[[$IF()|Main/WebHome#FuncIF]]</code>, <code>[[$OR()|Main/WebHome#FuncOR]]</code>
 541
 542 <a name="FuncODD"></a>
 543
 544 ### <a name="ODD( num ) -- test for odd numbe"></a> ODD( num ) -- test for odd number
 545
 546 - Syntax: <code>**$ODD( num )**</code>
 547 - Example: <code>**%CALC\{"$ODD(2)"\}%**</code> returns <code>****</code>
 548 - Related: <code>[[$ABS()|Main/WebHome#FuncABS]]</code>, <code>[[$EVEN()|Main/WebHome#FuncEVEN]]</code>, <code>[[$MOD()|Main/WebHome#FuncMOD]]</code>, <code>[[$SIGN()|Main/WebHome#FuncSIGN]]</code>
 549
 550 <a name="FuncOR"></a>
 551
 552 ### <a name="OR( list ) -- logcial OR of a li"></a> OR( list ) -- logcial OR of a list
 553
 554 - Syntax: <code>**$OR( list )**</code>
 555 - Example: <code>**%CALC\{"$OR(1, 0, 1)"\}%**</code> returns <code>**1**</code>
 556 - Related: <code>[[$AND()|Main/WebHome#FuncAND]]</code>, <code>[[$IF()|Main/WebHome#FuncIF]]</code>, <code>[[$NOT()|Main/WebHome#FuncNOT]]</code>
 557
 558 <a name="FuncPERCENTILE"></a>
 559
 560 ### <a name="PERCENTILE( num, list ) -- perce"></a> PERCENTILE( num, list ) -- percentile of a list or range of cells
 561
 562 - Calculates the num-th percentile, useful to establish a threshold of acceptance. num is the percentile value, range 0..100
 563 - Syntax: <code>**$PERCENTILE( num, list )**</code>
 564 - Example: <code>**%CALC\{"$PERCENTILE(75, 400, 200, 500, 100, 300)"\}%**</code> returns <code>**450**</code>
 565 - 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>
 566
 567 <a name="FuncPRODUCT"></a>
 568
 569 ### <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
 570
 571 - Syntax: <code>**$PRODUCT( list )**</code>
 572 - Example: To calculate the product of the cells to the left of the current one use <code>**%CALC\{"$PRODUCT($LEFT())"\}%**</code>
 573 - 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>
 574
 575 <a name="FuncPROPER"></a>
 576
 577 ### <a name="PROPER( text ) -- properly capit"></a> PROPER( text ) -- properly capitalize text
 578
 579 - Capitalize letters that follow any character other than a letter; convert all other letters to lowercase letters
 580 - Syntax: <code>**$PROPER( text )**</code>
 581 - Example: <code>**%CALC\{"PROPER(a small STEP)"\}%**</code> returns <code>**A Small Step**</code>
 582 - Example: <code>**%CALC\{"PROPER(f1 (formula-1))"\}%**</code> returns <code>**F1 (Formula-1)**</code>
 583 - 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>
 584
 585 <a name="FuncPROPERSPACE"></a>
 586
 587 ### <a name="PROPERSPACE( text ) -- properly"></a><a name="PROPERSPACE( text ) -- properly "></a> PROPERSPACE( text ) -- properly space out WikiWords
 588
 589 - 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
 590 - Syntax: <code>**$PROPERSPACE( text )**</code>
 591 - 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>
 592 - 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>
 593
 594 <a name="FuncRAND"></a>
 595
 596 ### <a name="RAND( max ) -- random number"></a> RAND( max ) -- random number
 597
 598 - Random number, evenly distributed between 0 and <code>**max**</code>, or 0 and 1 if max is not specified
 599 - Syntax: <code>**$RAND( max )**</code>
 600 - Related: <code>[[$EVAL()|Main/WebHome#FuncEVAL]]</code>
 601
 602 <a name="FuncREPEAT"></a>
 603
 604 ### <a name="REPEAT(text) -- repeat text a nu"></a> REPEAT(text) -- repeat text a number of times
 605
 606 - Syntax: <code>**$REPEAT( text )**</code>
 607 - Example: <code>**%CALC\{"$REPEAT(/\\, 5)"\}%**</code> returns <code>**/\\/\\/\\/\\/\\**</code>
 608
 609 <a name="FuncREPLACE"></a>
 610
 611 ### <a name="REPLACE( text, start, num, new )"></a> REPLACE( text, start, num, new ) -- replace part of a text string
 612
 613 - 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
 614 - Syntax: <code>**$REPLACE( text, start, num, new )**</code>
 615 - Example: <code>**%CALC\{"$REPLACE(abcdefghijk,6,5,\*)"\}%**</code> returns <code>**abcde\*k**</code>
 616 - 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>
 617
 618 <a name="FuncRIGHT"></a>
 619
 620 ### <a name="RIGHT( ) -- address range of cel"></a> RIGHT( ) -- address range of cells to the right of the current cell
 621
 622 - Syntax: <code>**$RIGHT( )**</code>
 623 - Example: <code>**%CALC\{"$SUM($RIGHT())"\}%**</code> returns the sum of cells to the right of the current cell
 624 - Related: <code>[[$ABOVE()|Main/WebHome#FuncABOVE]]</code>, <code>[[$LEFT()|Main/WebHome#FuncLEFT]]</code>
 625
 626 <a name="FuncROUND"></a>
 627
 628 ### <a name="ROUND( formula, digits ) -- roun"></a> ROUND( formula, digits ) -- round a number
 629
 630 - 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
 631 - Syntax: <code>**$ROUND( formula, digits )**</code>
 632 - Example: <code>**%CALC\{"$ROUND(3.15, 1)"\}%**</code> returns <code>**3\.2**</code>
 633 - Example: <code>**%CALC\{"$ROUND(3.149, 1)"\}%**</code> returns <code>**3\.1**</code>
 634 - Example: <code>**%CALC\{"$ROUND(-2.475, 2)"\}%**</code> returns <code>**-2.48**</code>
 635 - Example: <code>**%CALC\{"$ROUND(34.9, -1)"\}%**</code> returns <code>**30**</code>
 636 - Related: <code>[[$INT()|Main/WebHome#FuncINT]]</code>, <code>[[$FORMAT()|Main/WebHome#FuncFORMAT]]</code>
 637
 638 <a name="FuncROW"></a>
 639
 640 ### <a name="ROW( offset ) -- current row num"></a> ROW( offset ) -- current row number
 641
 642 - The current table row number with an optional offset
 643 - Syntax: <code>**$ROW( _offset_ )**</code>
 644 - 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>
 645 - Related: <code>[[$COLUMN()|Main/WebHome#FuncCOLUMN]]</code>, <code>[[$T()|Main/WebHome#FuncT]]</code>
 646
 647 <a name="FuncSEARCH"></a>
 648
 649 ### <a name="SEARCH( string, text, start ) --"></a> SEARCH( string, text, start ) -- search a string within a text
 650
 651 - 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
 652 - Syntax: <code>**$SEARCH( string, text, _start_ )**</code>
 653 - Example: <code>**%CALC\{"$SEARCH([uy], fluffy)"\}%**</code> returns <code>**3**</code>
 654 - Example: <code>**%CALC\{"$SEARCH([uy], fluffy, 3)"\}%**</code> returns <code>**6**</code>
 655 - Example: <code>**%CALC\{"$SEARCH([abc], fluffy,)"\}%**</code> returns <code>****</code>
 656 - Related: <code>[[$FIND()|Main/WebHome#FuncFIND]]</code>, <code>[[$REPLACE()|Main/WebHome#FuncREPLACE]]</code>
 657
 658 <a name="FuncSET"></a>
 659
 660 ### <a name="SET( name, value ) -- set a vari"></a> SET( name, value ) -- set a variable for later use
 661
 662 - Specify the variable name (alphanumeric characters and underscores) and the value. The value may contain a formula; formulae are evaluated before the variable assignment; see <code>[[$NOEXEC()|Main/WebHome#FuncNOEXEC]]</code> if you want to prevent that. 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 and also included topics
 663 - Syntax: <code>**$SET( name, value )**</code>
 664 - 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
 665 - Related: <code>[[$EXEC()|Main/WebHome#FuncEXEC]]</code>, <code>[[$GET()|Main/WebHome#FuncGET]]</code>, <code>[[$NOEXEC()|Main/WebHome#FuncNOEXEC]]</code>, <code>[[SETM()|Main/WebHome#FuncSETM]]</code>
 666
 667 <a name="FuncSETM"></a>
 668
 669 ### <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
 670
 671 - 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
 672 - Syntax: <code>**$SETM( name, formula )**</code>
 673 - 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
 674 - Related: <code>[[$GET()|Main/WebHome#FuncGET]]</code>, <code>[[$SET()|Main/WebHome#FuncSET]]</code>
 675
 676 <a name="FuncSIGN"></a>
 677
 678 ### <a name="SIGN( num ) -- sign of a number"></a> SIGN( num ) -- sign of a number
 679
 680 - Returns -1 if <code>**num**</code> is negative, 0 if zero, or 1 if positive
 681 - Syntax: <code>**$SIGN( num )**</code>
 682 - Example: <code>**%CALC\{"$SIGN(-12.5)"\}%**</code> returns <code>**-1**</code>
 683 - Related: <code>[[$ABS()|Main/WebHome#FuncABS]]</code>, <code>[[$EVAL()|Main/WebHome#FuncEVAL]]</code>, <code>[[$EVEN()|Main/WebHome#FuncEVEN]]</code>, <code>[[$INT()|Main/WebHome#FuncINT]]</code>, <code>[[$NOT()|Main/WebHome#FuncNOT]]</code>, <code>[[$ODD()|Main/WebHome#FuncODD]]</code>
 684
 685 <a name="FuncSUBSTITUTE"></a>
 686
 687 ### <a name="SUBSTITUTE( text, old, new, inst"></a> SUBSTITUTE( text, old, new, instance, option ) -- substitute text
 688
 689 - 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>
 690 - Syntax: <code>**$SUBSTITUTE( text, old, _new_, _instance_, _option_ )**</code>
 691 - Example: <code>**%CALC\{"$SUBSTITUTE(Good morning, morning, day)"\}%**</code> returns <code>**Good day**</code>
 692 - Example: <code>**%CALC\{"$SUBSTITUTE(Q2-2002,2,3)"\}%**</code> returns <code>**Q3-3003**</code>
 693 - Example: <code>**%CALC\{"$SUBSTITUTE(Q2-2002,2,3,3)"\}%**</code> returns <code>**Q2-2003**</code>
 694 - Example: <code>**%CALC\{"$SUBSTITUTE(abc123def,[0-9],9,,r)"\}%**</code> returns <code>**abc999def**</code>
 695 - Related: <code>[[$REPLACE()|Main/WebHome#FuncREPLACE]]</code>, <code>[[$TRANSLATE()|Main/WebHome#FuncTRANSLATE]]</code>
 696
 697 <a name="FuncSUM"></a>
 698
 699 ### <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
 700
 701 - Syntax: <code>**$SUM( list )**</code>
 702 - 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>
 703 - Related: <code>[[$LIST()|Main/WebHome#FuncLIST]]</code>, <code>[[$PRODUCT()|Main/WebHome#FuncPRODUCT]]</code>, <code>[[$SUMPRODUCT()|Main/WebHome#FuncSUMPRODUCT]]</code>, <code>[[$WORKINGDAYS()|Main/WebHome#FuncWORKINGDAYS]]</code>
 704
 705 <a name="FuncSUMDAYS"></a>
 706
 707 ### <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
 708
 709 - 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
 710 - Syntax: <code>**$SUMDAYS( list )**</code>
 711 - Example: <code>**%CALC\{"$SUMDAYS(2w, 1, 2d, 4h)"\}%**</code> returns <code>**13\.5**</code>, the evaluation of `(2*5 + 1 + 2 + 4/8)`
 712 - Related: <code>[[$SUM()|Main/WebHome#FuncSUM]]</code>, <code>[[$TIME()|Main/WebHome#FuncTIME]]</code>, <code>[[$FORMATTIME()|Main/WebHome#FuncFORMATTIME]]</code>
 713
 714 <a name="FuncSUMPRODUCT"></a>
 715
 716 ### <a name="SUMPRODUCT( list, list ) -- scal"></a> SUMPRODUCT( list, list ) -- scalar product on ranges of cells
 717
 718 - Syntax: <code>**$SUMPRODUCT( list, list, _list..._ )**</code>
 719 - Example: <code>**%CALC\{"$SUMPRODUCT(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>
 720 - Related: <code>[[$LIST()|Main/WebHome#FuncLIST]]</code>, <code>[[$PRODUCT()|Main/WebHome#FuncPRODUCT]]</code>, <code>[[$SUM()|Main/WebHome#FuncSUM]]</code>
 721
 722 <a name="FuncT"></a>
 723
 724 ### <a name="T( address ) -- content of a cel"></a> T( address ) -- content of a cell
 725
 726 - Syntax: <code>**$T( address )**</code>
 727 - Example: <code>**%CALC\{"$T(R1:C5)"\}%**</code> returns the text in cell <code>**R1:C5**</code>
 728 - Related: <code>[[$COLUMN()|Main/WebHome#FuncCOLUMN]]</code>, <code>[[$ROW()|Main/WebHome#FuncROW]]</code>
 729
 730 <a name="FuncTRANSLATE"></a>
 731
 732 ### <a name="TRANSLATE( text, from, to ) -- t"></a> TRANSLATE( text, from, to ) -- translate text from one set of characters to another
 733
 734 - 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
 735 - Syntax: <code>**$TRANSLATE( text, from, to )**</code>
 736 - Example: <code>**%CALC\{"$TRANSLATE(boom,bm,cl)"\}%**</code> returns <code>**cool**</code>
 737 - Example: <code>**%CALC\{"$TRANSLATE(one, two,$comma,;)"\}%**</code> returns <code>**one; two**</code>
 738 - Related: <code>[[$REPLACE()|Main/WebHome#FuncREPLACE]]</code>, <code>[[$SUBSTITUTE()|Main/WebHome#FuncSUBSTITUTE]]</code>
 739
 740 <a name="FuncTIME"></a>
 741
 742 ### <a name="TIME( text ) -- convert a date s"></a> TIME( text ) -- convert a date string into a serialized date number
 743
 744 - 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
 745 - Syntax: <code>**$TIME( _text_ )**</code>
 746 - Example: <code>**%CALC\{"$TIME(2003/10/14 GMT)"\}%**</code> returns <code>**1066089600**</code>
 747 - 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>, <code>[[$WORKINGDAYS()|Main/WebHome#FuncWORKINGDAYS]]</code>
 748
 749 <a name="FuncTIMEADD"></a>
 750
 751 ### <a name="TIMEADD( serial, value, unit ) -"></a> TIMEADD( serial, value, unit ) -- add a value to a serialized date
 752
 753 - 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
 754 - Syntax: <code>**$TIMEADD( serial, value, _unit_ )**</code>
 755 - Example: <code>**%CALC\{"$TIMEADD($TIME(), 2, week)"\}%**</code> returns the serialized date two weeks from now
 756 - 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>
 757
 758 <a name="FuncTIMEDIFF"></a>
 759
 760 ### <a name="TIMEDIFF( serial_1, serial_2, un"></a> TIMEDIFF( serial\_1, serial\_2, unit ) -- time difference between two serialized dates
 761
 762 - 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
 763 - Syntax: <code>**$TIMEDIFF( serial\_1, serial\_2, _unit_ )**</code>
 764 - Example: <code>**%CALC\{"$TIMEDIFF($TIME(), $EVAL($TIME()+90), minute)"\}%**</code> returns <code>**1\.5**</code>
 765 - 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>, <code>[[$WORKINGDAYS()|Main/WebHome#FuncWORKINGDAYS]]</code>
 766
 767 <a name="FuncTODAY"></a>
 768
 769 ### <a name="TODAY( ) -- serialized date of t"></a> TODAY( ) -- serialized date of today at midnight GMT
 770
 771 - 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
 772 - Syntax: <code>**$TODAY( )**</code>
 773 - Example: <code>**%CALC\{"$TODAY()"\}%**</code> returns the number of seconds since Epoch
 774 - 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>
 775
 776 <a name="FuncTRIM"></a>
 777
 778 ### <a name="TRIM( text ) -- trim spaces from"></a> TRIM( text ) -- trim spaces from text
 779
 780 - Removes all spaces from text except for single spaces between words
 781 - Syntax: <code>**$TRIM( text )**</code>
 782 - Example: <code>**%CALC\{"$TRIM( eat  spaces  )"\}%**</code> returns <code>**eat spaces**</code>
 783 - Related: <code>[[$EXACT()|Main/WebHome#FuncEXACT]]</code>, <code>[[$PROPERSPACE()|Main/WebHome#FuncPROPERSPACE]]</code>
 784
 785 <a name="FuncUPPER"></a>
 786
 787 ### <a name="UPPER( text ) -- upper case stri"></a> UPPER( text ) -- upper case string of a text
 788
 789 - Syntax: <code>**$UPPER( text )**</code>
 790 - Example: <code>**%CALC\{"$UPPER($T(R1:C5))"\}%**</code> returns the upper case string of the text in cell <code>**R1:C5**</code>
 791 - 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>
 792
 793 <a name="FuncVALUE"></a>
 794
 795 ### <a name="VALUE( text ) -- convert text to"></a> VALUE( text ) -- convert text to number
 796
 797 - Extracts a number from <code>**text**</code>. Returns <code>****</code> if not found
 798 - Syntax: <code>**$VALUE( text )**</code>
 799 - Example: <code>**%CALC\{"$VALUE(US$1,200)"\}%**</code> returns <code>**1200**</code>
 800 - Example: <code>**%CALC\{"$VALUE(PrjNotebook1234)"\}%**</code> returns <code>**1234**</code>
 801 - Example: <code>**%CALC\{"$VALUE(Total: -12.5)"\}%**</code> returns <code>**-12.5**</code>
 802 - Related: <code>[[$EVAL()|Main/WebHome#FuncEVAL]]</code>, <code>[[$INT()|Main/WebHome#FuncINT]]</code>
 803
 804 <a name="FuncWORKINGDAYS"></a>
 805
 806 ### <a name="WORKINGDAYS( serial_1, serial_2"></a><a name="WORKINGDAYS( serial_1, serial_2 "></a> WORKINGDAYS( serial\_1, serial\_2 ) -- working days between two serialized dates
 807
 808 - Working days are Monday through Friday (sorry, Israel!)
 809 - Syntax: <code>**$WORKINGDAYS( serial\_1, serial\_2 )**</code>
 810 - Example: <code>**%CALC\{"$WORKINGDAYS($TIME(2004/07/15), $TIME(2004/08/03))"\}%**</code> returns <code>**13**</code>
 811 - Related: <code>[[$SUMDAYS()|Main/WebHome#FuncSUMDAYS]]</code>, <code>[[$TIME()|Main/WebHome#FuncTIME]]</code>, <code>[[$TIMEDIFF()|Main/WebHome#FuncTIMEDIFF]]</code>
 812
 813 ## <a name="Bug Tracking Example"></a> Bug Tracking Example
 814
 815 <table border="1" cellpadding="0" cellspacing="0">
 816   <tr>
 817     <th bgcolor="#99CCCC"><strong> Bug#: </strong></th>
 818     <th bgcolor="#99CCCC"><strong> Priority: </strong></th>
 819     <th bgcolor="#99CCCC"><strong> Subject: </strong></th>
 820     <th bgcolor="#99CCCC"><strong> Status: </strong></th>
 821     <th bgcolor="#99CCCC"><strong> Days to fix </strong></th>
 822   </tr>
 823   <tr>
 824     <td> Bug:1231 </td>
 825     <td> Low </td>
 826     <td> File Open ... </td>
 827     <td> Open </td>
 828     <td align="right"> 3 </td>
 829   </tr>
 830   <tr>
 831     <td> Bug:1232 </td>
 832     <td> High </td>
 833     <td> Memory Window ... </td>
 834     <td> Fixed </td>
 835     <td align="right"> 2 </td>
 836   </tr>
 837   <tr>
 838     <td> Bug:1233 </td>
 839     <td> Medium </td>
 840     <td> Usability issue ... </td>
 841     <td> Assigned </td>
 842     <td align="right"> 5 </td>
 843   </tr>
 844   <tr>
 845     <td> Bug:1234 </td>
 846     <td> High </td>
 847     <td> No arrange ... </td>
 848     <td> Fixed </td>
 849     <td align="right"> 1 </td>
 850   </tr>
 851   <tr>
 852     <td> Total: 4 </td>
 853     <td> High: 2<br /> Low: 1<br /> Medium: 1 </td>
 854     <td> . </td>
 855     <td> Assigned: 1<br /> Fixed: 2<br /> Open: 1 </td>
 856     <td align="right"> Total: 11 </td>
 857   </tr>
 858 </table>
 859
 860 The last row is defined as:
 861
 862     | Total: %CALC{"$ROW(-2)"}% \
 863       | %CALC{"$COUNTITEMS( R2:C$COLUMN()..R$ROW(-1):C$COLUMN() )"}% | . \
 864       | %CALC{"$COUNTITEMS( R2:C$COLUMN()..R$ROW(-1):C$COLUMN() )"}% \
 865       |  Total: %CALC{"$SUM( R2:C$COLUMN()..R$ROW(-1):C$COLUMN() )"}% |
 866
 867 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.
 868
 869 ## <a name="Plugin Settings"></a> Plugin Settings
 870
 871 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>
 872
 873 - One line description, is shown in the [[TextFormattingRules]] topic:
 874   - Set SHORTDESCRIPTION = Add spreadsheet calculation like `"$SUM( $ABOVE() )"` to tables located in %WIKITOOLNAME% topics.
 875
 876 - Debug plugin: (See output in `data/debug.txt`)
 877   - Set DEBUG = 0
 878
 879 - Do not handle `%CALC{}%` variable in included topic while including topic: (default: 1)
 880   - Set SKIPINCLUDE = 1
 881
 882 - [[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:
 883   - Set DONTSPACE = CodeWarrior, MacDonald, McIntosh, RedHat, SuSE
 884
 885 ## <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
 886
 887 **_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.
 888
 889 - Download the ZIP file from the %TOPIC% home
 890 - Unzip <code>**SpreadSheetPlugin.zip**</code> in your twiki installation directory. Content: <table border="1" cellpadding="0" cellspacing="0">
 891   <tr>
 892     <th bgcolor="#99CCCC"><strong> File: </strong></th>
 893     <th bgcolor="#99CCCC"><strong> Description: </strong></th>
 894   </tr>
 895   <tr>
 896     <td><code><b>data/TWiki/%TOPIC%.txt</b></code></td>
 897     <td> Plugin topic </td>
 898   </tr>
 899   <tr>
 900     <td><code><b>data/TWiki/%TOPIC%.txt,v</b></code></td>
 901     <td> Plugin topic repository </td>
 902   </tr>
 903   <tr>
 904     <td><code><b>lib/TWiki/Plugins/%TOPIC%.pm</b></code></td>
 905     <td> Plugin Perl module </td>
 906   </tr>
 907 </table>
 908 - (Dakar) Visit `configure` in your TWiki installation, and enable the plugin in the \{Plugins\} section.
 909 - Test if the "Total" in the first table in this topic is correct.
 910
 911 ## <a name="Plugin Info"></a> Plugin Info
 912
 913 <table border="1" cellpadding="0" cellspacing="0">
 914   <tr>
 915     <td align="right"> Plugin Author: </td>
 916     <td> TWiki:Main/PeterThoeny </td>
 917   </tr>
 918   <tr>
 919     <td align="right"> Plugin Version: </td>
 920     <td> 17 Jun 2005 (1.018) </td>
 921   </tr>
 922   <tr>
 923     <td align="right"> Change History: </td>
 924     <td>  </td>
 925   </tr>
 926   <tr>
 927     <td align="right"> 17 Jun 2005: </td>
 928     <td> Added $NOEXEC(), $EXEC() </td>
 929   </tr>
 930   <tr>
 931     <td align="right"> 25 Mar 2005: </td>
 932     <td> Fixed evaluation bug when using SpeedyCGI accelerator; code refactor to load module only when needed, contributed by TWiki:Main/CrawfordCurrie </td>
 933   </tr>
 934   <tr>
 935     <td align="right"> 24 Oct 2004: </td>
 936     <td> Added $EXISTS(), contributed by TWiki:Main/RodrigoChandia; added $PERCENTILE() </td>
 937   </tr>
 938   <tr>
 939     <td align="right"> 18 Oct 2004: </td>
 940     <td> Added $LISTJOIN() </td>
 941   </tr>
 942   <tr>
 943     <td align="right"> 26 Sep 2004: </td>
 944     <td> Added $FORMAT(KB), $FORMAT(MB), contributed by TWiki:Main/ArthurClemens; added $FORMAT(KBMB), $EVEN(), $ODD() </td>
 945   </tr>
 946   <tr>
 947     <td align="right"> 17 Jul 2004: </td>
 948     <td> Added $WORKINGDAYS(), contributed by TWiki:Main/CrawfordCurrie </td>
 949   </tr>
 950   <tr>
 951     <td align="right"> 24 May 2004: </td>
 952     <td> Refactored documentation (no code changes) </td>
 953   </tr>
 954   <tr>
 955     <td align="right"> 03 Apr 2004: </td>
 956     <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>
 957   </tr>
 958   <tr>
 959     <td align="right"> 21 Mar 2004: </td>
 960     <td> Added $LISTITEM(); fixed call to unofficial function </td>
 961   </tr>
 962   <tr>
 963     <td align="right"> 16 Mar 2004: </td>
 964     <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>
 965   </tr>
 966   <tr>
 967     <td align="right"> 08 Mar 2004: </td>
 968     <td> Added $LIST() </td>
 969   </tr>
 970   <tr>
 971     <td align="right"> 06 Mar 2004: </td>
 972     <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>
 973   </tr>
 974   <tr>
 975     <td align="right"> 27 Feb 2004: </td>
 976     <td> Added $COUNTUNIQUE() </td>
 977   </tr>
 978   <tr>
 979     <td align="right"> 24 Oct 2003: </td>
 980     <td> Added $SET(), $GET(), $MEDIAN(); added $SUMPRODUCT(), inspired by TWiki:Main/RobertWithrow; added $SUMDAYS(), contributed by TWiki:Main/SvenDowideit </td>
 981   </tr>
 982   <tr>
 983     <td align="right"> 21 Oct 2003: </td>
 984     <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>
 985   </tr>
 986   <tr>
 987     <td align="right"> 14 Oct 2003: </td>
 988     <td> Added $TIME(), $TODAY(), $FORMATTIME(), $FORMATGMTIME(), $TIMEDIFF() </td>
 989   </tr>
 990   <tr>
 991     <td align="right"> 13 Oct 2003: </td>
 992     <td> Added $MULT(), contributed by TWiki:Main/GerritJanBaarda </td>
 993   </tr>
 994   <tr>
 995     <td align="right"> 30 Jul 2003: </td>
 996     <td> Added $TRANSLATE() </td>
 997   </tr>
 998   <tr>
 999     <td align="right"> 19 Jul 2003: </td>
1000     <td> Added $FIND(), $NOP(), $REPLACE(), $SEARCH(), $SUBSTITUTE(), contributed by TWiki:Main/PaulineCheung </td>
1001   </tr>
1002   <tr>
1003     <td align="right"> 19 Apr 2003: </td>
1004     <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>
1005   </tr>
1006   <tr>
1007     <td align="right"> 07 Jun 2002: </td>
1008     <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>
1009   </tr>
1010   <tr>
1011     <td align="right"> 12 Mar 2002: </td>
1012     <td> Support for multiple functions per nesting level </td>
1013   </tr>
1014   <tr>
1015     <td align="right"> 15 Jan 2002: </td>
1016     <td> Added $CHAR(), $CODE() and $LENGTH() </td>
1017   </tr>
1018   <tr>
1019     <td align="right"> 12 Nov 2001: </td>
1020     <td> Added $RIGHT() </td>
1021   </tr>
1022   <tr>
1023     <td align="right"> 12 Aug 2001: </td>
1024     <td> Fixed bug of disappearing multi-column cells </td>
1025   </tr>
1026   <tr>
1027     <td align="right"> 19 Jul 2001: </td>
1028     <td> Fixed incorrect $SUM() calculation of cell with value <code>0</code></td>
1029   </tr>
1030   <tr>
1031     <td align="right"> 14 Jul 2001: </td>
1032     <td> Changed to plug &amp; play </td>
1033   </tr>
1034   <tr>
1035     <td align="right"> 01 Jun 2001: </td>
1036     <td> Fixed insecure dependencies for $MIN() and $MAX() </td>
1037   </tr>
1038   <tr>
1039     <td align="right"> 16 Apr 2001: </td>
1040     <td> Fixed div by 0 bug in $AVERAGE() </td>
1041   </tr>
1042   <tr>
1043     <td align="right"> 17 Mar 2001: </td>
1044     <td> Initial version with $ABOVE(), $AVERAGE(), $COLUMN(), $COUNTITEMS(), $EVAL(), $INT(), $LEFT(), $LOWER(), $MAX(), $MIN(), $ROW(), $SUM(), $T(), $UPPER() </td>
1045   </tr>
1046   <tr>
1047     <td align="right"> CPAN Dependencies: </td>
1048     <td> none </td>
1049   </tr>
1050   <tr>
1051     <td align="right"> TWiki:Plugins/Benchmark: </td>
1052     <td>[[TWiki/GoodStyle]] 99%, [[TWiki/FormattedSearch]] 99%, %TOPIC% 95% </td>
1053   </tr>
1054   <tr>
1055     <td align="right"> Other Dependencies: </td>
1056     <td> none </td>
1057   </tr>
1058   <tr>
1059     <td align="right"> Perl Version: </td>
1060     <td> 5.000 and up </td>
1061   </tr>
1062   <tr>
1063     <td align="right"> Plugin Home: </td>
1064     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
1065   </tr>
1066   <tr>
1067     <td align="right"> Feedback: </td>
1068     <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>
1069   </tr>
1070 </table>
1071
1072 **_Related Topics:_** [[TWikiPreferences]], [[TWikiPlugins]]
1073
1074 -- TWiki:Main/PeterThoeny - 17 Jun 2005