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