%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.
Example:
| Interactive example: | |||||||||||||||
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.) | ||||||||||||||||
%CALC{"..."}% variable, which gets rendered according to the built-in function(s) found between the quotes.
$FUNCNAME(parameter)
%CALC{"$SUM( R2:C$COLUMN(0)..R$ROW(-1):C$COLUMN(0) )"}%
%CALC{"$SUM( 3, 5, 7 )"}%
R1:C1. Table address matrix:
R1:C1 | R1:C2 | R1:C3 | R1:C4 |
R2:C1 | R2:C2 | R2:C3 | R2:C4 |
"..", e.g. "row 1 through 20, column 3" is: R1:C3..R20:C3
%CALC{"$SUM( 3, 5, $T(R1:C7), R1:C11..R1:C15 )"}%
( bold )
( bold italic )
$ABOVE( )
%CALC{"$SUM($ABOVE())"}% returns the sum of cells above the current cell
$LEFT(), $RIGHT()
$ABS( num )
%CALC{"$ABS(-12.5)"}% returns 12.5
$SIGN()
$AVERAGE( list )
%CALC{"$AVERAGE(R2:C5..R$ROW(-1):C5)"}% returns the average of column 5, excluding the title row
$LIST(), $MAX(), $MEDIAN(), $MIN()
$CHAR( number )
%CALC{"$CHAR(97)"}% returns a
$CODE()
$CODE( text )
%CALC{"$CODE(abc)"}% returns 97
$CHAR()
$COLUMN( offset )
%CALC{"$COLUMN()"}% returns 2 for the second column
$ROW(), $T()
$COUNTITEMS( list )
%CALC{"$COUNTITEMS($ABOVE())"}% returns Closed: 1, Open: 2 assuming one cell above the current cell contains Closed and two cells contain Open
$COUNTSTR(), $LIST()
$COUNTSTR( list, str )
%CALC{"$COUNTSTR($ABOVE())"}% counts the number of non empty cells above the current cell
%CALC{"$COUNTSTR($ABOVE(), DONE)"}% counts the number of cells equal to DONE
$COUNTITEMS(), $LIST()
$DEF( list )
%CALC{"$DEF(R1:C1..R1:C3)"}%
$COUNTSTR(), $LISTIF(), $LIST()
$EVAL( formula )
%CALC{"$EVAL( (5 * 3) / 2 + 1.1 )"}% returns 8.6
$INT(), $MOD(), $ROUND(), $VALUE()
1 if they are exactly the same, or 0 if not
$EXACT( text1, text2 )
%CALC{"$EXACT(foo, Foo)"}% returns 0
%CALC{"$EXACT(foo, $LOWER(Foo))"}% returns 1
$IF(), $TRIM()
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.
$FIND( string, text, start )
%CALC{"$FIND(f, fluffy)"}% returns 1
%CALC{"$FIND(f, fluffy, 2)"}% returns 4
%CALC{"$FIND(@, fluffy, 1)"}% returns 0
$REPLACE(), $SEARCH()
$FORMAT( type, prec, number )
%CALC{"$FORMAT(COMMA, 2, 12345.6789)"}% returns 12,345.68
%CALC{"$FORMAT(DOLLAR, 2, 12345.67)"}% returns $12,345.68
%CALC{"$FORMAT(NUMBER, 1, 12345.67)"}% returns 12345.7
%CALC{"$FORMAT(PERCENT, 1, 0.1234567)"}% returns 12.3%
$ROUND()
text are expanded: $second (seconds, 00..59); $minute (minutes, 00..59); $hour (hours, 00..23); $day (day of month, 01..31); $month (month, 01..12); $mon (month in text format, Jan..Dec); $year (4 digit year, 1999); $ye (2 digit year, 99), $wd (day number of the week, 1 for Sunday, 2 for Monday, etc), $wday (day of the week, Sun..Sat), $weekday (day of the week, Sunday..Saturday), $yearday (day of the year, 1..365, or 1..366 in leap years). Date is assumed to be server time; add GMT to indicate Greenwich time zone.
$FORMATTIME( serial, text )
%CALC{"$FORMATTIME(0, $year/$month/$day GMT)"}% returns 1970/01/01 GMT
$FORMATGMTIME(), $TIME(), $TIMEADD(), $TIMEDIFF(), $TODAY()
$FORMATTIME().
$FORMATGMTIME( serial, text )
%CALC{"$FORMATGMTIME(1041379200, $day $mon $year)"}% returns 01 Jan 2003
$FORMATTIME(), $TIME(), $TIMEADD(), $TIMEDIFF(), $TODAY()
$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.
$GET( name )
%CALC{"$GET(my_total)"}% returns the value of the my_total variable
$SET(), $SETM()
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).
$IF( condition, value if true, value if 0 )
%CALC{"$IF($T(R1:C5) > 1000, Over Budget, OK)"}% returns Over Budget if value in R1:C5 is over 1000, OK if not
%CALC{"$IF($EXACT($T(R1:C2),), empty, $T(R1:C2))"}% returns the content of R1:C2 or empty if empty
%CALC{"$SET(val, $IF($T(R1:C2) == 0, zero, $T(R1:C2)))"}% sets a variable conditionally
$AND(), $EXACT(), $LISTIF(), $NOT(), $OR()
$INT( formula )
%CALC{"$INT(10 / 4)"}% returns 2
$EVAL(), $ROUND(), $VALUE()
$LEFT( )
%CALC{"$SUM($LEFT())"}% returns the sum of cells to the left of the current cell
$ABOVE(), $RIGHT()
$LENGTH( text )
%CALC{"$LENGTH(abcd)"}% returns 4
$LISTSIZE()
$LIST( range )
%CALC{"$LIST($LEFT())"}% returns Apples, Lemons, Oranges, Kiwis assuming the cells to the left contain | Apples | Lemons, Oranges | Kiwis |
$AVERAGE(), $COUNTITEMS(), $COUNTSTR(), $DEF(), $LISTIF(), $LISTITEM(), $LISTMAP(), $LISTREVERSE(), $LISTSIZE(), $LISTSORT(), $LISTUNIQUE(), $MAX(), $MEDIAN(), $MIN(), $PRODUCT(), $SUM(), $SUMDAYS(), $SUMPRODUCT()
$IF(), you can use $item to indicate the current element, and $index for the list index, starting at 1
$LISTIF( condition, list )
%CALC{"$LISTIF($item > 12, 14, 7, 25)"}% returns 14, 25
%CALC{"$LISTIF($NOT($EXACT($item,)), A, B, , E)"}% returns non-empty elements A, B, E
%CALC{"$LISTIF($index > 2, A, B, C, D)"}% returns C, D
$IF(), $LIST(), $LISTITEM(), $LISTMAP(), $LISTREVERSE(), $LISTSIZE(), $LISTSORT(), $LISTUNIQUE(), $SUM()
$LISTITEM( index, list )
%CALC{"$LISTITEM(2, Apple, Orange, Apple, Kiwi)"}% returns Orange
%CALC{"$LISTITEM(-1, Apple, Orange, Apple, Kiwi)"}% returns Kiwi
$COUNTITEMS(), $COUNTSTR(), $LIST(), $LISTIF(), $LISTMAP(), $LISTREVERSE(), $LISTSIZE(), $LISTSORT(), $LISTUNIQUE(), $SUM()
$item to indicate the element; $index to show the index of the list, starting at 1
$LISTMAP( formula, list )
%CALC{"$LISTMAP($index: $EVAL(2 * $item), 3, 5, 7, 11)"}% returns 1: 6, 2: 10, 3: 14, 4: 22
$COUNTITEMS(), $COUNTSTR(), $LIST(), $LISTIF(), $LISTITEM(), $LISTREVERSE(), $LISTSIZE(), $LISTSORT(), $LISTUNIQUE(), $SUM()
$LISTREVERSE( list )
%CALC{"$LISTREVERSE(Apple, Orange, Apple, Kiwi)"}% returns Kiwi, Apple, Orange, Apple
$COUNTITEMS(), $COUNTSTR(), $LIST(), $LISTIF(), $LISTITEM(), $LISTMAP(), $LISTSIZE(), $LISTSORT(), $LISTUNIQUE(), $SUM()
$LISTSIZE( list )
%CALC{"$LISTSIZE(Apple, Orange, Apple, Kiwi)"}% returns 4
$COUNTITEMS(), $COUNTSTR(), $LIST(), $LISTIF(), $LISTITEM(), $LISTMAP(), $LISTREVERSE(), $LISTSORT(), $LISTUNIQUE(), $SUM()
$LISTSORT( list )
%CALC{"$LISTSORT(Apple, Orange, Apple, Kiwi)"}% returns Apple, Apple, Kiwi, Orange
$COUNTITEMS(), $COUNTSTR(), $LIST(), $LISTIF(), $LISTITEM(), $LISTMAP(), $LISTREVERSE(), $LISTSIZE(), $LISTUNIQUE(), $SUM()
$LISTUNIQUE( list )
%CALC{"$LISTUNIQUE(Apple, Orange, Apple, Kiwi)"}% returns Apple, Orange, Kiwi
$COUNTITEMS(), $COUNTSTR(), $LIST(), $LISTIF(), $LISTITEM(), $LISTMAP(), $LISTREVERSE(), $LISTSIZE(), $LISTSORT(), $SUM()
$LOWER(text)
%CALC{"$LOWER( $T(R1:C5) )"}% returns the lower case string of the text in cell R1:C5
$PROPER(), $PROPERSPACE(), $TRIM(), $UPPER()
$MAX( list )
%CALC{"$MAX($LEFT())"}%
$LIST(), $MEDIAN(), $MIN()
$MEDIAN( list )
%CALC{"$MEDIAN(3, 9, 4, 5)"}% returns 4.5
$LIST(), $MAX(), $MIN()
$MIN( list )
%CALC{"$MIN(15, 3, 28)"}% returns 3
$LIST(), $MAX(), $MEDIAN()
num by divisor %SEARCH{}% is evaluated. The percent character '%' can be escaped with $per
$NOP( text )
num is not zero, 1 if zero
$NOT( num )
%CALC{"$NOT(0)"}% returns 1
$AND(), $IF(), $OR()
$PRODUCT( list )
%CALC{"$PRODUCT($LEFT())"}%
$LIST(), $PRODUCT(), $SUM(), $SUMPRODUCT()
$PROPER( text )
%CALC{"PROPER(a small STEP)"}% returns A Small Step
%CALC{"PROPER(f1 (formula-1))"}% returns F1 (Formula-1)
$LOWER(), $PROPERSPACE(), $TRIM(), $UPPER()
][. Words listed in the DONTSPACE TWikiPreferences variable or DONTSPACE Plugins setting are excluded
$PROPERSPACE( text )
%CALC{"PROPERSPACE(Old MacDonald had a ServerFarm, EeEyeEeEyeOh"}% returns Old MacDonald had a Server Farm, Ee Eye Ee Eye Oh
$LOWER(), $PROPER(), $TRIM(), $UPPER()
max, or 0 and 1 if max is not specified
$RAND( max )
$EVAL()
$REPEAT( text )
%CALC{"$REPEAT(/\, 5)"}% returns /\/\/\/\/\
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
$REPLACE( text, start, num, new )
%CALC{"$REPLACE(abcdefghijk,6,5,*)"}% returns abcde*k
$FIND(), $SEARCH(), $SUBSTITUTE(), $TRANSLATE()
$RIGHT( )
%CALC{"$SUM($RIGHT())"}% returns the sum of cells to the right of the current cell
$ABOVE(), $LEFT()
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
$ROUND( formula, digits )
%CALC{"$ROUND(3.15, 1)"}% returns 3.2
%CALC{"$ROUND(3.149, 1)"}% returns 3.1
%CALC{"$ROUND(-2.475, 2)"}% returns -2.48
%CALC{"$ROUND(34.9, -1)"}% returns 30
$INT(), $FORMAT()
$ROW( offset )
%CALC{"$ROW(-2)"}%
$COLUMN(), $T()
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
$SEARCH( string, text, start )
%CALC{"$SEARCH([uy], fluffy)"}% returns 3
%CALC{"$SEARCH([uy], fluffy, 3)"}% returns 6
%CALC{"$SEARCH([abc], fluffy,)"}% returns 0
$FIND(), $REPLACE()
$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
$SET( name, value )
%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
$GET(), SETM()
+ (add), - (subtract), * (multiply), or / (divide) something to the variable. This function returns no output. Use $GET() to retrieve variables
$SETM( name, formula )
%CALC{"$SETM(total, + $SUM($LEFT()))"}% adds the sum of all table cells on the left to the total variable, and returns an empty string
$GET(), $SET()
num is negative, 0 if zero, or 1 if positive
$SIGN( num )
%CALC{"$SIGN(-12.5)"}% returns -1
$ABS(), $EVAL(), $INT(), $NOT()
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
$SUBSTITUTE( text, old, new, instance, option )
%CALC{"$SUBSTITUTE(Good morning, morning, day)"}% returns Good day
%CALC{"$SUBSTITUTE(Q2-2002,2,3)"}% returns Q3-3003
%CALC{"$SUBSTITUTE(Q2-2002,2,3,3)"}% returns Q2-2003
%CALC{"$SUBSTITUTE(abc123def,[0-9],9,,r)"}% returns abc999def
$REPLACE(), $TRANSLATE()
$SUM( list )
%CALC{"$SUM(R2:C5..R$ROW(-1):C5)"}% in the last row; or simply %CALC{"$SUM($ABOVE())"}%
$LIST(), $PRODUCT(), $SUMPRODUCT(), $WORKINGDAYS()
h, hours, d, days, w, weeks suffix. One week is assumed to have 5 working days, one day 8 hours
$SUMDAYS( list )
%CALC{"$SUMDAYS(2w, 1, 2d, 4h)"}% returns 13.5, the evaluation of (2*5 + 1 + 2 + 4/8)
$SUM(), $TIME(), $FORMATTIME()
$SUMPRODUCT( list, list, list... )
%CALC{"$SUM(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))
$LIST(), $PRODUCT(), $SUM()
$T( address )
%CALC{"$T(R1:C5)"}% returns the text in cell R1:C5
$COLUMN(), $ROW()
from a set to a set, one character by one. The text may contain commas; all three parameters are required. In the from and to parameters you can write $comma to escape comma, $sp to escape space
$TRANSLATE( text, from, to )
%CALC{"$TRANSLATE(boom,bm,cl)"}% returns cool
%CALC{"$TRANSLATE(one, two,$comma,;)"}% returns one; two
$REPLACE(), $SUBSTITUTE()
31 Dec 2009; 31 Dec 2009 GMT; 31 Dec 09; 31-Dec-2009; 31/Dec/2009; 2009/12/31; 2009-12-31; 2009/12/31; 2009/12/31 23:59; 2009/12/31 - 23:59; 2009-12-31-23-59; 2009/12/31 - 23:59:59; 2009.12.31.23.59.59. Date is assumed to be server time; add GMT to indicate Greenwich time zone
$TIME( text )
%CALC{"$TIME(2003/10/14 GMT)"}% returns 1066089600
$FORMATTIME(), $FORMATGMTIME(), $TIMEADD(), $TIMEDIFF(), $TODAY(), $WORKINGDAYS()
second, minute, hour, day, week, month, year. Note: An approximation is used for month and year calculations
$TIMEADD( serial, value, unit )
%CALC{"$TIMEADD($TIME(), 2, week)"}%
$(), $() returns the serialized date two weeks from now
$FORMATTIME(), $FORMATGMTIME(), $TIME(), $TIMEDIFF(), $TODAY()
$TIMEADD(). Note: An approximation is used for month and year calculations. Use $FORMAT() or $INT() to format real numbers
$TIMEDIFF( serial_1, serial_2, unit )
%CALC{"$TIMEDIFF($TIME(), $EVAL($TIME()+90), minute)"}% returns 1.5
$FORMAT(), $FORMATTIME(), $FORMATGMTIME(), $INT(), $TIME(), $TIMEADD(), $TODAY(), $WORKINGDAYS()
$TIME() returns the serialized date of today at the current time, e.g. it includes the number of seconds since midnight GMT
$TODAY( )
%CALC{"$TODAY()"}% returns the number of seconds since Epoch
$FORMATTIME(), $FORMATGMTIME(), $TIME(), $TIMEADD(), $TIMEDIFF()
$TRIM( text )
%CALC{"$TRIM( eat spaces )"}% returns eat spaces
$EXACT(), $PROPERSPACE()
$UPPER( text )
%CALC{"$UPPER($T(R1:C5))"}% returns the upper case string of the text in cell R1:C5
$LOWER(), $PROPER(), $PROPERSPACE(), $TRIM()
text. Returns 0 if not found
$VALUE( text )
%CALC{"$VALUE(US$1,200)"}% returns 1200
%CALC{"$VALUE(PrjNotebook1234)"}% returns 1234
%CALC{"$VALUE(Total: -12.5)"}% returns -12.5
$EVAL(), $INT()
$WORKINGDAYS( serial_1, serial_2 )
%CALC{"$WORKINGDAYS($TIME(2004/07/15), $TIME(2004/08/03))"}% returns 13
$SUMDAYS(), $TIME(), $TIMEDIFF()
| Bug#: | Priority: | Subject: | Status: | Days to fix |
|---|---|---|---|---|
| Bug:1231 | Low | File Open ... | Open | 3 |
| Bug:1232 | High | Memory Window ... | Fixed | 2 |
| Bug:1233 | Medium | Usability issue ... | Assigned | 5 |
| Bug:1234 | High | No arrange ... | Fixed | 1 |
| Total: 4 | High: 2 Low: 1 Medium: 1 | . | Assigned: 1 Fixed: 2 Open: 1 | Total: 11 |
| Total: %CALC{"$ROW(-2)"}% \
| %CALC{"$COUNTITEMS( R2:C$COLUMN()..R$ROW(-1):C$COLUMN() )"}% | . \
| %CALC{"$COUNTITEMS( R2:C$COLUMN()..R$ROW(-1):C$COLUMN() )"}% \
| Total: %CALC{"$SUM( R2:C$COLUMN()..R$ROW(-1):C$COLUMN() )"}% |
Above table is created manually. Another Plugin could build the table dynamically, e.g. by pulling data out of a bug tracking system. The Spreadsheet Plugin can be used to display table data statistics.
%<plugin>_<setting>%, i.e. %SPREADSHEETPLUGIN_SHORTDESCRIPTION%
"$SUM( $ABOVE() )" to tables located in TWiki topics.
data/debug.txt)
%CALC{}% tag in included topic while including topic: (default: 1)
$PROPERSPACE(text) function. This comma delimited list can be overloaded by a DONTSPACE preferences variable:
SpreadSheetPlugin.zip in your twiki installation directory. Content:
| File: | Description: |
|---|---|
data/TWiki/SpreadSheetPlugin.txt | Plugin topic |
data/TWiki/SpreadSheetPlugin.txt,v | Plugin topic repository |
lib/TWiki/Plugins/SpreadSheetPlugin.pm | Plugin Perl module |
| Plugin Author: | TWiki:Main/PeterThoeny |
| Plugin Version: | 17 Jul 2004 |
| Change History: | |
| 17 Jul 2004: | Added $WORKINGDAYS(), contributed by TWiki:Main/CrawfordCurrie |
| 24 May 2004: | Refactored documentation (no code changes) |
| 03 Apr 2004: | Added $ABS(), $LISTIF(); fixed $VALUE() to remove leading zeros; changed $FIND() and $SEARCH() to return 0 instead of empty string if no match |
| 21 Mar 2004: | Added $LISTITEM(); fixed call to unofficial function |
| 16 Mar 2004: | Added $LISTMAP(), $LISTREVERSE(), $LISTSIZE(), $LISTSORT(), $LISTUNIQUE(), $SETM(); retired $COUNTUNIQUE() in favor of $COUNTITEMS($LISTUNIQUE()); fixed evaluation order issue of $IF(); fixed missing eval error messages suppressed since version 06 Mar 2004; redirect stderr messages to warning |
| 08 Mar 2004: | Added $LIST() |
| 06 Mar 2004: | Added $AND(), $MOD(), $NOT(), $OR(), $PRODUCT(), $PROPER(), $PROPERSPACE(), $RAND(), $REPEAT(), $SIGN(), $VALUE(); added digits parameter to $ROUND(); renamed $MULT() to $PRODUCT(); $MULT() is deprecated and undocumented |
| 27 Feb 2004: | Added $COUNTUNIQUE() |
| 24 Oct 2003: | Added $SET(), $GET(), $MEDIAN(); added $SUMPRODUCT(), inspired by TWiki:Main/RobertWithrow; added $SUMDAYS(), contributed by TWiki:Main/SvenDowideit |
| 21 Oct 2003: | Added support for lists (1, 2, 3) and lists of table ranges (R1:C1..R1:C5, R3:C1..R3:C5) for all functions that accept a table range; added $TIMEADD(); in $TIMEDIFF() added week unit; in $FORMATTIME() changed $weekday to $wd and added $wday and $weekday |
| 14 Oct 2003: | Added $TIME(), $TODAY(), $FORMATTIME(), $FORMATGMTIME(), $TIMEDIFF() |
| 13 Oct 2003: | Added $MULT(), contributed by TWiki:Main/GerritJanBaarda |
| 30 Jul 2003: | Added $TRANSLATE() |
| 19 Jul 2003: | Added $FIND(), $NOP(), $REPLACE(), $SEARCH(), $SUBSTITUTE(), contributed by TWiki:Main/PaulineCheung |
| 19 Apr 2003: | Added $COUNTSTR(), $EXACT(), $IF(), $ROUND(), $TRIM(); added $FORMAT(), contributed by TWiki:Main/JimStraus; support % modulus operator in $EVAL, $INT, and $ROUND; fixed bug in $DEF |
| 07 Jun 2002: | Added $DEF(), contributed by TWiki:Main/MartinFuzzey; allow values with HTML formatting like <u>102</u>, suggested by TWiki:Main/GladeDiviney; added SKIPINCLUDE setting |
| 12 Mar 2002: | Support for multiple functions per nesting level |
| 15 Jan 2002: | Added $CHAR(), $CODE() and $LENGTH() |
| 12 Nov 2001: | Added $RIGHT() |
| 12 Aug 2001: | Fixed bug of disappearing multi-column cells |
| 19 Jul 2001: | Fixed incorrect $SUM calculation of cell with value 0 |
| 14 Jul 2001: | Changed to plug & play |
| 01 Jun 2001: | Fixed insecure dependencies for $MIN and $MAX |
| 16 Apr 2001: | Fixed div by 0 bug in $AVERAGE |
| 17 Mar 2001: | Initial version |
| CPAN Dependencies: | none |
| TWiki:Plugins/Benchmark: | GoodStyle 99%, FormattedSearch 99%, SpreadSheetPlugin 95% |
| Other Dependencies: | none |
| Perl Version: | 5.000 and up |
| Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/SpreadSheetPlugin |
| Feedback: | http://TWiki.org/cgi-bin/view/Plugins/SpreadSheetPluginDev |