---+!! TWiki Spreadsheet Plugin
This plugin adds spreadsheet capabilities to TWiki topics. Functions such as ==%CALCULATE{$INT(7/3)}%== are evaluated at page view time. They can be placed in table cells and outside of tables. In other words, this plugin provides general function evaluation capability, not just classic spreadsheet functions. The plugin currently has
%CALCULATE{$GET(nFunctions)}% functions.
__Interactive example:__
---++ Syntax Rules
This plugin handles the ==%CALC{...}%== and ==%CALCULATE{...}%== variables. Embedded formulas are evaluated as follows:
* Built-in function are of format ==$FUNCNAME(parameters)==
* Functions may be nested, such as ==%CALC{$SUM( R2:C$COLUMN(0)..R$ROW(-1):C$COLUMN(0) )}%==
* Functions are evaluated from left to right, and from inside to outside if nested
* A function parameter can be text, a mathematical formula, a cell address, or a range of cell addresses
* Multiple parameters form a list; they are separated by a comma, followed by optional space, such as ==%CALCULATE{$SUM( 3, 5, 7 )}%==
* A parameter representing a string can optionally be enclosed in triple quotes; quotes are required if the string contains commas, parenthesis or newlines, such as ==%CALCULATE{$SUBSTITUTE('''Good, early morning''', morning, day)}%==
* The =%CALCULATE{...}%= variable may span multiple lines, which is useful to indent nested functions. In case the variable contains newlines, all white space around functions and function parameters is removed. Sample nested formula:
%BR% =%CALCULATE{=
%BR% = $LISTJOIN(=
%BR% = $n,=
%BR% = $LISTEACH(=
%BR% = | $index | $item |,=
%BR% = one, two, three=
%BR% = )=
%BR% = )=
%BR% =}%=
* A table cell can be addressed as ==R1:C1==. Table address matrix:
| ==R1:C1== | ==R1:C2== | ==R1:C3== | ==R1:C4== |
| ==R2:C1== | ==R2:C2== | ==R2:C3== | ==R2:C4== |
* A table cell range is defined by two cell addresses separated by ==".."==, e.g. "row 1 through 20, column 3" is: ==R1:C3..R20:C3==
* Lists can refer to values and/or table cell ranges, such as ==%CALC{$SUM( 3, 5, $T(R1:C7), R1:C11..R1:C15 )}%==
* Functions can only reference cells in the current or preceding row of the current table; they may not reference cells below the current table row
* Functions can also be placed outside of tables; they can reference cells in the preceding table
* Functions can be placed in a %SYSTEMWEB%.FormattedSearch, but the CALCULATE needs to be escaped. Learn how to [[#CalcInFormattedSearch][use a CALCULATE in a formatted search]]
* Plain text can be added, such as ==%CALC{Total: $SUM($ABOVE()) kg}%==
---++ Use CALC or CALCULATE
%ICON{table}% *Use =%CALC{...}%= _in_ table cells:*
%BR% The CALC variable handles all functions, but it gets handled with delay compared to other %SYSTEMWEB%.TWikiVariables: It gets executed after internal variables and plugin variables that use the register tag handler. You may get unexpected results if you nest CALC inside other variables (such as =%INCLUDE{%CALC{...}%}%=) because it does not get evaluated inside-out & left-to-right like ordinary TWiki variables.
%ICON{indexlist}% *Use =%CALCULATE{...}%= _outside_ tables:*
%BR% The CALCULATE variable is handled inside-out & left-to-right like ordinary TWiki variables, but it does __not__ support functions that refer to table cells, such as =$LEFT()= or =$T()=.
---++ Built-in Spreadsheet Plugin Functions
The plugin currently has %CALCULATE{$GET(nFunctions)}% functions. Convention for parameters:
* Required parameters are indicated in ==( bold )==
* Optional parameters are indicated in ==( _bold italic_ )==
#FuncABOVE
---+++ ABOVE( ) -- address range of cells above the current cell
* Syntax: ==$ABOVE( )==
* Example: ==%CALC{$SUM($ABOVE())}%== returns the sum of cells above the current cell
* Related: =[[#FuncLEFT][$LEFT()]]=, =[[#FuncRIGHT][$RIGHT()]]=
#FuncABS
---+++ ABS( num ) -- absolute value of a number
* Syntax: ==$ABS( num )==
* Example: ==%CALCULATE{$ABS(-12.5)}%== returns ==12.5==
* Related: =[[#FuncSIGN][$SIGN()]]=, =[[#FuncEVEN][$EVEN()]]=, =[[#FuncISDIGIT][$ISDIGIT()]]=, =[[#FuncODD][$ODD()]]=
#FuncADDLIST
---+++ ADDLIST( name, list ) -- append a list to a list variable
* Specify the variable name (alphanumeric characters and underscores) and the list to add. If the named list does not exist it will be created. Useful in a %SYSTEMWEB%.FormattedSearch to add items to a list. This function returns no output. Use =$GETLIST()= to retrieve a list variable.
* Syntax: ==$ADDLIST( name, list )==
* Example:
%BR% ==%CALCULATE{$SETLIST(nums, 0, 1, 2, 3)}%== sets the =nums= variable to =0, 1, 2, 3=
%BR% ==%CALCULATE{$ADDLIST(nums, 4, 5, 6, 7)}%== adds =4, 5, 6, 7= to the =nums= variable
%BR% ==%CALCULATE{$GETLIST(nums)}%== returns =0, 1, 2, 3, 4, 5, 6, 7=
* Example formatted search:
%BR% ==format="$percntCALCULATE{$ADDLIST(topics, $topic)}$percnt"== in each search hit, adds the topic name to the =topics= list variable
* Related: =[[#FuncGETLIST][$GETLIST()]]=, =[[#FuncSET][$SET()]]=, =[[#FuncSETHASH][$SETHASH()]]=, =[[#FuncSETLIST][$SETLIST()]]=
#FuncAND
---+++ AND( list ) -- logical AND of a list
* Syntax: ==$AND( list )==
* Example: ==%CALCULATE{$AND(1, 0, 1)}%== returns ==0==
* Related: =[[#FuncNOT][$NOT()]]=, =[[#FuncIF][$IF()]]=, =[[#FuncOR][$OR()]]=, =[[#FuncWHILE][$WHILE()]]=, =[[#FuncXOR][$XOR()]]=
#FuncAVERAGE
---+++ AVERAGE( list ) -- average of a list or a range of cells
* Syntax: ==$AVERAGE( list )==
* Example: ==%CALC{$AVERAGE(R2:C5..R$ROW(-1):C5)}%== returns the average of column 5, excluding the title row
* Related: =[[#FuncLIST][$LIST()]]=, =[[#FuncMAX][$MAX()]]=, =[[#FuncMEDIAN][$MEDIAN()]]=, =[[#FuncMIN][$MIN()]]=, =[[#FuncSTDEV][$STDEV()]]=, =[[#FuncSTDEVP][$STDEVP()]]=, =[[#FuncVAR][$VAR()]]=, =[[#FuncVARP][$VARP()]]=
#FuncBIN2DEC
---+++ !BIN2DEC( num ) -- convert a binary number to decimal
* Syntax: ==$BIN2DEC( num )==
* Example: ==%CALCULATE{$BIN2DEC(1100100)}%== returns ==100==
* Related: =[[#FuncDEC2BIN][$DEC2BIN()]]=, =[[#FuncDEC2HEX][$DEC2HEX()]]=, =[[#FuncDEC2OCT][$DEC2OCT()]]=, =[[#FuncHEX2DEC][$HEX2DEC()]]=, =[[#FuncHEXDECODE][$HEXDECODE()]]=, =[[#FuncHEXENCODE][$HEXENCODE()]]=, =[[#FuncOCT2DEC][$OCT2DEC()]]=
#FuncBITXOR
---+++ BITXOR( text ) -- bit-wise XOR of text
* Each bit of each character of =text= is flipped, useful to obfuscate text. Bit-XORing text twice will restore the original text.
* Syntax: ==$BITXOR( text )==
* Example: ==%CALCULATE{$BITXOR(A123)}%== returns ==¾ÎÍÌ==
* Example: ==%CALCULATE{$BITXOR($BITXOR(anything))}%== returns ==anything==
* Related: =[[#FuncHEXDECODE][$HEXDECODE()]]=, =[[#FuncHEXENCODE][$HEXENCODE()]]=, =[[#FuncLEFTTRING][$LEFTSTRING()]]=, =[[#FuncRANDSTRING][$RANDSTRING()]]=, =[[#FuncREPLACE][$REPLACE()]]=, =[[#FuncRIGHTSTRING][$RIGHTSTRING()]]=, =[[#FuncSUBSTITUTE][$SUBSTITUTE()]]=, =[[#FuncTRANSLATE][$TRANSLATE()]]=, =[[#FuncXOR][$XOR()]]=
#FuncCEILING
---+++ CEILING( num ) -- return the smallest integer following a number
* The ceiling(x) is the smallest integer not less than x
* Use =$INT()= to truncate a number towards zero; use =$FLOOR()= to get the largest previous integer
* Syntax: ==$CEILING( num )==
* Example: ==%CALCULATE{$CEILING(5.4)}%== returns ==6==
* Example: ==%CALCULATE{$CEILING(-5.4)}%== returns ==-5==
* Related: =[[#FuncEVAL][$EVAL()]]=, =[[#FuncFLOOR][$FLOOR()]]=, =[[#FuncINT][$INT()]]=, =[[#FuncROUND][$ROUND()]]=, =[[#FuncVALUE][$VALUE()]]=
#FuncCHAR
---+++ CHAR( number ) -- ASCII character represented by number
* Syntax: ==$CHAR( number )==
* Example: Example: ==%CALCULATE{$CHAR(97)}%== returns ==a==
* Related: =[[#FuncCODE][$CODE()]]=
#FuncCODE
---+++ CODE( text ) -- ASCII numeric value of character
* The ASCII numeric value of the first character in text
* Syntax: ==$CODE( text )==
* Example: ==%CALCULATE{$CODE(abc)}%== returns ==97==
* Related: =[[#FuncCHAR][$CHAR()]]=
#FuncCOLUMN
---+++ COLUMN( offset ) -- current column number
* The current table column number with an optional offset. When used outside of a table it returns the number of columns of the preceding table.
* Syntax: ==$COLUMN( _offset_ )==
* Example: ==%CALC{$COLUMN()}%== returns ==2== for the second column
* Related: =[[#FuncROW][$ROW()]]=, =[[#FuncT][$T()]]=
#FuncCOUNTITEMS
---+++ COUNTITEMS( list ) -- count individual items in a list
* Syntax: ==$COUNTITEMS( list )==
* Example: ==%CALC{$COUNTITEMS($ABOVE())}%== returns ==Closed: 1, Open: 2== assuming one cell above the current cell contains ==Closed== and two cells contain ==Open==
* Related: =[[#FuncCOUNTSTR][$COUNTSTR()]]=, =[[#FuncLIST][$LIST()]]=, =[[#FuncSETMHASH][$SETMHASH()]]=, =[[#FuncWHILE][$WHILE()]]=
#FuncCOUNTSTR
---+++ COUNTSTR( list, str ) -- count the number of cells!! in a list equal to a given string
* 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
* Syntax: ==$COUNTSTR( list, _str_ )==
* Example: ==%CALC{$COUNTSTR($ABOVE())}%== counts the number of non empty cells above the current cell
* Example: ==%CALC{$COUNTSTR($ABOVE(), DONE)}%== counts the number of cells equal to ==DONE==
* Related: =[[#FuncCOUNTITEMS][$COUNTITEMS()]]=, =[[#FuncLIST][$LIST()]]=, =[[#FuncSETMHASH][$SETMHASH()]]=, =[[#FuncWHILE][$WHILE()]]=
#FuncDEC2BIN
---+++ !DEC2BIN( num, width ) -- convert a decimal number to binary
* Syntax: ==$DEC2BIN( num, _width_ )==
* Example: ==%CALCULATE{$DEC2BIN(100)}%== returns ==1100100==
* Example: ==%CALCULATE{$DEC2BIN(9, 6)}%== returns ==001001==
* Related: =[[#FuncBIN2DEC][$BIN2DEC()]]=, =[[#FuncDEC2HEX][$DEC2HEX()]]=, =[[#FuncDEC2OCT][$DEC2OCT()]]=, =[[#FuncHEX2DEC][$HEX2DEC()]]=, =[[#FuncHEXDECODE][$HEXDECODE()]]=, =[[#FuncHEXENCODE][$HEXENCODE()]]=, =[[#FuncOCT2DEC][$OCT2DEC()]]=
#FuncDEC2HEX
---+++ !DEC2HEX( num, width ) -- convert a decimal number to hexadecimal
* Syntax: ==$DEC2HEX( num, _width_ )==
* Example: ==%CALCULATE{$DEC2HEX(165)}%== returns ==A5==
* Example: ==%CALCULATE{$DEC2HEX(100, 4)}%== returns ==0064==
* Related: =[[#FuncBIN2DEC][$BIN2DEC()]]=, =[[#FuncDEC2BIN][$DEC2BIN()]]=, =[[#FuncDEC2OCT][$DEC2OCT()]]=, =[[#FuncHEX2DEC][$HEX2DEC()]]=, =[[#FuncHEXDECODE][$HEXDECODE()]]=, =[[#FuncHEXENCODE][$HEXENCODE()]]=, =[[#FuncOCT2DEC][$OCT2DEC()]]=
#FuncDEC2OCT
---+++ !DEC2OCT( num, width ) -- convert a decimal number to octal
* Syntax: ==$DEC2OCT( num, _width_ )==
* Example: ==%CALCULATE{$DEC2OCT(58)}%== returns ==72==
* Example: ==%CALCULATE{$DEC2OCT(58, 4)}%== returns ==0072==
* Related: =[[#FuncBIN2DEC][$BIN2DEC()]]=, =[[#FuncDEC2BIN][$DEC2BIN()]]=, =[[#FuncDEC2HEX][$DEC2HEX()]]=, =[[#FuncHEX2DEC][$HEX2DEC()]]=, =[[#FuncHEXDECODE][$HEXDECODE()]]=, =[[#FuncHEXENCODE][$HEXENCODE()]]=, =[[#FuncOCT2DEC][$OCT2DEC()]]=
#FuncDEF
---+++ DEF( list ) -- find first non-empty list item or cell
* Returns the first list item or cell reference that is not empty
* Syntax: ==$DEF( list )==
* Example: ==%CALC{$DEF(R1:C1..R1:C3)}%==
* Related: =[[#FuncCOUNTSTR][$COUNTSTR()]]=, =[[#FuncLISTIF][$LISTIF()]]=, =[[#FuncLIST][$LIST()]]=
#FuncEMPTY
---+++ EMPTY( text ) -- test for empty text
* Returns ==1== if =text= is empty, or ==0== if not
* Syntax: ==$EMPTY( _text_ )==
* Example: ==%CALCULATE{$EMPTY(foo)}%== returns ==0==
* Example: ==%CALCULATE{$EMPTY()}%== returns ==1==
* Example: ==%CALCULATE{$EMPTY($TRIM( ))}%== returns ==1==
* Related: =[[#FuncEQUAL][$EQUAL()]]=, =[[#FuncEXACT][$EXACT()]]=, =[[#FuncIF][$IF()]]=, =[[#FuncISDIGIT][$ISDIGIT()]]=, =[[#FuncISLOWER][$ISLOWER()]]=, =[[#FuncISUPPER][$ISUPPER()]]=, =[[#FuncISWIKIWORD][$ISWIKIWORD()]]=, =[[#FuncTRIM][$TRIM()]]=, =[[#FuncWHILE][$WHILE()]]=
#FuncEQUAL
---+++ EQUAL( text1, text2 ) -- compare two text strings, case-insensitive
* Compares two text strings and returns ==1== if they are the same ignoring the case, or ==0== if not; use =$EXACT()= for case-sensitive compare
* Syntax: ==$EQUAL( text1, _text2_ )==
* Example: ==%CALCULATE{$EQUAL(foo, Foo)}%== returns ==1==
* Related: =[[#FuncEMPTY][$EMPTY()]]=, =[[#FuncEXACT][$EXACT()]]=, =[[#FuncIF][$IF()]]=, =[[#FuncISDIGIT][$ISDIGIT()]]=, =[[#FuncISLOWER][$ISLOWER()]]=, =[[#FuncISUPPER][$ISUPPER()]]=, =[[#FuncISWIKIWORD][$ISWIKIWORD()]]=, =[[#FuncTRIM][$TRIM()]]=
#FuncEVAL
---+++ EVAL( formula ) -- evaluate a simple mathematical formula
* Addition, substraction, multiplication, division and modulus of numbers are supported. Any nesting is permitted
* Numbers may be decimal integers (=1234=), binary integers (=0b1110011=), octal integers (=01234=), hexadecimal integers (=0x1234=) or of exponential notation (=12.34e-56=)
* Syntax: ==$EVAL( formula )==
* Example: ==%CALCULATE{$EVAL( (5 * 3) / 2 + 1.1 )}%== returns ==8.6==
* Related: =[[#FuncCEILING][$CEILING()]]=, =[[#FuncEXEC][$EXEC()]]=, =[[#FuncFLOOR][$FLOOR()]]=, =[[#FuncINT][$INT()]]=, =[[#FuncMOD][$MOD()]]=, =[[#FuncROUND][$ROUND()]]=, =[[#FuncVALUE][$VALUE()]]=
#FuncEVEN
---+++ EVEN( num ) -- test for even number
* Syntax: ==$EVEN( num )==
* Example: ==%CALCULATE{$EVEN(2)}%== returns ==1==
* Related: =[[#FuncABS][$ABS()]]=, =[[#FuncISDIGIT][$ISDIGIT()]]=, =[[#FuncMOD][$MOD()]]=, =[[#FuncODD][$ODD()]]=, =[[#FuncSIGN][$SIGN()]]=
#FuncEXACT
---+++ EXACT( text1, text2 ) -- compare two text strings, case-sensitive
* Compares two text strings and returns ==1== if they are exactly the same, or ==0== if not; use =$EQUAL()= for case-insensitive compare
* Syntax: ==$EXACT( text1, _text2_ )==
* Example: ==%CALCULATE{$EXACT(foo, Foo)}%== returns ==0==
* Example: ==%CALCULATE{$EXACT(foo, $LOWER(Foo))}%== returns ==1==
* Related: =[[#FuncEMPTY][$EMPTY()]]=, =[[#FuncIF][$IF()]]=, =[[#FuncISDIGIT][$ISDIGIT()]]=, =[[#FuncISLOWER][$ISLOWER()]]=, =[[#FuncISUPPER][$ISUPPER()]]=, =[[#FuncISWIKIWORD][$ISWIKIWORD()]]=, =[[#FuncTRIM][$TRIM()]]=
#FuncEXEC
---+++ EXEC( formula ) -- execute a spreadsheet formula
* 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.
* Syntax: ==$EXEC( formula )==
* Example: ==%CALCULATE{$SET(msg, $NOEXEC(Hi $GET(name)))}%== sets the =msg= variable with raw formula =Hi $GET(name)=
* Example: ==%CALCULATE{$SET(name, Tom) $EXEC($GET(msg))}%== executes content of =msg= variable and returns =Hi Tom=
* Example: ==%CALCULATE{$SET(name, Jerry) $EXEC($GET(msg))}%== returns =Hi Jerry=
* Related: =[[#FuncEVAL][$EVAL()]]=, =[[#FuncGET][$GET()]]=, =[[#FuncNOEXEC][$NOEXEC()]]=, =[[#FuncSET][$SET()]]=
#FuncEXISTS
---+++ EXISTS( topic ) -- check if topic exists
* Topic can be =TopicName= or a =Web.TopicName=. Current web is used if web is not specified.
* Syntax: ==$EXISTS( topic )==
* Example: ==%CALCULATE{$EXISTS(%HOMETOPIC%)}%== returns ==1==
* Example: ==%CALCULATE{$EXISTS(ThisDoesNotExist)}%== returns ==0==
* Related: =[[#FuncEQUAL][$EQUAL()]]=, =[[#FuncEXACT][$EXACT()]]=, =[[#FuncIF][$IF()]]=, =[[#FuncISWIKIWORD][$ISWIKIWORD()]]=, =[[#FuncTRIM][$TRIM()]]=
#FuncEXP
---+++ EXP( num ) -- exponent (e) raised to the power of a number
* EXP is the inverse of the LN function
* Syntax: ==$EXP( num )==
* Example: ==%CALCULATE{$EXP(1)}%== returns ==2.71828182845905==
* Related: =[[#FuncLN][$LN()]]=, =[[#FuncLOG][$LOG()]]=
#FuncFILTER
---+++ FILTER( expression, text ) -- filter out characters from text
* Remove characters from a =text= string. The filter is applied multiple times.
* The =expression= can be a sequence of characters or a %SYSTEMWEB%.RegularExpression. Use tokens in the =expression= if needed: =$comma= for comma, =$sp= for space. The =text= may contain commas.
* Syntax: ==$FILTER( chars, text )==
* Example: ==%CALCULATE{$FILTER(f, fluffy)}%== returns ==luy== - filter out a character multiple times
* Example: ==%CALCULATE{$FILTER(an Franc, San Francisco)}%== returns ==Sisco== - cut a string
* Example: ==%CALCULATE{$FILTER($sp, Cat and Mouse)}%== returns ==CatandMouse== - remove all spaces
* Example: ==%CALCULATE{$FILTER([^0-9], Project-ID-1234)}%== returns ==1234== - filter in digits, e.g. keep only digits
* Example: ==%CALCULATE{$FILTER([^a-zA-Z0-9 ], Stupid mistake*%@^! Fixed)}%== returns ==Stupid mistake Fixed== - keep only alphanumeric characters and spaces
* Example: ==%CALCULATE{$FILTER([^a-zA-Z0-9], $PROPER(an EXELLENT idea.))}%== returns ==AnExcellentIdea== - turn a string into a %SYSTEMWEB%.WikiWord topic name
* Related: =[[#FuncFIND][$FIND()]]=, =[[#FuncINSERTSTRING][$INSERTSTRING()]]=, =[[#FuncLEFTSTRING][$LEFTSTRING()]]=, =[[#FuncPROPER][$PROPER()]]=, =[[#FuncREPLACE][$REPLACE()]]=, =[[#FuncRIGHTSTRING][$RIGHTSTRING()]]=, =[[#FuncSEARCH][$SEARCH()]]=, =[[#FuncSUBSTITUTE][$SUBSTITUTE()]]=, =[[#FuncSUBSTRING][$SUBSTRING()]]=, =[[#FuncTRANSLATE][$TRANSLATE()]]=, =[[#FuncTRIM][$TRIM()]]=
#FuncFIND
---+++ FIND( string, text, start ) -- find one string within another string
* 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.
* Syntax: ==$FIND( string, text, _start_ )==
* Example: ==%CALCULATE{$FIND(f, fluffy)}%== returns ==1==
* Example: ==%CALCULATE{$FIND(f, fluffy, 2)}%== returns ==4==
* Example: ==%CALCULATE{$FIND(@, fluffy, 1)}%== returns ==0==
* Related: =[[#FuncFILTER][$FILTER()]]=, =[[#FuncINSERTSTRING][$INSERTSTRING()]]=, =[[#FuncLEFTSTRING][$LEFTSTRING()]]=, =[[#FuncREPLACE][$REPLACE()]]=, =[[#FuncRIGHTSTRING][$RIGHTSTRING()]]=, =[[#FuncSUBSTITUTE][$SUBSTITUTE()]]=, =[[#FuncSUBSTRING][$SUBSTRING()]]=, =[[#FuncSEARCH][$SEARCH()]]=
#FuncFLOOR
---+++ FLOOR( num ) -- return the largest integer preceding a number
* The floor(x) is the largest integer not greater than x
* Use =$INT()= to truncate a number towards zero; use =$CEILING()= to get the smallest following integer
* Syntax: ==$FLOOR( num )==
* Example: ==%CALCULATE{$FLOOR(5.4)}%== returns ==5==
* Example: ==%CALCULATE{$FLOOR(-5.4)}%== returns ==-6==
* Related: =[[#FuncCEILING][$CEILING()]]=, =[[#FuncEVAL][$EVAL()]]=, =[[#FuncINT][$INT()]]=, =[[#FuncROUND][$ROUND()]]=, =[[#FuncVALUE][$VALUE()]]=
#FuncFORMAT
---+++ FORMAT( type, precision, number ) -- format a number!! to a certain type and precision
* Supported =type=:
* =COMMA= for comma format, such as =12,345.68=
* =CURRENCY= for currency format, such as =€12,345.68=
* Negative numbers are shown in parenthesis, such as =(€6,789.00)= for =-6789=
* The currency symbol is taken from the CURRENCYSYMBOL preferences setting, such as =US$= or =$= for Dollar, =€= for Euro, =¥= for Yen, default =$=
* =DOLLAR= for Dollar format, such as =$12,345.68=
* Negative numbers are shown in parenthesis, such as =($6,789.00)= for =-6789=
* =KB= for Kilo Byte format, such as =1205.63 KB=
* =MB= for Mega Byte format, such as =1.18 MB=
* =KBMB= for Kilo/Mega/Giga/Tera Byte auto-adjust format
* =NUMBER= for number, such as =12345.7=
* =PERCENT= for percent format, such as =12.3%=
* The =precision= indicates the the number of digits after the dot
* Syntax: ==$FORMAT( type, prec, number )==
* Example: ==%CALCULATE{$FORMAT(COMMA, 2, 12345.6789)}%== returns ==12,345.68==
* Example: ==%CALCULATE{$FORMAT(CURRENCY, 2, 12345.6789)}%== returns ==$12,345.68==
* Example: ==%CALCULATE{$FORMAT(DOLLAR, 2, 12345.6789)}%== returns ==$12,345.68==
* Example: ==%CALCULATE{$FORMAT(KB, 2, 1234567)}%== returns ==1205.63 KB==
* Example: ==%CALCULATE{$FORMAT(MB, 2, 1234567)}%== returns ==1.18 MB==
* Example: ==%CALCULATE{$FORMAT(KBMB, 2, 1234567)}%== returns ==1.18 MB==
* Example: ==%CALCULATE{$FORMAT(KBMB, 2, 1234567890)}%== returns ==1.15 GB==
* Example: ==%CALCULATE{$FORMAT(NUMBER, 1, 12345.67)}%== returns ==12345.7==
* Example: ==%CALCULATE{$FORMAT(PERCENT, 1, 0.1234567)}%== returns ==12.3%==
* Related: =[[#FuncFORMATTIME][$FORMATTIME()]]=, =[[#FuncFORMATTIMEDIFF][$FORMATTIMEDIFF()]]=, =[[#FuncROUND][$ROUND()]]=
#FuncFORMATGMTIME
---+++ FORMATGMTIME( serial, text ) -- convert a serialized date!! into a GMT date string
* The date string represents the time in Greenwich time zone. Same variable expansion as in =$FORMATTIME()=.
* Syntax: ==$FORMATGMTIME( serial, text )==
* Example: ==%CALCULATE{$FORMATGMTIME(1041379200, $day $mon $year)}%== returns ==01 Jan 2003==
* Related: =[[#FuncFORMATTIME][$FORMATTIME()]]=, =[[#FuncFORMATTIMEDIFF][$FORMATTIMEDIFF()]]=, =[[#FuncTIME][$TIME()]]=, =[[#FuncTIMEADD][$TIMEADD()]]=, =[[#FuncTIMEDIFF][$TIMEDIFF()]]=, =[[#FuncTODAY][$TODAY()]]=
#FuncFORMATTIME
---+++ FORMATTIME( serial, text ) -- convert a serialized date!! into a date string
* 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
* =$isoweek= - ISO 8601 week number, one or two digits, 1..53
* =$isoweek(format)= - formatted [[http://en.wikipedia.org/wiki/ISO_8601#Week_dates][ISO 8601 week number]]. These variables are expanded in =format=:
* =$isoweek($year)= - year of ISO 8601 week number, such as =2009= for 2010-01-03
* =$isoweek($wk)= - 2 digit ISO 8601 week number, such as =53= for 2010-01-03
* =$isoweek($day)= - day of ISO 8601 week number, starting with 1 for Monday, such as =7= for 2010-01-03
* =$isoweek($iso)= - full year-week ISO week number, such as =2009-W53= for 2010-01-03
* =$isoweek($yearW$wk$day)= - full year-week-day ISO week number, such as =2009W537= for 2010-01-03
* =$isoweek($year-W$wk-$day)= - full year-week-day ISO week number, such as =2009-W53-7= for 2010-01-03
* =$isoweek($year-W$wk)= - year-week ISO 8601 week number, such as =2009-W53= for 2010-01-03
* Date is assumed to be server time; add =GMT= to =text= to indicate Greenwich time zone, or use =$FORMATGMTIME()=.
* Syntax: ==$FORMATTIME( serial, text )==
* Example: ==%CALCULATE{$FORMATTIME(0, $year/$month/$day GMT)}%== returns ==1970/01/01 GMT==
* Related: =[[#FuncFORMATGMTIME][$FORMATGMTIME()]]=, =[[#FuncTIME][$TIME()]]=, =[[#FuncFORMATTIMEDIFF][$FORMATTIMEDIFF()]]=, =[[#FuncTIMEADD][$TIMEADD()]]=, =[[#FuncTIMEDIFF][$TIMEDIFF()]]=, =[[#FuncTODAY][$TODAY()]]=
#FuncFORMATTIMEDIFF
---+++ FORMATTIMEDIFF( unit, precision, time, option ) -- convert elapsed time!! to a string
* Convert elapsed =time= to a human readable format, such as: =12 hours and 3 minutes=
* The input =unit= can be =second=, =minute=, =hour=, =day=, =month=, =year=. Note: An approximation is used for month and year calculations.
* The =precision= indicates the number of output units to use
* The =option= determines the format:
* not specified - standard format, such as: =12 hours and 3 minutes=
* =s= - short format, such as: =12 h, 3 min=
* =c= - compact format, such as: =12h 3m=
* Syntax: ==$FORMATTIMEDIFF( unit, precision, time, _option_ )==
* Example: ==%CALCULATE{$FORMATTIMEDIFF(min, 1, 200)}%== returns ==3 hours==
* Example: ==%CALCULATE{$FORMATTIMEDIFF(min, 2, 200)}%== returns ==3 hours and 20 minutes==
* Example: ==%CALCULATE{$FORMATTIMEDIFF(min, 2, 200, s)}%== returns ==3 h, 20 min==
* Example: ==%CALCULATE{$FORMATTIMEDIFF(min, 1, 1640)}%== returns ==1 day==
* Example: ==%CALCULATE{$FORMATTIMEDIFF(min, 2, 1640)}%== returns ==1 day and 3 hours==
* Example: ==%CALCULATE{$FORMATTIMEDIFF(min, 3, 1640)}%== returns ==1 day, 3 hours and 20 minutes==
* Related: =[[#FuncFORMATTIME][$FORMATTIME()]]=, =[[#FuncTIME][$TIME()]]=, =[[#FuncTIMEADD][$TIMEADD()]]=, =[[#FuncTIMEDIFF][$TIMEDIFF()]]=
#FuncGET
---+++ GET( name ) -- get the value of a variable
* 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.
* Syntax: ==$GET( name )==
* Example: ==%CALCULATE{$GET(my_total)}%== returns the value of the =my_total= variable
* Related: =[[#FuncEXEC][$EXEC()]]=, =[[#FuncGETHASH][$GETHASH()]]=, =[[#FuncGETLIST][$GETLIST()]]=, =[[#FuncLIST2HASH][$LIST2HASH()]]=, =[[#FuncHASH2LIST][$HASH2LIST()]]=, =[[#FuncNOEXEC][$NOEXEC()]]=, =[[#FuncSET][$SET()]]=, =[[#FuncSETHASH][$SETHASH()]]=, =[[#FuncSETIFEMPTY][$SETIFEMPTY()]]=, =[[#FuncSETM][$SETM()]]=, =[[#FuncSETMHASH][$SETMHASH()]]=, =[[#FuncWHILE][$WHILE()]]=, %SYSTEMWEB%.SetGetPlugin
#FuncGETHASH
---+++ GETHASH( name, key ) -- get the value of a previously set hash key
* Specify the hash name and key; allowed characters for the hash name are alphanumeric characters, underscores and period. An empty string is returned if the hash key does not exist. Use =$SETHASH()= or =$LIST2HASH()= to set a hash. If the key is omitted, a list of all keys of the named hash is returned. If no parameters are specified, a list of all hash names is returned.
* Syntax: ==$GETHASH( _name_, _key_ )==
* Examples: %BR% ==%CALCULATE{$SETHASH(age, Jane, 26)}%== %BR% ==%CALCULATE{$SETHASH(age, Tim, 27)}%== %BR% ==%CALCULATE{$GETHASH(age, Jane)}%== returns =26= %BR% ==%CALCULATE{$GETHASH(age)}%== returns =Jane, Tim= %BR% ==%CALCULATE{$GETHASH()}%== returns =age=
* Related: =[[#FuncGET][$GET()]]=, =[[#FuncGETLIST][$GETLIST()]]=, =[[#FuncHASH2LIST][$HASH2LIST()]]=, =[[#FuncHASHCOPY][$HASHCOPY()]]=, =[[#FuncHASHEACH][$HASHEACH()]]=, =[[#FuncHASHEXISTS][$HASHEXISTS()]]=, =[[#FuncHASHREVERSE][$HASHREVERSE()]]=, =[[#FuncLIST2HASH][$LIST2HASH()]]=, =[[#FuncSET][$SET()]]=, =[[#FuncSETHASH][$SETHASH()]]=, =[[#FuncSETMHASH][$SETMHASH()]]=
#FuncGETLIST
---+++ GETLIST( name ) -- get the list from a list variable
* Specify the variable name (alphanumeric characters and underscores). An empty list is returned if the variable does not exist. Use =$SETLIST()= or =$ADDLIST()= to set a variable.
* Syntax: ==$GETLIST( name )==
* Example: ==%CALCULATE{$GETLIST(nums)}%== returns the value of the =nums= variable
* Related: =[[#FuncADDLIST][$ADDLIST()]]=, =[[#FuncGET][$GET()]]=, =[[#FuncGETHASH][$GETHASH()]]=, =[[#FuncSETLIST][$SETLIST()]]=, %SYSTEMWEB%.SetGetPlugin
#FuncHASH2LIST
---+++ !HASH2LIST( name, format ) -- convert a hash to a list
* Specify the hash name and optionally the format of a key/value pair. Default format is =$key$comma $value=, e.g. key & value in list format; =$key= indicates the key, =$comma= a comma, and =$value= the value. Keep in mind that you will get unexpected results if keys or values contain commas. Use =$SETHASH()= or =$LIST2HASH()= to set a hash.
* Syntax: ==$HASH2LIST( name, _format_ )==
* Examples: %BR% ==%CALCULATE{$LIST2HASH(age, Jane, 26, Tim, 27)}%== %BR% ==%CALCULATE{$HASH2LIST(age)}%== returns =Jane, 26, Tim, 27= %BR% ==%CALCULATE{$HASH2LIST(age, $key is $value)}%== returns =Jane is 26, Tim is 27= %BR% ==%CALCULATE{$HASH2LIST(age, $key)}%== returns =Jane, Tim= %BR% ==%CALCULATE{$HASH2LIST(age, $value)}%== returns =26, 27=
* Related: =[[#FuncGETHASH][$GETHASH()]]=, =[[#FuncHASHCOPY][$HASHCOPY()]]=, =[[#FuncHASHEACH][$HASHEACH()]]=, =[[#FuncHASHEXISTS][$HASHEXISTS()]]=, =[[#FuncHASHREVERSE][$HASHREVERSE()]]=, =[[#FuncLIST2HASH][$LIST2HASH()]]=, =[[#FuncSET][$SET()]]=, =[[#FuncSETHASH][$SETHASH()]]=, =[[#FuncSETMHASH][$SETMHASH()]]=
#FuncHASHCOPY
---+++ HASHCOPY( from, to ) -- copy a hash
* Copy (duplicate) a hash. This function returns no output.
* Syntax: ==$HASHCOPY( from, to )==
* Examples: %BR% ==%CALCULATE{$LIST2HASH(age, Jane, 26, Tim, 27, Sam, 28)}%== %BR% ==%CALCULATE{$HASHCOPY(age, new)}%== creates new hash =new= from hash =age= %BR% ==%CALCULATE{$HASH2LIST(new, $key: $value)}%== returns =Jane: 26, Sam: 28, Tim: 27=
* Related: =[[#FuncGETHASH][$GETHASH()]]=, =[[#FuncHASH2LIST][$HASH2LIST()]]=, =[[#FuncHASHCOPY][$HASHCOPY()]]=, =[[#FuncHASHEACH][$HASHEACH()]]=, =[[#FuncHASHEXISTS][$HASHEXISTS()]]=, =[[#FuncHASHREVERSE][$HASHREVERSE()]]=, =[[#FuncLIST2HASH][$LIST2HASH()]]=, =[[#FuncSETHASH][$SETHASH()]]=, =[[#FuncSETMHASH][$SETMHASH()]]=
#FuncHASHEACH
---+++ HASHEACH( formula, name ) -- evaluate and update each hash element
* Specify a formula that is applied to each named hash element. In the formula, =$key= indicates the key, =$value= the value, and =$index= the index of the sorted key list, starting at 1. If =$value= is omitted, the item is appended to the formula. This function returns no output.
* Syntax: ==$HASHEACH( formula, name )==
* Example: %BR% ==%CALCULATE{$LIST2HASH(age, Jane, 26, Tim, 27)}%== %BR% ==%CALCULATE{$HASHEACH($INT($value + 2), age)}%== adds 2 years to each person %BR% ==%CALCULATE{$HASH2LIST(age, $key is now $value)}%== returns =Jane is now 28, Tim is now 29=
* Related: =[[#FuncCOUNTITEMS][$COUNTITEMS()]]=, =[[#FuncCOUNTSTR][$COUNTSTR()]]=, =[[#FuncGETHASH][$GETHASH()]]=, =[[#FuncHASH2LIST][$HASH2LIST()]]=, =[[#FuncHASHCOPY][$HASHCOPY()]]=, =[[#FuncHASHEXISTS][$HASHEXISTS()]]=, =[[#FuncHASHREVERSE][$HASHREVERSE()]]=, =[[#FuncLIST2HASH][$LIST2HASH()]]=, =[[#FuncLISTEACH][$LISTEACH()]]=, =[[#FuncSETHASH][$SETHASH()]]=, =[[#FuncSETMHASH][$SETMHASH()]]=
#FuncHASHEXISTS
---+++ HASHEXISTS( name, key ) -- test if a hash exists
* Test if a key exists by specifying the hash name and the key. Test if a hash exists by specifying the hash name.
* Syntax: ==$HASHEXISTS( name, _key_ )==
* Examples: %BR% ==%CALCULATE{$LIST2HASH(age, Jane, 26, Tim, 27)}%== %BR% ==%CALCULATE{$HASHEXISTS(age)}%== returns =1= %BR% ==%CALCULATE{$HASHEXISTS(age, Jane)}%== returns =1= %BR% ==%CALCULATE{$HASHEXISTS(age, Blake)}%== returns =0= %BR% ==%CALCULATE{$HASHEXISTS(height)}%== returns =0=
* Related: =[[#FuncGETHASH][$GETHASH()]]=, =[[#FuncHASH2LIST][$HASH2LIST()]]=, =[[#FuncHASHCOPY][$HASHCOPY()]]=, =[[#FuncHASHEACH][$HASHEACH()]]=, =[[#FuncHASHREVERSE][$HASHREVERSE()]]=, =[[#FuncLIST2HASH][$LIST2HASH()]]=, =[[#FuncSETHASH][$SETHASH()]]=, =[[#FuncSETMHASH][$SETMHASH()]]=
#FuncHASHREVERSE
---+++ HASHREVERSE( name ) -- reverse a hash
* All keys of a hash become values, and vice versa. Hash keys are always unique, e.g. multiple identical values will be reduced to one key. This function returns no output.
* Syntax: ==$HASHREVERSE( name )==
* Examples: %BR% ==%CALCULATE{$LIST2HASH(age, Jane, 26, Tim, 27, Sam, 28)}%== %BR% ==%CALCULATE{$HASHREVERSE(age)}%== reverses the hash and returns nothing %BR% ==%CALCULATE{$HASH2LIST(age, $key: $value)}%== returns =26: Jane, 27: Tim, 28: Sam=
* Related: =[[#FuncGETHASH][$GETHASH()]]=, =[[#FuncHASH2LIST][$HASH2LIST()]]=, =[[#FuncHASHCOPY][$HASHCOPY()]]=, =[[#FuncHASHEACH][$HASHEACH()]]=, =[[#FuncHASHEXISTS][$HASHEXISTS()]]=, =[[#FuncLIST2HASH][$LIST2HASH()]]=, =[[#FuncSETHASH][$SETHASH()]]=, =[[#FuncSETMHASH][$SETMHASH()]]=
#FuncHEX2DEC
---+++ !HEX2DEC( num ) -- convert a hexadecimal number to decimal
* Syntax: ==$HEX2DEC( num )==
* Example: ==%CALCULATE{$HEX2DEC(A5)}%== returns ==165==
* Related: =[[#FuncBIN2DEC][$BIN2DEC()]]=, =[[#FuncDEC2BIN][$DEC2BIN()]]=, =[[#FuncDEC2HEX][$DEC2HEX()]]=, =[[#FuncDEC2OCT][$DEC2OCT()]]=, =[[#FuncHEXDECODE][$HEXDECODE()]]=, =[[#FuncHEXENCODE][$HEXENCODE()]]=, =[[#FuncOCT2DEC][$OCT2DEC()]]=
#FuncHEXDECODE
---+++ HEXDECODE( hexcode ) -- convert hexadecimal code to string
* Decode a hexadecimal string, typically encoded with $HEXENCODE().
* Syntax: ==$HEXDECODE( hexcode )==
* Example: ==%CALCULATE{$HEXDECODE(687474703A2F2F7477696B692E6F72672F)}%== returns ==http://twiki.org/==
* Related: =[[#FuncBITXOR][$BITXOR()]]=, =[[#FuncHEX2DEC][$HEX2DEC()]]=, =[[#FuncHEXENCODE][$HEXENCODE()]]=, =[[#FuncSUBSTITUTE][$SUBSTITUTE()]]=, =[[#FuncTRANSLATE][$TRANSLATE()]]=
#FuncHEXENCODE
---+++ HEXENCODE( text ) -- encode text into hexadecimal code
* Each character of =text= is encoded into two hexadecimal numbers.
* Syntax: ==$HEXENCODE( text )==
* Example: ==%CALCULATE{$HEXENCODE(http://twiki.org/)}%== returns ==687474703A2F2F7477696B692E6F72672F==
* Related: =[[#FuncBITXOR][$BITXOR()]]=, =[[#FuncDEC2HEX][$DEC2HEX()]]=, =[[#FuncHEXDECODE][$HEXDECODE()]]=, =[[#FuncSUBSTITUTE][$SUBSTITUTE()]]=, =[[#FuncTRANSLATE][$TRANSLATE()]]=
#FuncIF
---+++ IF( condition, then, else ) -- return a value based on a condition
* The condition can be a number (where ==0== means condition not met), or two numbers with a comparison operator ==<== (less than), ==<=== (less than or equal), ====== (equal), ==!=== (not equal), ==>=== (greater than or equal), ==>== (greater than).
* Syntax: ==$IF( condition, value if true, value if 0 )==
* Example: ==%CALC{$IF($T(R1:C5) > 1000, Over Budget, OK)}%== returns ==Over Budget== if value in R1:C5 is over 1000, ==OK== if not
* Example: ==%CALC{$IF($EXACT($T(R1:C2),), empty, $T(R1:C2))}%== returns the content of R1:C2 or ==empty== if empty
* Example: ==%CALC{$SET(val, $IF($T(R1:C2) == 0, zero, $T(R1:C2)))}%== sets a variable conditionally
* Related: =[[#FuncAND][$AND()]]=, =[[#FuncEMPTY][$EMPTY()]]=, =[[#FuncEQUAL][$EQUAL()]]=, =[[#FuncEXACT][$EXACT()]]=, =[[#FuncISDIGIT][$ISDIGIT()]]=, =[[#FuncISLOWER][$ISLOWER()]]=, =[[#FuncISUPPER][$ISUPPER()]]=, =[[#FuncISWIKIWORD][$ISWIKIWORD()]]=, =[[#FuncLISTIF][$LISTIF()]]=, =[[#FuncNOT][$NOT()]]=, =[[#FuncOR][$OR()]]=, =[[#FuncWHILE][$WHILE()]]=
#FuncINSERTSTRING
---+++ INSERTSTRING( text, start, new ) -- insert a string into a text string
* Insert =new= string into text string =text= to the right of =start= position. Position starts at 1; use a negative =start= to count from the end of the text
* Syntax: ==$INSERTSTRING( text, start, new )==
* Example: ==%CALCULATE{$INSERTSTRING(abcdefg, 2, XYZ)}%== returns ==abXYZcdefg==
* Example: ==%CALCULATE{$INSERTSTRING(abcdefg, -2, XYZ)}%== returns ==abcdeXYZfg==
* Related: =[[#FuncFILTER][$FILTER()]]=, =[[#FuncFIND][$FIND()]]=, =[[#FuncLEFTSTRING][$LEFTSTRING()]]=, =[[#FuncRANDSTRING][$RANDSTRING()]]=, =[[#FuncREPLACE][$REPLACE()]]=, =[[#FuncRIGHTSTRING][$RIGHTSTRING()]]=, =[[#FuncSEARCH][$SEARCH()]]=, =[[#FuncSUBSTITUTE][$SUBSTITUTE()]]=, =[[#FuncSUBSTRING][$SUBSTRING()]]=, =[[#FuncTRANSLATE][$TRANSLATE()]]=
#FuncINT
---+++ INT( formula ) -- evaluate formula and return integer truncated towards 0
* Addition, substraction, multiplication, division and modulus of numbers are supported. Any nesting is permitted
* Numbers may be decimal integers (=1234=), binary integers (=0b1110011=), octal integers (=01234=), hexadecimal integers (=0x1234=) or of exponential notation (=12.34e-56=)
* If you expect a single decimal integer value with leading zeros, use ==$INT( $VALUE( number ) )==
* Syntax: ==$INT( formula )==
* Example: ==%CALCULATE{$INT(10 / 4)}%== returns ==2==
* Example: ==%CALCULATE{$INT($VALUE(09))}%== returns ==9==
* Related: =[[#FuncCEILING][$CEILING()]]=, =[[#FuncEVAL][$EVAL()]]=, =[[#FuncFLOOR][$FLOOR()]]=, =[[#FuncROUND][$ROUND()]]=, =[[#FuncVALUE][$VALUE()]]=
#FuncISDIGIT
---+++ ISDIGIT( text ) -- test for digits
* Test for one or more digits (0...9)
* Syntax: ==$ISDIGIT( text )==
* Example: ==%CALCULATE{$ISDIGIT(123)}%== returns ==1==
* Example: ==%CALCULATE{$ISDIGIT(-7)}%== returns ==0==
* Related: =[[#FuncABS][$ABS()]]=, =[[#FuncEMPTY][$EMPTY()]]=, =[[#FuncEVEN][$EVEN()]]=, =[[#FuncEQUAL][$EQUAL()]]=, =[[#FuncEXACT][$EXACT()]]=, =[[#FuncIF][$IF()]]=, =[[#FuncISDIGIT][$ISDIGIT()]]=, =[[#FuncMOD][$MOD()]]=, =[[#FuncODD][$ODD()]]=, =[[#FuncSIGN][$SIGN()]]=, =[[#FuncVALUE][$VALUE()]]=
#FuncISLOWER
---+++ ISLOWER( text ) -- test for lower case text
* Syntax: ==$ISLOWER( text )==
* Example: ==%CALCULATE{$ISLOWER(apple)}%== returns ==1==
* Example: ==%CALCULATE{$ISLOWER(apple tree)}%== returns ==0== (text contains a space character)
* Example: ==%CALCULATE{$ISLOWER(ORANGE)}%== returns ==0==
* Related: =[[#FuncEMPTY][$EMPTY()]]=, =[[#FuncEQUAL][$EQUAL()]]=, =[[#FuncEXACT][$EXACT()]]=, =[[#FuncLOWER][$LOWER()]]=, =[[#FuncIF][$IF()]]=, =[[#FuncISDIGIT][$ISDIGIT()]]=, =[[#FuncISUPPER][$ISUPPER()]]=, =[[#FuncISWIKIWORD][$ISWIKIWORD()]]=, =[[#FuncUPPER][$UPPER()]]=
#FuncISUPPER
---+++ ISUPPER( text ) -- test for upper case text
* Can be used to test for ACRONYMS
* Syntax: ==$ISUPPER( text )==
* Example: ==%CALCULATE{$ISUPPER(apple)}%== returns ==0==
* Example: ==%CALCULATE{$ISUPPER(ORANGE)}%== returns ==1==
* Example: ==%CALCULATE{$ISUPPER(ORANGE GARDEN)}%== returns ==0== (text contains a space character)
* Related: =[[#FuncEMPTY][$EMPTY()]]=, =[[#FuncEQUAL][$EQUAL()]]=, =[[#FuncEXACT][$EXACT()]]=, =[[#FuncLOWER][$LOWER()]]=, =[[#FuncIF][$IF()]]=, =[[#FuncISDIGIT][$ISDIGIT()]]=, =[[#FuncISLOWER][$ISLOWER()]]=, =[[#FuncISWIKIWORD][$ISWIKIWORD()]]=, =[[#FuncUPPER][$UPPER()]]=
#FuncISWIKIWORD
---+++ ISWIKIWORD( text ) -- test for !WikiWord
* A %SYSTEMWEB%.WikiWord has a sequence of UPPER, lower/digit, UPPER, optional mixed case alphanumeric characters
* Can be used together with =$ISUPPER()= to test for valid topic names
* Syntax: ==$ISWIKIWORD( text )==
* Example: ==%CALCULATE{$ISWIKIWORD(GoldenGate)}%== returns ==1==
* Example: ==%CALCULATE{$ISWIKIWORD(whiteRafting)}%== returns ==0==
* Related: =[[#FuncEMPTY][$EMPTY()]]=, =[[#FuncEQUAL][$EQUAL()]]=, =[[#FuncEXISTS][$EXISTS()]]=, =[[#FuncEXACT][$EXACT()]]=, =[[#FuncIF][$IF()]]=, =[[#FuncISDIGIT][$ISDIGIT()]]=, =[[#FuncISLOWER][$ISLOWER()]]=, =[[#FuncISUPPER][$ISUPPER()]]=, =[[#FuncPROPER][$PROPER()]]=, =[[#FuncPROPERSPACE][$PROPERSPACE()]]=
#FuncLEFT
---+++ LEFT( ) -- address range of cells to the left of the current cell
* Syntax: ==$LEFT( )==
* Example: ==%CALC{$SUM($LEFT())}%== returns the sum of cells to the left of the current cell
* Related: =[[#FuncABOVE][$ABOVE()]]=, =[[#FuncRIGHT][$RIGHT()]]=
#FuncLEFTSTRING
---+++ LEFTSTRING( text, num ) -- extract characters at the beginning!! of a text string
* Retrieve the =num= of characters from the left end of =text=; the leftmost character is returned if =num= is missing
* Syntax: ==$LEFTSTRING( text, _num_ )==
* Example: ==%CALCULATE{$LEFTSTRING(abcdefg)}%== returns ==a==
* Example: ==%CALCULATE{$LEFTSTRING(abcdefg, 5)}%== returns ==abcde==
* Related: =[[#FuncBITXOR][$BITXOR()]]=, =[[#FuncFILTER][$FILTER()]]=, =[[#FuncFIND][$FIND()]]=, =[[#FuncINSERTSTRING][$INSERTSTRING()]]=, =[[#FuncRANDSTRING][$RANDSTRING()]]=, =[[#FuncREPLACE][$REPLACE()]]=, =[[#FuncRIGHTSTRING][$RIGHTSTRING()]]=, =[[#FuncSEARCH][$SEARCH()]]=, =[[#FuncSUBSTITUTE][$SUBSTITUTE()]]=, =[[#FuncSUBSTRING][$SUBSTRING()]]=, =[[#FuncTRANSLATE][$TRANSLATE()]]=
#FuncLENGTH
---+++ LENGTH( text ) -- length of text in bytes
* Syntax: ==$LENGTH( text )==
* Example: ==%CALCULATE{$LENGTH(abcd)}%== returns ==4==
* Related: =[[#FuncLISTSIZE][$LISTSIZE()]]=
#FuncLIST
---+++ LIST( range ) -- convert content of a cell range into a list
* Convert the content of a range of cells into a flat list, delimited by comma. Cells containing commas are merged into the list
* Syntax: ==$LIST( range )==
* Example: ==%CALC{$LIST($LEFT())}%== returns ==Apples, Lemons, Oranges, Kiwis== assuming the cells to the left contain ==| Apples | Lemons, Oranges | Kiwis |==
* Related: =[[#FuncAVERAGE][$AVERAGE()]]=, =[[#FuncCOUNTITEMS][$COUNTITEMS()]]=, =[[#FuncCOUNTSTR][$COUNTSTR()]]=, =[[#FuncDEF][$DEF()]]=, =[[#FuncLISTEACH][$LISTEACH()]]=, =[[#FuncLISTIF][$LISTIF()]]=, =[[#FuncLISTITEM][$LISTITEM()]]=, =[[#FuncLISTJOIN][$LISTJOIN()]]=, =[[#FuncLISTNONEMPTY][$LISTNONEMPTY()]]=, =[[#FuncLISTRAND][$LISTRAND()]]=, =[[#FuncLISTREVERSE][$LISTREVERSE()]]=, =[[#FuncLISTSHUFFLE][$LISTSHUFFLE()]]=, =[[#FuncLISTSIZE][$LISTSIZE()]]=, =[[#FuncLISTSORT][$LISTSORT()]]=, =[[#FuncLISTTRUNCATE][$LISTTRUNCATE()]]=, =[[#FuncLISTUNIQUE][$LISTUNIQUE()]]=, =[[#FuncMAX][$MAX()]]=, =[[#FuncMEDIAN][$MEDIAN()]]=, =[[#FuncMIN][$MIN()]]=, =[[#FuncPRODUCT][$PRODUCT()]]=, =[[#FuncSPLIT][$SPLIT()]]=, =[[#FuncSUM][$SUM()]]=, =[[#FuncSUMDAYS][$SUMDAYS()]]=, =[[#FuncSUMPRODUCT][$SUMPRODUCT()]]=
#FuncLIST2HASH
---+++ !LIST2HASH( name, list ) -- create a hash from a list
* Specify the hash name and a list. The list is expected to have a sequence of key and value pairs. If a key already exists its value is updated with the new value. The last key is ignored if the list has an uneven number of elements. Use =$GETHASH()= or =$HASH2LIST= to retrieve hash values.
* Syntax: ==$LIST2HASH( name, list )==
* Example: ==%CALCULATE{$LIST2HASH(age, Jane, 26, Tim, 27)}%== sets key =Jane= of hash named =age= to =26=, and key =Tim= to =27=
* Related: =[[#FuncGET][$GET()]]=, =[[#FuncGETHASH][$GETHASH()]]=, =[[#FuncHASH2LIST][$HASH2LIST()]]=, =[[#FuncHASHCOPY][$HASHCOPY()]]=, =[[#FuncHASHEACH][$HASHEACH()]]=, =[[#FuncHASHEXISTS][$HASHEXISTS()]]=, =[[#FuncHASHREVERSE][$HASHREVERSE()]]=, =[[#FuncSET][$SET()]]=
#FuncLISTMAP
#FuncLISTEACH
---+++ LISTEACH( formula, list ) -- evaluate and update each element of a list
* Specify a formula that should be applied to list element; ==$item== indicates the element, ==$index== the index of the list, starting at 1. If ==$item== is omitted, the item is appended to the formula. This function returns no output.
* Syntax: ==$LISTEACH( formula, list )==
* Deprecated syntax: ==$LISTMAP( formula, list )==
* Example: ==%CALCULATE{$LISTEACH($index: $EVAL(2 * $item), 3, 5, 7, 11)}%== returns ==1: 6, 2: 10, 3: 14, 4: 22==
* Related: =[[#FuncCOUNTITEMS][$COUNTITEMS()]]=, =[[#FuncCOUNTSTR][$COUNTSTR()]]=, =[[#FuncLIST][$LIST()]]=, =[[#FuncLISTIF][$LISTIF()]]=, =[[#FuncLISTITEM][$LISTITEM()]]=, =[[#FuncLISTNONEMPTY][$LISTNONEMPTY()]]=, =[[#FuncLISTREVERSE][$LISTREVERSE()]]=, =[[#FuncLISTSIZE][$LISTSIZE()]]=, =[[#FuncLISTSORT][$LISTSORT()]]=, =[[#FuncLISTUNIQUE][$LISTUNIQUE()]]=, =[[#FuncSPLIT][$SPLIT()]]=, =[[#FuncSUM][$SUM()]]=, =[[#FuncWHILE][$WHILE()]]=
#FuncLISTIF
---+++ LISTIF( condition, list ) -- remove elements from a list!! that do not meet a condition
* In addition to the condition described in =[[#FuncIF][$IF()]]=, you can use ==$item== to indicate the current element, and ==$index== for the list index, starting at 1
* Syntax: ==$LISTIF( condition, list )==
* Example: ==%CALCULATE{$LISTIF($item > 12, 14, 7, 25)}%== returns ==14, 25==
* Example: ==%CALCULATE{$LISTIF($NOT($EXACT($item,)), A, B, , E)}%== returns non-empty elements ==A, B, E==
* Example: ==%CALCULATE{$LISTIF($index > 2, A, B, C, D)}%== returns ==C, D==
* Related: =[[#FuncEMPTY][$EMPTY()]]=, =[[#FuncEQUAL][$EQUAL()]]=, =[[#FuncEXACT][$EXACT()]]=, =[[#FuncIF][$IF()]]=, =[[#FuncLIST][$LIST()]]=, =[[#FuncLISTEACH][$LISTEACH()]]=, =[[#FuncLISTITEM][$LISTITEM()]]=, =[[#FuncLISTNONEMPTY][$LISTNONEMPTY()]]=, =[[#FuncLISTREVERSE][$LISTREVERSE()]]=, =[[#FuncLISTSIZE][$LISTSIZE()]]=, =[[#FuncLISTSORT][$LISTSORT()]]=, =[[#FuncLISTUNIQUE][$LISTUNIQUE()]]=, =[[#FuncSUM][$SUM()]]=, =[[#FuncWHILE][$WHILE()]]=
#FuncLISTITEM
---+++ LISTITEM( index, list ) -- get one element of a list
* Index is 1 to size of list; use a negative number to count from the end of the list
* Syntax: ==$LISTITEM( index, list )==
* Example: ==%CALCULATE{$LISTITEM(2, Apple, Orange, Apple, Kiwi)}%== returns ==Orange==
* Example: ==%CALCULATE{$LISTITEM(-1, Apple, Orange, Apple, Kiwi)}%== returns ==Kiwi==
* Related: =[[#FuncCOUNTITEMS][$COUNTITEMS()]]=, =[[#FuncCOUNTSTR][$COUNTSTR()]]=, =[[#FuncLIST][$LIST()]]=, =[[#FuncLISTEACH][$LISTEACH()]]=, =[[#FuncLISTIF][$LISTIF()]]=, =[[#FuncLISTNONEMPTY][$LISTNONEMPTY()]]=, =[[#FuncLISTRAND][$LISTRAND()]]=, =[[#FuncLISTREVERSE][$LISTREVERSE()]]=, =[[#FuncLISTSIZE][$LISTSIZE()]]=, =[[#FuncLISTSORT][$LISTSORT()]]=, =[[#FuncLISTUNIQUE][$LISTUNIQUE()]]=, =[[#FuncSPLIT][$SPLIT()]]=, =[[#FuncSUM][$SUM()]]=
#FuncLISTJOIN
---+++ LISTJOIN( separator, list ) -- convert a list into a string
* 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, =$sp= for space, and =$empty= to join a list without a separator.
* Syntax: ==$LISTJOIN( separator, list )==
* Example: ==%CALCULATE{$LISTJOIN($n, Apple, Orange, Apple, Kiwi)}%== returns the four items separated by new lines
* Example: ==%CALCULATE{$LISTJOIN($empty, Apple, Orange, Apple, Kiwi)}%== returns ==AppleOrangeAppleKiwi==
* Related: =[[#FuncLIST][$LIST()]]=, =[[#FuncLISTNONEMPTY][$LISTNONEMPTY()]]=, =[[#FuncLISTSIZE][$LISTSIZE()]]=, =[[#FuncSPLIT][$SPLIT()]]=
#FuncLISTNONEMPTY
---+++ LISTNONEMPTY( list ) -- remove all empty elements from a list
* Syntax: ==$LISTNONEMPTY( list )==
* Example: ==%CALCULATE{$LISTNONEMPTY(, Apple, Orange, , Kiwi)}%== returns ==Apple, Orange, Kiwi==
* Related: =[[#FuncLISTEACH][$LISTEACH()]]=, =[[#FuncLISTIF][$LISTIF()]]=, =[[#FuncLISTITEM][$LISTITEM()]]=, =[[#FuncLISTSIZE][$LISTSIZE()]]=, =[[#FuncLISTUNIQUE][$LISTUNIQUE()]]=
#FuncLISTRAND
---+++ LISTRAND( list ) -- get one random element of a list
* Syntax: ==$LISTRAND( list )==
* Example: ==%CALCULATE{$LISTRAND(Apple, Orange, Apple, Kiwi)}%== returns one of the four elements
* Related: =[[#FuncCOUNTITEMS][$COUNTITEMS()]]=, =[[#FuncCOUNTSTR][$COUNTSTR()]]=, =[[#FuncLIST][$LIST()]]=, =[[#FuncLISTEACH][$LISTEACH()]]=, =[[#FuncLISTIF][$LISTIF()]]=, =[[#FuncLISTITEM][$LISTITEM()]]=, =[[#FuncLISTSHUFFLE][$LISTSHUFFLE()]]=, =[[#FuncLISTSIZE][$LISTSIZE()]]=, =[[#FuncLISTSORT][$LISTSORT()]]=, =[[#FuncLISTUNIQUE][$LISTUNIQUE()]]=, =[[#FuncRAND][$RAND()]]=, =[[#FuncRANDSTRING][$RANDSTRING()]]=, =[[#FuncSUM][$SUM()]]=
#FuncLISTREVERSE
---+++ LISTREVERSE( list ) -- opposite order of a list
* Syntax: ==$LISTREVERSE( list )==
* Example: ==%CALCULATE{$LISTREVERSE(Apple, Orange, Apple, Kiwi)}%== returns ==Kiwi, Apple, Orange, Apple==
* Related: =[[#FuncCOUNTITEMS][$COUNTITEMS()]]=, =[[#FuncCOUNTSTR][$COUNTSTR()]]=, =[[#FuncLIST][$LIST()]]=, =[[#FuncLISTEACH][$LISTEACH()]]=, =[[#FuncLISTIF][$LISTIF()]]=, =[[#FuncLISTITEM][$LISTITEM()]]=, =[[#FuncLISTSIZE][$LISTSIZE()]]=, =[[#FuncLISTSORT][$LISTSORT()]]=, =[[#FuncLISTUNIQUE][$LISTUNIQUE()]]=, =[[#FuncSUM][$SUM()]]=
#FuncLISTSHUFFLE
---+++ LISTSHUFFLE( list ) -- shuffle element of a list in random order
* Syntax: ==$LISTSHUFFLE( list )==
* Example: ==%CALCULATE{$LISTSHUFFLE(Apple, Orange, Apple, Kiwi)}%== returns the four elements in random order
* Related: =[[#FuncCOUNTITEMS][$COUNTITEMS()]]=, =[[#FuncCOUNTSTR][$COUNTSTR()]]=, =[[#FuncLIST][$LIST()]]=, =[[#FuncLISTEACH][$LISTEACH()]]=, =[[#FuncLISTIF][$LISTIF()]]=, =[[#FuncLISTITEM][$LISTITEM()]]=, =[[#FuncLISTRAND][$LISTRAND()]]=, =[[#FuncLISTSIZE][$LISTSIZE()]]=, =[[#FuncLISTSORT][$LISTSORT()]]=, =[[#FuncLISTUNIQUE][$LISTUNIQUE()]]=, =[[#FuncRAND][$RAND()]]=, =[[#FuncRANDSTRING][$RANDSTRING()]]=, =[[#FuncSUM][$SUM()]]=
#FuncLISTSIZE
---+++ LISTSIZE( list ) -- number of elements in a list
* Syntax: ==$LISTSIZE( list )==
* Example: ==%CALCULATE{$LISTSIZE(Apple, Orange, Apple, Kiwi)}%== returns ==4==
* Related: =[[#FuncCOUNTITEMS][$COUNTITEMS()]]=, =[[#FuncCOUNTSTR][$COUNTSTR()]]=, =[[#FuncLIST][$LIST()]]=, =[[#FuncLISTEACH][$LISTEACH()]]=, =[[#FuncLISTIF][$LISTIF()]]=, =[[#FuncLISTITEM][$LISTITEM()]]=, =[[#FuncLISTJOIN][$LISTJOIN()]]=, =[[#FuncLISTREVERSE][$LISTREVERSE()]]=, =[[#FuncLISTSORT][$LISTSORT()]]=, =[[#FuncLISTTRUNCATE][$LISTTRUNCATE()]]=, =[[#FuncLISTUNIQUE][$LISTUNIQUE()]]=, =[[#FuncSPLIT][$SPLIT()]]=, =[[#FuncSUM][$SUM()]]=
#FuncLISTSORT
---+++ LISTSORT( list ) -- sort a list
* Sorts a list in ASCII order, or numerically if all elements are numeric
* Syntax: ==$LISTSORT( list )==
* Example: ==%CALCULATE{$LISTSORT(Apple, Orange, Apple, Kiwi)}%== returns ==Apple, Apple, Kiwi, Orange==
* Related: =[[#FuncCOUNTITEMS][$COUNTITEMS()]]=, =[[#FuncCOUNTSTR][$COUNTSTR()]]=, =[[#FuncLIST][$LIST()]]=, =[[#FuncLISTEACH][$LISTEACH()]]=, =[[#FuncLISTIF][$LISTIF()]]=, =[[#FuncLISTITEM][$LISTITEM()]]=, =[[#FuncLISTREVERSE][$LISTREVERSE()]]=, =[[#FuncLISTSHUFFLE][$LISTSHUFFLE()]]=, =[[#FuncLISTSIZE][$LISTSIZE()]]=, =[[#FuncLISTUNIQUE][$LISTUNIQUE()]]=, =[[#FuncSUM][$SUM()]]=
#FuncLISTTRUNCATE
---+++ LISTTRUNCATE( size, list ) -- truncate list to size
* Specify the desired size of the list; use a negative number to count from the end of the list
* Syntax: ==$LISTTRUNCATE( size, list )==
* Example: ==%CALCULATE{$LISTTRUNCATE(2, Apple, Orange, Kiwi)}%== returns ==Apple, Orange==
* Related: =[[#FuncCOUNTITEMS][$COUNTITEMS()]]=, =[[#FuncCOUNTSTR][$COUNTSTR()]]=, =[[#FuncLIST][$LIST()]]=, =[[#FuncLISTEACH][$LISTEACH()]]=, =[[#FuncLISTIF][$LISTIF()]]=, =[[#FuncLISTITEM][$LISTITEM()]]=, =[[#FuncLISTSIZE][$LISTSIZE()]]=, =[[#FuncLISTSORT][$LISTSORT()]]=, =[[#FuncLISTUNIQUE][$LISTUNIQUE()]]=, =[[#FuncSUM][$SUM()]]=
#FuncLISTUNIQUE
---+++ LISTUNIQUE( list ) -- remove all duplicates from a list
* Syntax: ==$LISTUNIQUE( list )==
* Example: ==%CALCULATE{$LISTUNIQUE(Apple, Orange, Apple, Kiwi)}%== returns ==Apple, Orange, Kiwi==
* Related: =[[#FuncCOUNTITEMS][$COUNTITEMS()]]=, =[[#FuncCOUNTSTR][$COUNTSTR()]]=, =[[#FuncLIST][$LIST()]]=, =[[#FuncLISTEACH][$LISTEACH()]]=, =[[#FuncLISTIF][$LISTIF()]]=, =[[#FuncLISTITEM][$LISTITEM()]]=, =[[#FuncLISTNONEMPTY][$LISTNONEMPTY()]]=, =[[#FuncLISTREVERSE][$LISTREVERSE()]]=, =[[#FuncLISTSIZE][$LISTSIZE()]]=, =[[#FuncLISTSORT][$LISTSORT()]]=, =[[#FuncSUM][$SUM()]]=
#FuncLN
---+++ LN( num ) -- natural logarithm of a number
* LN is the inverse of the EXP function
* Syntax: ==$LN( num )==
* Example: ==%CALCULATE{$LN(10)}%== returns ==2.30258509299405==
* Related: =[[#FuncEXP][$EXP()]]=, =[[#FuncLOG][$LOG()]]=
#FuncLOG
---+++ LOG( num, base ) -- logarithm of a number to a given base
* base-10 logarithm of a number (if base is 0 or not specified), else logarithm of a number to the given base
* Syntax: ==$LOG( num, _base_ )==
* Example: ==%CALCULATE{$LOG(1000)}%== returns ==3==
* Example: ==%CALCULATE{$LOG(16, 2)}%== returns ==4==
* Related: =[[#FuncEXP][$EXP()]]=, =[[#FuncLN][$LN()]]=
#FuncLOWER
---+++ LOWER( text ) -- lower case string of a text
* Syntax: ==$LOWER(text)==
* Example: ==%CALC{$LOWER( $T(R1:C5) )}%== returns the lower case string of the text in cell ==R1:C5==
* Related: =[[#FuncISLOWER][$ISLOWER()]]=, =[[#FuncPROPER][$PROPER()]]=, =[[#FuncPROPERSPACE][$PROPERSPACE()]]=, =[[#FuncTRIM][$TRIM()]]=, =[[#FuncUPPER][$UPPER()]]=
#FuncMAX
---+++ MAX( list ) - biggest value of a list or range of cells
* Syntax: ==$MAX( list )==
* Example: To find the biggest number to the left of the current cell, write: ==%CALC{$MAX($LEFT())}%==
* Related: =[[#FuncLIST][$LIST()]]=, =[[#FuncMEDIAN][$MEDIAN()]]=, =[[#FuncMIN][$MIN()]]=, =[[#FuncPERCENTILE][$PERCENTILE()]]=, =[[#FuncSTDEV][$STDEV()]]=, =[[#FuncSTDEVP][$STDEVP()]]=, =[[#FuncVAR][$VAR()]]=, =[[#FuncVARP][$VARP()]]=
#FuncMEDIAN
---+++ MEDIAN( list ) -- median of a list or range of cells
* Syntax: ==$MEDIAN( list )==
* Example: ==%CALCULATE{$MEDIAN(3, 9, 4, 5)}%== returns ==4.5==
* Related: =[[#FuncLIST][$LIST()]]=, =[[#FuncMAX][$MAX()]]=, =[[#FuncMIN][$MIN()]]=, =[[#FuncPERCENTILE][$PERCENTILE()]]=, =[[#FuncSTDEV][$STDEV()]]=, =[[#FuncSTDEVP][$STDEVP()]]=, =[[#FuncVAR][$VAR()]]=, =[[#FuncVARP][$VARP()]]=
#FuncMIN
---+++ MIN( list ) -- smallest value of a list or range of cells
* Syntax: ==$MIN( list )==
* Example: ==%CALCULATE{$MIN(15, 3, 28)}%== returns ==3==
* Related: =[[#FuncLIST][$LIST()]]=, =[[#FuncMAX][$MAX()]]=, =[[#FuncMEDIAN][$MEDIAN()]]=, =[[#FuncPERCENTILE][$PERCENTILE()]]=, =[[#FuncSTDEV][$STDEV()]]=, =[[#FuncSTDEVP][$STDEVP()]]=, =[[#FuncVAR][$VAR()]]=, =[[#FuncVARP][$VARP()]]=
#FuncMOD
---+++ MOD( num, divisor ) -- reminder after dividing ==num== by ==divisor==
* Syntax: ==$MOD( num, divisor )==
* Example: ==%CALCULATE{$MOD(7, 3)}%== returns ==1==
* Related: =[[#FuncEVAL][$EVAL()]]=, =[[#FuncEVEN][$EVEN()]]=, =[[#FuncISDIGIT][$ISDIGIT()]]=, =[[#FuncODD][$ODD()]]=, =[[#FuncSIGN][$SIGN()]]=
#FuncNOEXEC
---+++ NOEXEC( formula ) -- do not execute a spreadsheet formula
* Prevent a formula from getting executed. This is typically used to store a raw formula in a variable for later use as described in =[[#FuncEXEC][$EXEC()]]=.
* Syntax: ==$NOEXEC( formula )==
* Example: ==%CALCULATE{$SET(msg, $NOEXEC(Hi $GET(name)))}%== sets the =msg= variable with the formula =Hi $GET(name)= without executing it
* Related: =[[#FuncEVAL][$EVAL()]]=, =[[#FuncEXEC][$EXEC()]]=, =[[#FuncGET][$GET()]]=, =[[#FuncSET][$SET()]]=
#FuncNOP
---+++ NOP( text ) -- no-operation
* Text is returned verbatim, except for escape characters:
* =$percnt= - changed to percent character '%'
* =$quot= - changed to double quote character '"'
* Useful to delay / change the order of plugin execution. For example, it allows preprocessing to be done before =%SEARCH{...}%=.
* Syntax: ==$NOP( text )==
* Example: ==%CALCULATE{$NOP(%)SEARCH{...}$NOP(%)}%== returns =%SEARCH{...}%=
* Example: ==%CALCULATE{$NOP($percntSEARCH{...}$percnt)}%== returns =%SEARCH{...}%=
* Related: =[[#FuncNOTE][$NOTE()]]=
#FuncNOT
---+++ NOT( num ) -- reverse logic of a number
* Returns 0 if ==num== is not zero, 1 if zero
* Syntax: ==$NOT( num )==
* Example: ==%CALCULATE{$NOT(0)}%== returns ==1==
* Related: =[[#FuncAND][$AND()]]=, =[[#FuncEMPTY][$EMPTY()]]=, =[[#FuncIF][$IF()]]=, =[[#FuncOR][$OR()]]=, =[[#FuncWHILE][$WHILE()]]=, =[[#FuncXOR][$XOR()]]=
#FuncNOTE
---+++ NOTE( text ) -- note, return empty string
* An empty string is returned - useful to comment formulas
* Syntax: ==$NOTE( comment text )==
* Example: ==%CALCULATE{$NOTE(abc)}%== returns an empty string
* Related: =[[#FuncNOP][$NOP()]]=
#FuncOCT2DEC
---+++ !OCT2DEC( num ) -- convert an octal number to decimal
* Syntax: ==$OCT2DEC( num )==
* Example: ==%CALCULATE{$OCT2DEC(54)}%== returns ==44==
* Related: =[[#FuncBIN2DEC][$BIN2DEC()]]=, =[[#FuncDEC2BIN][$DEC2BIN()]]=, =[[#FuncDEC2HEX][$DEC2HEX()]]=, =[[#FuncDEC2OCT][$DEC2OCT()]]=, =[[#FuncHEX2DEC][$HEX2DEC()]]=, =[[#FuncHEXDECODE][$HEXDECODE()]]=, =[[#FuncHEXENCODE][$HEXENCODE()]]=
#FuncODD
---+++ ODD( num ) -- test for odd number
* Syntax: ==$ODD( num )==
* Example: ==%CALCULATE{$ODD(2)}%== returns ==0==
* Related: =[[#FuncABS][$ABS()]]=, =[[#FuncEVEN][$EVEN()]]=, =[[#FuncISDIGIT][$ISDIGIT()]]=, =[[#FuncMOD][$MOD()]]=, =[[#FuncSIGN][$SIGN()]]=
#FuncOR
---+++ OR( list ) -- logical OR of a list
* Syntax: ==$OR( list )==
* Example: ==%CALCULATE{$OR(1, 0, 1)}%== returns ==1==
* Related: =[[#FuncAND][$AND()]]=, =[[#FuncIF][$IF()]]=, =[[#FuncNOT][$NOT()]]=, =[[#FuncWHILE][$WHILE()]]=, =[[#FuncXOR][$XOR()]]=
#FuncPERCENTILE
---+++ PERCENTILE( num, list ) -- percentile of a list or range of cells
* Calculates the num-th percentile, useful to establish a threshold of acceptance. num is the percentile value, range 0..100
* Syntax: ==$PERCENTILE( num, list )==
* Example: ==%CALCULATE{$PERCENTILE(75, 400, 200, 500, 100, 300)}%== returns ==450==
* Related: =[[#FuncLIST][$LIST()]]=, =[[#FuncMAX][$MAX()]]=, =[[#FuncMEDIAN][$MEDIAN()]]=, =[[#FuncMIN][$MIN()]]=, =[[#FuncSTDEV][$STDEV()]]=, =[[#FuncSTDEVP][$STDEVP()]]=, =[[#FuncVAR][$VAR()]]=, =[[#FuncVARP][$VARP()]]=
#FuncPI
---+++ PI( ) -- mathematical constant Pi, 3.14159265358979
* Syntax: ==$PI( )==
* Example: ==%CALCULATE{$PI()}%== returns ==3.14159265358979==
#FuncPRODUCT
---+++ PRODUCT( list ) -- product of a list or range of cells
* Syntax: ==$PRODUCT( list )==
* Deprecated syntax: ==$MULT( list )==
* Example: To calculate the product of the cells to the left of the current one use ==%CALC{$PRODUCT($LEFT())}%==
* Related: =[[#FuncLIST][$LIST()]]=, =[[#FuncPRODUCT][$PRODUCT()]]=, =[[#FuncSUM][$SUM()]]=, =[[#FuncSUMPRODUCT][$SUMPRODUCT()]]=
#FuncPROPER
---+++ PROPER( text ) -- properly capitalize text
* Capitalize letters that follow any character other than a letter; convert all other letters to lowercase letters
* Syntax: ==$PROPER( text )==
* Example: ==%CALCULATE{$PROPER(a small STEP)}%== returns ==A Small Step==
* Example: ==%CALCULATE{$PROPER(f1 (formula-1))}%== returns ==F1 (Formula-1)==
* Related: =[[#FuncFILTER][$FILTER()]]=, =[[#FuncISWIKIWORD][$ISWIKIWORD()]]=, =[[#FuncLOWER][$LOWER()]]=, =[[#FuncPROPERSPACE][$PROPERSPACE()]]=, =[[#FuncTRIM][$TRIM()]]=, =[[#FuncUPPER][$UPPER()]]=
#FuncPROPERSPACE
---+++ PROPERSPACE( text ) -- properly space out WikiWords
* Properly spaces out %SYSTEMWEB%.WikiWords preceeded by white space, parenthesis, or ==][==. Words listed in the DONTSPACE %SYSTEMWEB%.%WIKIPREFSTOPIC% variable or DONTSPACE plugins setting are excluded
* Syntax: ==$PROPERSPACE( text )==
* Example: Assuming DONTSPACE contains MacDonald: ==%CALCULATE{$PROPERSPACE(Old MacDonald had a ServerFarm, EeEyeEeEyeOh)}%== returns ==Old MacDonald had a Server Farm, Ee Eye Ee Eye Oh==
* Related: =[[#FuncISWIKIWORD][$ISWIKIWORD()]]=, =[[#FuncLOWER][$LOWER()]]=, =[[#FuncPROPER][$PROPER()]]=, =[[#FuncTRIM][$TRIM()]]=, =[[#FuncUPPER][$UPPER()]]=
#FuncRAND
---+++ RAND( max ) -- random number
* Random number, evenly distributed between 0 and ==max==, or 0 and 1 if max is not specified
* Syntax: ==$RAND( max )==
* Related: =[[#FuncEVAL][$EVAL()]]=, =[[#FuncLISTRAND][$LISTRAND()]]=, =[[#FuncLISTSHUFFLE][$LISTSHUFFLE()]]=, =[[#FuncRANDSTRING][$RANDSTRING()]]=
#FuncRANDSTRING
---+++ RANDSTRING( set, format ) -- random string & password generator
* Generate a random string from a ==set== of characters; the set may contain sequences like ==a..z==; default is ==a..zA..Z0..9_==. The ==format== defines the string length or the output format; specify a number to indicate the length of the random string; default is ==8== characters. Alternatively, specify a format string with ==x== as placeholders for random characters, such ==xxxx-xxxx-xxxx-xxxx==.
* Syntax: ==$RANDSTRING( _set_, _format_ )==
* Example: ==%CALCULATE{$RANDSTRING()}%== returns a random string with 8 characters composed of alphanumeric characters and underscores
* Example: ==%CALCULATE{$RANDSTRING(A..NP..Z1..9, xxxx-xxxx-xxxx-xxxx)}%== returns four sets of random strings, separated by dashes, where each set has four characters composed of uppercase letters and numbers, excluding letter O and number 0
* Related: =[[#FuncINSERTSTRING][$INSERTSTRING()]]=, =[[#FuncSUBSTRING][$SUBSTRING()]]=, =[[#FuncLISTRAND][$LISTRAND()]]=, =[[#FuncLISTSHUFFLE][$LISTSHUFFLE()]]=, =[[#FuncRAND][$RAND()]]=, =[[#FuncREPEAT][$REPEAT()]]=
#FuncREPEAT
---+++ REPEAT( text, num ) -- repeat text a number of times
* Syntax: ==$REPEAT( text, num )==
* Example: ==%CALCULATE{$REPEAT(/\, 5)}%== returns ==/\/\/\/\/\==
* Related: =[[#FuncRANDSTRING][$RANDSTRING()]]=, =[[#FuncWHILE][$WHILE()]]=
#FuncREPLACE
---+++ REPLACE( text, start, num, new ) -- replace part of a text string
* 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
* Syntax: ==$REPLACE( text, start, num, new )==
* Example: ==%CALCULATE{$REPLACE(abcdefghijk, 6, 5, *)}%== returns ==abcde*k==
* Related: =[[#FuncBITXOR][$BITXOR()]]=, =[[#FuncFILTER][$FILTER()]]=, =[[#FuncFIND][$FIND()]]=, =[[#FuncINSERTSTRING][$INSERTSTRING()]]=, =[[#FuncLEFTSTRING][$LEFTSTRING()]]=, =[[#FuncRIGHTSTRING][$RIGHTSTRING()]]=, =[[#FuncSEARCH][$SEARCH()]]=, =[[#FuncSUBSTITUTE][$SUBSTITUTE()]]=, =[[#FuncSUBSTRING][$SUBSTRING()]]=, =[[#FuncTRANSLATE][$TRANSLATE()]]=
#FuncRIGHT
---+++ RIGHT( ) -- address range of cells to the right of the current cell
* Syntax: ==$RIGHT( )==
* Example: ==%CALC{$SUM($RIGHT())}%== returns the sum of cells to the right of the current cell
* Related: =[[#FuncABOVE][$ABOVE()]]=, =[[#FuncLEFT][$LEFT()]]=
#FuncRIGHTSTRING
---+++ RIGHTSTRING( text, num ) -- extract characters at the end!! of a text string
* Retrieve the =num= of characters from the right end of =text=; the rightmost character is returned if =num= is missing
* Syntax: ==$RIGHTSTRING( text, _num_ )==
* Example: ==%CALCULATE{$RIGHTSTRING(abcdefg)}%== returns ==g==
* Example: ==%CALCULATE{$RIGHTSTRING(abcdefg, 5)}%== returns ==cdefg==
* Related: =[[#FuncBITXOR][$BITXOR()]]=, =[[#FuncFILTER][$FILTER()]]=, =[[#FuncFIND][$FIND()]]=, =[[#FuncINSERTSTRING][$INSERTSTRING()]]=, =[[#FuncLEFTSTRING][$LEFTSTRING()]]=, =[[#FuncRANDSTRING][$RANDSTRING()]]=, =[[#FuncREPLACE][$REPLACE()]]=, =[[#FuncSEARCH][$SEARCH()]]=, =[[#FuncSUBSTITUTE][$SUBSTITUTE()]]=, =[[#FuncSUBSTRING][$SUBSTRING()]]=, =[[#FuncTRANSLATE][$TRANSLATE()]]=
#FuncROUND
---+++ ROUND( formula, digits ) -- round a number
* Evaluates a simple ==formula== and rounds the result up or down to the number of digits if ==digits== is positive; to the nearest integer if digits is missing; or to the left of the decimal point if digits is negative
* Syntax: ==$ROUND( formula, digits )==
* Example: ==%CALCULATE{$ROUND(3.15, 1)}%== returns ==3.2==
* Example: ==%CALCULATE{$ROUND(3.149, 1)}%== returns ==3.1==
* Example: ==%CALCULATE{$ROUND(-2.475, 2)}%== returns ==-2.48==
* Example: ==%CALCULATE{$ROUND(34.9, -1)}%== returns ==30==
* Related: =[[#FuncCEILING][$CEILING()]]=, =[[#FuncEVAL][$EVAL()]]=, =[[#FuncFLOOR][$FLOOR()]]=, =[[#FuncINT][$INT()]]=, =[[#FuncFORMAT][$FORMAT()]]=
#FuncROW
---+++ ROW( offset ) -- current row number
* The current table row number with an optional offset. When used outside of a table it returns the number of rows of the preceding table.
* Syntax: ==$ROW( _offset_ )==
* Example: To get the number of rows excluding table heading (first row) and summary row (last row where this function is used), write: ==%CALC{$ROW(-2)}%==
* Related: =[[#FuncCOLUMN][$COLUMN()]]=, =[[#FuncT][$T()]]=
#FuncSEARCH
---+++ SEARCH( string, text, start ) -- search a string within a text
* 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
* Syntax: ==$SEARCH( string, text, _start_ )==
* Example: ==%CALCULATE{$SEARCH([uy], fluffy)}%== returns ==3==
* Example: ==%CALCULATE{$SEARCH([uy], fluffy, 4)}%== returns ==6==
* Example: ==%CALCULATE{$SEARCH([abc], fluffy,)}%== returns ==0==
* Related: =[[#FuncFILTER][$FILTER()]]=, =[[#FuncFIND][$FIND()]]=, =[[#FuncINSERTSTRING][$INSERTSTRING()]]=, =[[#FuncLEFTSTRING][$LEFTSTRING()]]=, =[[#FuncREPLACE][$REPLACE()]]=, =[[#FuncRIGHTSTRING][$RIGHTSTRING()]]=, =[[#FuncSUBSTRING][$SUBSTRING()]]=
#FuncSET
---+++ SET( name, value ) -- set a variable for later use
* Specify the variable name (alphanumeric characters and underscores) and the value. The value may contain a formula; formulas are evaluated before the variable assignment; see =[[#FuncNOEXEC][$NOEXEC()]]= 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. If the value is omitted, the named variable is deleted.
* Syntax: ==$SET( name, value )==
* Example: ==%CALC{$SET(my_total, $SUM($ABOVE()))}%== sets the =my_total= variable to the sum of all table cells located above the current cell and returns an empty string
* Related: =[[#FuncEXEC][$EXEC()]]=, =[[#FuncGET][$GET()]]=, =[[#FuncGETHASH][$GETHASH()]]=, =[[#FuncHASH2LIST][$HASH2LIST()]]=, =[[#FuncLIST2HASH][$LIST2HASH()]]=, =[[#FuncNOEXEC][$NOEXEC()]]=, =[[#FuncSETHASH][$SETHASH()]]=, =[[#FuncSETIFEMPTY][$SETIFEMPTY()]]=, =[[#FuncSETLIST][$SETLIST()]]=, =[[#FuncSETM][SETM()]]=, =[[#FuncSETMHASH][$SETMHASH()]]=, =[[#FuncWHILE][$WHILE()]]=, %SYSTEMWEB%.SetGetPlugin
#FuncSETHASH
---+++ SETHASH( name, key, value ) -- set a hash value for later use!!, or delete a hash
* Specify the hash name, key, and value. Allowed characters for the hash name are alphanumeric characters, underscores and period. This function returns no output. Use =$GETHASH()= to retrieve hash values. If the value is omitted, the key is deleted from the hash. If the key is omitted, the named hash is deleted. If no parameters are specified, all hashes are deleted.
* Syntax: ==$SETHASH( _name_, _key_, _value_ )==
* Example: ==%CALCULATE{$SETHASH(age, Jane, 26)}%== sets key =Jane= of hash named =age= to =26=
* Example: ==%CALCULATE{$SETHASH(age, Jane,)}%== sets key =Jane= of hash named =age= to an empty value
* Example: ==%CALCULATE{$SETHASH(age, Jane)}%== deletes key =Jane= of hash named =age=
* Example: ==%CALCULATE{$SETHASH(age)}%== deletes hash named =age=
* Example: ==%CALCULATE{$SETHASH()}%== deletes all hashes
* Related: =[[#FuncGET][$GET()]]=, =[[#FuncGETHASH][$GETHASH()]]=, =[[#FuncHASH2LIST][$HASH2LIST()]]=, =[[#FuncHASHCOPY][$HASHCOPY()]]=, =[[#FuncHASHEACH][$HASHEACH()]]=, =[[#FuncHASHEXISTS][$HASHEXISTS()]]=, =[[#FuncHASHREVERSE][$HASHREVERSE()]]=, =[[#FuncLIST2HASH][$LIST2HASH()]]=, =[[#FuncSET][$SET()]]=, =[[#FuncSETLIST][$SETLIST()]]=, =[[#FuncSETMHASH][$SETMHASH()]]=
#FuncSETIFEMPTY
---+++ SETIFEMPTY( name, value ) -- set a variable only if empty
* Specify the variable name (alphanumeric characters and underscores) and the value.
* Syntax: ==$SETIFEMPTY( name, value )==
* Example: ==%CALCULATE{$SETIFEMPTY(result, default)}%== sets the =result= variable to =default= if the variable is empty or 0; in any case an empty string is returned
* Related: =[[#FuncGET][$GET()]]=, =[[#FuncSET][$SET()]]=, =[[#FuncSETHASH][$SETHASH()]]=, =[[#FuncSETMHASH][$SETMHASH()]]=
#FuncSETLIST
---+++ SETLIST( name, list ) -- save a list for later use
* Specify the variable name (alphanumeric characters and underscores) and the list. This function returns no output. Use =$GETLIST()= to retrieve a list variable. Use =$ADDLIST()= to add a list to an existing variable. If no list is specified, the named variable is deleted.
* Syntax: ==$SETLIST( name, list )==
* Example: ==%CALCULATE{$SETLIST(octals, 0, 1, 2, 3, 4, 5, 6, 7)}%== sets the =octals= variable to =0, 1, 2, 3, 4, 5, 6, 7=
* Example: ==%CALCULATE{$SETLIST(octals)}%== deletes the =octals= variable
* Related: =[[#FuncADDLIST][$ADDLIST()]]=, =[[#FuncGETLIST][$GETLIST()]]=, =[[#FuncSET][$SET()]]=, =[[#FuncSETHASH][$SETHASH()]]=, %SYSTEMWEB%.SetGetPlugin
#FuncSETM
---+++ SETM( name, formula ) -- modify an existing variable!! based on a formula
* Specify the variable name (alphanumeric characters and underscores) and the formula. The formula must start with an operator to ==+== (add), ==-== (subtract), ==*== (multiply), or ==/== (divide) something to the variable. This function returns no output. Use =$GET()= to retrieve variables
* Syntax: ==$SETM( name, formula )==
* Example: ==%CALC{$SETM(total, + $SUM($LEFT()))}%== adds the sum of all table cells on the left to the =total= variable, and returns an empty string
* Related: =[[#FuncGET][$GET()]]=, =[[#FuncSET][$SET()]]=, =[[#FuncSETHASH][$SETHASH()]]=, =[[#FuncSETIFEMPTY][$SETIFEMPTY()]]=, =[[#FuncSETMHASH][$SETMHASH()]]=, =[[#FuncWHILE][$WHILE()]]=
#FuncSETMHASH
---+++ SETMHASH( name, key, formula ) -- modify an existing hash!! based on a formula
* Specify the hash name, key, and formula. Allowed characters for the hash name are alphanumeric characters, underscores and period. The formula must start with an operator to ==+== (add), ==-== (subtract), ==*== (multiply), or ==/== (divide) something to the hash variable. This function returns no output. Use =$GETHASH()= or =$HASH2LIST= to retrieve the values
* Syntax: ==$SETMHASH( name, key, formula )==
* Examples: %BR% ==%CALCULATE{$SETHASH(count)}%== deletes the count hash %BR% ==%CALCULATE{$SET(people, Anna, Jane, Berta, Charlie, Jane, Tom, Anna, Jane))}%== sets the people list %BR% ==%CALCULATE{$LISTJOIN(, $LISTEACH($SETMHASH(count, $item, +1), $GET(people)))}%== populates the count hash and returns nothing %BR% ==%CALCULATE{$HASH2LIST(count, $key: $value)}%== returns =Anna: 2, Berta: 1, Charlie: 1, Jane: 3, Tom: 1=
* Related: =[[#FuncGET][$GET()]]=, =[[#FuncGETHASH][$GETHASH()]]=, =[[#FuncHASH2LIST][$HASH2LIST()]]=, =[[#FuncHASHCOPY][$HASHCOPY()]]=, =[[#FuncHASHEACH][$HASHEACH()]]=, =[[#FuncHASHEXISTS][$HASHEXISTS()]]=, =[[#FuncHASHREVERSE][$HASHREVERSE()]]=, =[[#FuncLIST2HASH][$LIST2HASH()]]=, =[[#FuncSET][$SET()]]=, =[[#FuncSETHASH][$SETHASH()]]=, =[[#FuncWHILE][$WHILE()]]=
#FuncSIGN
---+++ SIGN( num ) -- sign of a number
* Returns -1 if ==num== is negative, 0 if zero, or 1 if positive
* Syntax: ==$SIGN( num )==
* Example: ==%CALCULATE{$SIGN(-12.5)}%== returns ==-1==
* Related: =[[#FuncABS][$ABS()]]=, =[[#FuncEVAL][$EVAL()]]=, =[[#FuncEVEN][$EVEN()]]=, =[[#FuncINT][$INT()]]=, =[[#FuncISDIGIT][$ISDIGIT()]]=, =[[#FuncNOT][$NOT()]]=, =[[#FuncODD][$ODD()]]=
#FuncSPLIT
---+++ SPLIT( separator, text ) -- split a string into a list
* Split =text= into a list using =separator= as a delimiter. The =separator= may be a regular expression and may include =$comma= for comma, =$sp= for space and =$empty= to split at each character. Default separator is one or more spaces (=$sp$sp*=).
* Syntax: ==$SPLIT( separator, text )==
* Example: ==%CALCULATE{$SPLIT(, Apple Orange Kiwi)}%== returns ==Apple, Orange, Kiwi==
* Example: ==%CALCULATE{$SPLIT(-, Apple-Orange-Kiwi)}%== returns ==Apple, Orange, Kiwi==
* Example: ==%CALCULATE{$SPLIT([-:]$sp*, Apple-Orange: Kiwi)}%== returns ==Apple, Orange, Kiwi== (the separator means: Dash or colon, followed by optional spaces
* Example: ==%CALCULATE{$SPLIT($empty, Apple)}%== returns ==A, p, p, l, e==
* Related: =[[#FuncLIST][$LIST()]]=, =[[#FuncLISTJOIN][$LISTJOIN()]]=, =[[#FuncLISTSIZE][$LISTSIZE()]]=
#FuncSQRT
---+++ SQRT( num ) -- square root of a number
* Syntax: ==$SQRT( num )==
* Example: ==%CALCULATE{$SQRT(16)}%== returns ==4==
#FuncSTDEV
---+++ STDEV( list ) -- standard deviation based on a sample
* Calculates the standard deviation, assuming that the =list= is a sample of the population. Use =[[#FuncSTDEVP][$STDEVP()]]= if your data represents the entire population. The standard deviation is a measure of how widely values are dispersed from the average (mean) value.
* Syntax: ==$STDEV( list )==
* Example: ==%CALC{$STDEV(R2:C5..R$ROW(-1):C5)}%== returns the standard deviation of column 5, excluding the title row
* Example: ==%CALCULATE{$STDEV(3.50, 5.00, 7.23, 2.99)}%== returns ==1.90205152401295==
* Related: =[[#FuncAVERAGE][$AVERAGE()]]=, =[[#FuncLIST][$LIST()]]=, =[[#FuncMAX][$MAX()]]=, =[[#FuncMEDIAN][$MEDIAN()]]=, =[[#FuncMIN][$MIN()]]=, =[[#FuncPERCENTILE][$PERCENTILE()]]=, =[[#FuncSTDEVP][$STDEVP()]]=, =[[#FuncVAR][$VAR()]]=, =[[#FuncVARP][$VARP()]]=
#FuncSTDEVP
---+++ STDEVP( list ) -- standard deviation based on the entire population
* Calculates the standard deviation, assuming that the =list= is the entire population. Use =[[#FuncSTDEV][$STDEV()]]= if your data represents a sample of the population. The standard deviation is a measure of how widely values are dispersed from the average (mean) value.
* Syntax: ==$STDEVP( list )==
* Example: ==%CALC{$STDEVP(R2:C5..R$ROW(-1):C5)}%== returns the standard deviation of column 5, excluding the title row
* Example: ==%CALCULATE{$STDEVP(3.50, 5.00, 7.23, 2.99)}%== returns ==1.64722493910213==
* Related: =[[#FuncAVERAGE][$AVERAGE()]]=, =[[#FuncLIST][$LIST()]]=, =[[#FuncMAX][$MAX()]]=, =[[#FuncMEDIAN][$MEDIAN()]]=, =[[#FuncMIN][$MIN()]]=, =[[#FuncMAX][$MAX()]]=, =[[#FuncMIN][$MIN()]]=, =[[#FuncPERCENTILE][$PERCENTILE()]]=, =[[#FuncSTDEV][$STDEV()]]=, =[[#FuncVAR][$VAR()]]=, =[[#FuncVARP][$VARP()]]=
#FuncSUBSTITUTE
---+++ SUBSTITUTE( text, old, new, instance, option ) -- substitute text
* 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 ==r==
* Syntax: ==$SUBSTITUTE( text, old, _new_, _instance_, _option_ )==
* Example: ==%CALCULATE{$SUBSTITUTE(Good morning, morning, day)}%== returns ==Good day==
* Example: ==%CALCULATE{$SUBSTITUTE(Q2-2012, 2, 3)}%== returns ==Q3-3013==
* Example: ==%CALCULATE{$SUBSTITUTE(Q2-2012, 2, 3, 3)}%== returns ==Q2-2013==
* Example: ==%CALCULATE{$SUBSTITUTE(abc123def, [0-9], 9, , r)}%== returns ==abc999def==
* Related: =[[#FuncBITXOR][$BITXOR()]]=, =[[#FuncFILTER][$FILTER()]]=, =[[#FuncHEXDECODE][$HEXDECODE()]]=, =[[#FuncHEXENCODE][$HEXENCODE()]]=, =[[#FuncINSERTSTRING][$INSERTSTRING()]]=, =[[#FuncLEFTSTRING][$LEFTSTRING()]]=, =[[#FuncRANDSTRING][$RANDSTRING()]]=, =[[#FuncREPLACE][$REPLACE()]]=, =[[#FuncRIGHTSTRING][$RIGHTSTRING()]]=, =[[#FuncSUBSTRING][$SUBSTRING()]]=, =[[#FuncTRANSLATE][$TRANSLATE()]]=
#FuncSUBSTRING
---+++ SUBSTRING( text, start, num ) -- extract a substring out of a text string
* Extract =num= number of characters of text string =text=, starting at =start=. Starting position is 1; use a negative =start= to count from the end of the text. All parameters are required - the text may contain commas.
* Syntax: ==$SUBSTRING( text, start, num )==
* Example: ==%CALCULATE{$SUBSTRING(abcdefghijk, 3, 5)}%== returns ==cdefg==
* Related: =[[#FuncFILTER][$FILTER()]]=, =[[#FuncFIND][$FIND()]]=, =[[#FuncINSERTSTRING][$INSERTSTRING()]]=, =[[#FuncLEFTSTRING][$LEFTSTRING()]]=, =[[#FuncRANDSTRING][$RANDSTRING()]]=, =[[#FuncREPLACE][$REPLACE()]]=, =[[#FuncRIGHTSTRING][$RIGHTSTRING()]]=, =[[#FuncSEARCH][$SEARCH()]]=, =[[#FuncSUBSTITUTE][$SUBSTITUTE()]]=, =[[#FuncTRANSLATE][$TRANSLATE()]]=
#FuncSUM
---+++ SUM( list ) -- sum of a list or range of cells
* Syntax: ==$SUM( list )==
* Example: To sum up column 5 excluding the title row, write ==%CALC{$SUM(R2:C5..R$ROW(-1):C5)}%== in the last row; or simply ==%CALC{$SUM($ABOVE())}%==
* Related: =[[#FuncLIST][$LIST()]]=, =[[#FuncPRODUCT][$PRODUCT()]]=, =[[#FuncSUMPRODUCT][$SUMPRODUCT()]]=, =[[#FuncWORKINGDAYS][$WORKINGDAYS()]]=
#FuncSUMDAYS
---+++ SUMDAYS( list ) -- sum the days in a list or range of cells
* 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 ==h==, ==hours==, ==d==, ==days==, ==w==, ==weeks== suffix. One week is assumed to have 5 working days, one day 8 hours
* Syntax: ==$SUMDAYS( list )==
* Example: ==%CALCULATE{$SUMDAYS(2w, 1, 2d, 4h)}%== returns ==13.5==, the evaluation of =(2*5 + 1 + 2 + 4/8)=
* Related: =[[#FuncSUM][$SUM()]]=, =[[#FuncTIME][$TIME()]]=, =[[#FuncFORMATTIME][$FORMATTIME()]]=
#FuncSUMPRODUCT
---+++ SUMPRODUCT( list, list ) -- scalar product on ranges of cells
* Syntax: ==$SUMPRODUCT( list, list, _list..._ )==
* Example: ==%CALC{$SUMPRODUCT(R2:C1..R4:C1, R2:C5..R4:C5)}%== evaluates and returns the result of ==($T(R2:C1) * $T(R2:C5) + $T(R3:C1) * $T(R3:C5) + $T(R4:C1) * $T(R4:C5))==
* Related: =[[#FuncLIST][$LIST()]]=, =[[#FuncPRODUCT][$PRODUCT()]]=, =[[#FuncSUM][$SUM()]]=
#FuncT
---+++ T( address ) -- content of a cell
* Syntax: ==$T( address )==
* Example: ==%CALC{$T(R1:C5)}%== returns the text in cell ==R1:C5==
* Related: =[[#FuncCOLUMN][$COLUMN()]]=, =[[#FuncROW][$ROW()]]=
#FuncTIME
---+++ TIME( text ) -- convert a date string into a serialized date number
* 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=; =31 Dec 2003 - 23:59=; =31 Dec 2003 - 23:59:59=; =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=. DOY (Day of Year) formats: =DOY2003.365=, =DOY2003.365.23.59=, =DOY2003.365.23.59.59=. Date is assumed to be server time; add =GMT= to indicate Greenwich time zone
* Syntax: ==$TIME( _text_ )==
* Example: ==%CALCULATE{$TIME(2003/10/14 GMT)}%== returns ==1066089600==
* Related: =[[#FuncFORMATGMTIME][$FORMATGMTIME()]]=, =[[#FuncFORMATTIME][$FORMATTIME()]]=, =[[#FuncFORMATTIMEDIFF][$FORMATTIMEDIFF()]]=, =[[#FuncTIMEADD][$TIMEADD()]]=, =[[#FuncTIMEDIFF][$TIMEDIFF()]]=, =[[#FuncTODAY][$TODAY()]]=, =[[#FuncWORKINGDAYS][$WORKINGDAYS()]]=
#FuncTIMEADD
---+++ TIMEADD( serial, value, unit ) -- add a value to a serialized date
* 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
* Syntax: ==$TIMEADD( serial, value, _unit_ )==
* Example: ==%CALCULATE{$TIMEADD($TIME(), 2, week)}%== returns the serialized date two weeks from now
* Related: =[[#FuncFORMATTIME][$FORMATTIME()]]=, =[[#FuncFORMATGMTIME][$FORMATGMTIME()]]=, =[[#FuncTIME][$TIME()]]=, =[[#FuncTIMEDIFF][$TIMEDIFF()]]=, =[[#FuncTODAY][$TODAY()]]=
#FuncTIMEDIFF
---+++ TIMEDIFF( serial_1, serial_2, unit ) -- time difference!! between two serialized dates
* The =unit= is seconds if not specified; unit can be specified as in =$TIMEADD()=.
* Notes: An approximation is used for month and year calculations. Use =$ROUND()= to round =day= unit to account for daylight savings time change. Use =$FORMAT()=, =$FORMATTIMEDIFF()= or =$INT()= to format real numbers
* Syntax: ==$TIMEDIFF( serial_1, serial_2, _unit_ )==
* Example: ==%CALCULATE{$TIMEDIFF($TIME(), $EVAL($TIME()+90), minute)}%== returns ==1.5==
* Example: ==%CALCULATE{$ROUND($TIMEDIFF($TIME(2012-12-06),$TIME(2012-12-13), day))}%== returns ==7== (or ==6.95833333333333== without the =$ROUND()=)
* Related: =[[#FuncFORMAT][$FORMAT()]]=, =[[#FuncFORMATGMTIME][$FORMATGMTIME()]]=, =[[#FuncFORMATTIME][$FORMATTIME()]]=, =[[#FuncFORMATTIMEDIFF][$FORMATTIMEDIFF()]]=, =[[#FuncINT][$INT()]]=, =[[#FuncTIME][$TIME()]]=, =[[#FuncTIMEADD][$TIMEADD()]]=, =[[#FuncTODAY][$TODAY()]]=, =[[#FuncWORKINGDAYS][$WORKINGDAYS()]]=
#FuncTODAY
---+++ TODAY( ) -- serialized date of today at midnight GMT
* 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
* Syntax: ==$TODAY( )==
* Example: ==%CALCULATE{$TODAY()}%== returns the number of seconds since Epoch
* Related: =[[#FuncFORMATTIME][$FORMATTIME()]]=, =[[#FuncFORMATGMTIME][$FORMATGMTIME()]]=, =[[#FuncTIME][$TIME()]]=, =[[#FuncTIMEADD][$TIMEADD()]]=, =[[#FuncTIMEDIFF][$TIMEDIFF()]]=
#FuncTRANSLATE
---+++ TRANSLATE( text, from, to ) -- translate text!! from one set of characters to another
* The translation is done =from= a set =to= a set, one character by one. The =text= may contain commas; all three parameters are required. The =from= and =to= parameters support tokens =$comma= for comma, =$sp= for space, =$quot= for double quote, =$aquot= for apostrophe quote, and =$n= for newline
* Syntax: ==$TRANSLATE( text, from, to )==
* Example: ==%CALCULATE{$TRANSLATE(boom,bm,cl)}%== returns ==cool==
* Example: ==%