This plugin adds spreadsheet capabilities to TWiki topics. Formulae like %CALC{"$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 formula evaluation capability, not just classic spreadsheet functions.
> >
This plugin adds spreadsheet capabilities to TWiki topics. Functions such as %CALC{$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
The formula next to "Total" is %CALC{"$SUM( $ABOVE() )"}%. (you see the formula instead of the sum in case the plugin is not installed or not enabled.)
> >
The formula next to "Total" is %CALC{$SUM( $ABOVE() )}%. (you see the formula instead of the sum in case the plugin is not installed or is not enabled.)
The action of this plugin is triggered by the %CALC{"..."}% variable, which gets rendered according to the built-in function(s) found between the quotes.
> >
This plugin handles the %CALC{...}% and %CALCULATE{...}% variables. Built-in functions found between the quotes are evaluated as follows:
Built-in function are of format $FUNCNAME(parameter)
Changed:
< <
Functions may be nested, such as %CALC{"$SUM( R2:C$COLUMN(0)..R$ROW(-1):C$COLUMN(0) )"}%
> >
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
The function parameter can be text; a mathematical formula; a cell address; or a range of cell addresses
Changed:
< <
Multiple parameters form a list; they are separated by a comma, followed by optional space, such as %CALC{"$SUM( 3, 5, 7 )"}%
> >
Multiple parameters form a list; they are separated by a comma, followed by optional space, such as %CALC{$SUM( 3, 5, 7 )}%
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
Changed:
< <
Lists can refer to values and/or table cell ranges, such as %CALC{"$SUM( 3, 5, $T(R1:C7), R1:C11..R1:C15 )"}%
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
Formulae can also be placed outside of tables; they can reference cells in the preceeding table
Plain text can be added, such as %CALC{Total: $SUM($ABOVE()) kg}%
Changed:
< <
Built-in Functions
> >
Use CALC or CALCULATE
Changed:
< <
Conventions for Syntax:
> >
Use %CALC{...}%in table cells: The CALC variable handles all functions, but it gets handled with delay compared to other 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.
Use %CALCULATE{...}%outside tables: 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 252 functions. Convention for parameters:
Required parameters are indicated in ( bold )
Optional parameters are indicated in ( bold italic )
ABOVE( ) -- address range of cells above the current cell
Syntax: $ABOVE( )
Changed:
< <
Example: %CALC{"$SUM($ABOVE())"}% returns the sum of cells above the current cell
> >
Example: %CALC{$SUM($ABOVE())}% returns the sum of cells above the current cell
COUNTITEMS( list ) -- count individual items in a list
Syntax: $COUNTITEMS( list )
Changed:
< <
Example: %CALC{"$COUNTITEMS($ABOVE())"}% returns Closed: 1, Open: 2 assuming one cell above the current cell contains Closed and two cells contain Open
> >
Example: %CALC{$COUNTITEMS($ABOVE())}% returns Closed: 1, Open: 2 assuming one cell above the current cell contains Closed and two cells contain Open
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)
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 )
Changed:
< <
Example: %CALC{"$SET(msg, $NOEXEC(Hi $GET(name)))"}% sets the msg variable with raw formula Hi $GET(name)
Example: %CALC{"$SET(name, Tom) $EXEC($GET(msg))"}% executes content of msg variable and returns Hi Tom
Example: %CALC{"$SET(name, Jerry) $EXEC($GET(msg))"}% returns Hi Jerry
> >
Example: %CALC{$SET(msg, $NOEXEC(Hi $GET(name)))}% sets the msg variable with raw formula Hi $GET(name)
Example: %CALC{$SET(name, Tom) $EXEC($GET(msg))}% executes content of msg variable and returns Hi Tom
Example: %CALC{$SET(name, Jerry) $EXEC($GET(msg))}% returns Hi Jerry
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 RegularExpression. Use tokens in the expression if needed: $comma for comma, $sp for space. The text may contain commas.
Syntax: $FILTER( chars, text )
Example: %CALC{$FILTER(f, fluffy)}% returns luy - filter out a character multiple times
Example: %CALC{$FILTER(an Franc, San Francisco)}% returns Sisco - cut a string
Example: %CALC{$FILTER($sp, Cat and Mouse)}% returns CatandMouse - remove all spaces
Example: %CALC{$FILTER([^0-9], Project-ID-1234)}% returns 1234 - filter in digits, e.g. keep only digits
Example: %CALC{$FILTER([^a-zA-Z0-9 ], Stupid mistake*%@^! Fixed)}% returns Stupid mistake Fixed - keep only alphanumeric characters and spaces
Example: %CALC{$FILTER([^a-zA-Z0-9], $PROPER(an EXELLENT idea.))}% returns AnExcellentIdea - turn a string into a WikiWord topic name
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.
GET( name ) -- get the value of a previously set 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 )
Changed:
< <
Example: %CALC{"$GET(my_total)"}% returns the value of the my_total variable
> >
Example: %CALC{$GET(my_total)}% returns the value of the my_total variable
IF( condition, value if true, value if 0 ) -- 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 )
Changed:
< <
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
INT( formula ) -- evaluate formula and return integer truncated towards 0
Line: 332 to 362
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 ) )
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 )
Changed:
< <
Example: %CALC{"$LISTJOIN($n, Apple, Orange, Apple, Kiwi)"}% returns the four items separated by new lines
LISTMAP( formula, list ) -- evaluate and update each element of a list
In the formula you can use $item to indicate the element; $index to show the index of the list, starting at 1. If $item is omitted, the item is appended to the formula.
PROPERSPACE( text ) -- properly space out WikiWords
Properly spaces out WikiWords preceeded by white space, parenthesis, or ][. Words listed in the DONTSPACE TWikiPreferences variable or DONTSPACE plugins setting are excluded
Syntax: $PROPERSPACE( text )
Changed:
< <
Example: Assuming DONTSPACE contains MacDonald: %CALC{"$PROPERSPACE(Old MacDonald had a ServerFarm, EeEyeEeEyeOh)"}% returns Old MacDonald had a Server Farm, Ee Eye Ee Eye Oh
Example: Assuming DONTSPACE contains MacDonald: %CALC{$PROPERSPACE(Old MacDonald had a ServerFarm, EeEyeEeEyeOh)}% returns Old MacDonald had a Server Farm, Ee Eye Ee Eye Oh
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
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
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 RegularExpression search; use $FIND() for non-regular expression searching. Starting position is 1; a 0 is returned if nothing is matched
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; formulae are evaluated before the variable assignment; see $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
Syntax: $SET( name, value )
Changed:
< <
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
> >
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
SETIFEMPTY( name, value ) -- set a variable only if empty
Specify the variable name (alphanumeric characters and underscores) and the value.
Syntax: $SETIFEMPTY( name, value )
Changed:
< <
Example: %CALC{"$SETIFEMPTY(result, default)"}% sets the result variable to default if the variable is empty or 0; in any case an empty string is returned
> >
Example: %CALC{$SETIFEMPTY(result, default)}% sets the result variable to default if the variable is empty or 0; in any case an empty string is returned
SETM( name, formula ) -- update 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 )
Changed:
< <
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
> >
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
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 )
Changed:
< <
Example: %CALC{"$SPLIT(, Apple Orange Kiwi)"}% returns Apple, Orange, Kiwi
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 RegularExpression search if the option is set to r
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
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 )
Changed:
< <
Example: %CALC{"$SUMDAYS(2w, 1, 2d, 4h)"}% returns 13.5, the evaluation of (2*5 + 1 + 2 + 4/8)
> >
Example: %CALC{$SUMDAYS(2w, 1, 2d, 4h)}% returns 13.5, the evaluation of (2*5 + 1 + 2 + 4/8)
SUMPRODUCT( list, list ) -- scalar product on ranges of cells
Syntax: $SUMPRODUCT( list, list, list... )
Changed:
< <
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))
> >
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))
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. In the from and to parameters you can add token $comma for comma, $sp for space, and $n for newline
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
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 )
Changed:
< <
Example: %CALC{"$TIMEADD($TIME(), 2, week)"}% returns the serialized date two weeks from now
> >
Example: %CALC{$TIMEADD($TIME(), 2, week)}% returns the serialized date two weeks from now
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
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. In the from and to parameters you can add token $comma for comma, $sp for space, and $n for newline
WHILE( condition, do ) -- do something while a condition is true
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).
The condition and do are evaluated in each cycle; a $counter starting at 1 can be used in condition and do.
Specifically, how can I output some conditional text in a FormattedSearch?
Changed:
< <
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:
> >
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), %ICONURL{choice-yes}%, %ICONURL{choice-no}%) in the format="" parameter, write this:
Above table is created manually. The table can be build dynamically with a formatted search, or by a plugin that pulls data from an external source, such as a bug tracking system.
> >
Above table is created manually. The table can be build dynamically with a formatted search, or by a plugin that pulls data from an external source, such as a bug tracking system.
Plugin Settings
Line: 863 to 927
Plugin Installation Instructions
Changed:
< <
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.
> >
Note: This plugin is pre-installed. TWiki administrators can upgrade it as needed on the TWiki server.
For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.
Changed:
< <
Download the ZIP file from the SpreadSheetPlugin home
> >
Or, follow these manual installation steps:
Download the ZIP file from the Plugins home (see below).
Unzip SpreadSheetPlugin.zip in your twiki installation directory. Content:
TWikibug:Item6866: Added CALCULATE variable using register tag handler to support proper inside-out, left-to-right eval order like ordinary TWiki variables
Use 
Use 
Copyright © 1999-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.