This server will be upgraded at 3pm Sydney time on December 3rd (December 2nd, 8pm PST) and will be down for up to 30 minutes.

Excel Plugin

Description | Security | Compatibility | Documentation | Usage | Release History | Open Issues
Name Excel Plugin
Vendor Bob Swift and other contributors
Authors Bob Swift
Homepage http://confluence.atlassian.com/display/CONFEXT/Excel+Plugin
Issue Management http://developer.atlassian.com/jira/browse/XL
Continuous Integration n/a
Categories Content Macros
Most Recent Version 3.5.0
Availability Confluence v2.5.2 to v2.10
State Stable
Support Unsupported Plugins
License Freeware / Open Source (BSD)
Price Free
Release Docs http://confluence.atlassian.com/display/CONFEXT/Excel+Plugin
Java API Docs n/a
Download Source http://svn.atlassian.com/svn/public/contrib/confluence/excel-plugin/trunk
Download JAR excel-plugin-3.5.0.jar

Additions and corrections to above

JVM requirements Java 1.4 and above
Installation requirements Confluence Repository Client
or upload from Confluence's administration console.
Cannot be installed in /WEB-INF/lib

Description

Generate Confluence tables from Excel worksheets. Support is based on JExcelApi which supports data from Excel 95, 97, 2000, XP, and 2003 workbooks. Excel 2007 .xlsx format is not currently supported.

Supports Common table capabilities and Macro Security Plugin

Security

The url parameter is restricted to trusted user by configuring security using the Macro Security Plugin.

Security migration from 3.4.0 and earlier

Macro security users upgrading to 3.5.0 or above from 3.4.0 or earlier must install and config the Macro Security Plugin to retain your security setting for the url parameter.

Downloads

Date 2008-Jun 2008-Jul 2008-Aug 2008-Sep 2008-Oct 2008-Nov 2008-Dec
Hits 572 593 501 457 467 347 24

Compatibility

Plugin 2.2 2.3 2.4 2.5 2.6 2.7 2.8 Tested release Macro security
3.5.0 2.5.2, 2.7.1, 2.8 Macro Security Plugin
3.4.0 2.5.2, 2.7.1 included
3.3.0 2.4.2, 2.5.2 included
3.2.x 2.2.9 included
3.1.0 2.2.8 included
3.0.x 2.2.8 included

Documentation

  • Also see the Notation guide on your installation after installing the plugin.

Parameters

In addition to the parameters listed below, this macro supports Common table capabilities.

  • file - Location of excel file. Either file or url is required.
    • ^attachment - Data is read from an attachment to the current page.
    • page^attachment - Data is read from an attachment to the page name provided.
    • space:page^attachment - Data is read from an attachment to the page name provided in the space indicated.
    • filename - Data is read from the file located in /script/filename. Subdirectories can be specified.
  • url - Only required if file is not specified. Specifies the URL of an Excel file.
    • Use of this parameter may be restricted for security reasons. See your administrator for details. See Macro Security Plugin.
  • sheets - By default, each sheet in the workbook will produce a table. Use the sheets parameter to control what sheets will be shown. The parameter value can be a comma separated list of sheet names (case sensitive) or sheet numbers (1-based counting)
  • columns - A comma separated list of column numbers used to select and order columns to be shown. If columns is specified, even hidden columns will be shown.
  • output - Determines how the output is formated:
    • html - Data is output as a HTML table (default).
    • wiki - Data is output as a Confluence wiki table. Use this option if you want data within the table to be formated by the Confluence wiki renderer.
  • heading - Number of rows to be considered heading rows (default is 1 row). Specify heading=false or heading=0 to not show any heading lines.
  • border - The border width in pixels. Defaults to normal table border width.
  • width - The table width in pixels. Default is 100%.
  • showHidden - By default, hidden sheets, rows, and columns will not be shown. Set showHidden=true to show all data.
  • showSheetName - By default, the sheet name will not be shown. Set showSheetName=true to show a the sheet name before the table.
  • formatCell - By default, no special formating will be applied to the cells. Set formatCell=true to process each cell for special properties. Currently supported properties are:
    • html - Alignment, font, and background color.
    • wiki - None at this time for individual cells. For columns, formatColumn can be used. Another alternative is to use columnAttributes from Common table capabilities.
  • formatColumn - By default, the format for a column will be used to apply formating for all cells in the column. Set formatColumn=false to not use the column formating information from the excel sheet. Note that this parameter is ignored if formatCell=true or columnAttributes are specified.
  • showWiki - Default is false. Set to true to show a non-formatted version of the wiki table following the formatted table. This is used to help resolve formating issues. It can also be used to convert an Excel spreadsheet to Confluence markup by cut and paste. Excel to Confluence Converter is an alternative way to do this.
  • escape - The '|' character in data can cause formatting of the table to be incorrect because it is interpreted as a column boundary. Set escape=true to allow this character to be escaped so that it will not affect the formatting. The default is false so that things like wiki links are handled correctly.
  • hyperlinks - Default is true. Set to false to disable inclusion of cell hyperlinks.
  • ignoreTrailingBlankRows - By default, all trailing blank rows will be ignored. Set ignoreTrailingBlankRows=false to show these blank rows.
  • ignoreTrailingBlankColumns - By default, all trailing blank columns will be ignored. Set ignoreTrailingBlankColumns=false to show these blank columns.
  • language - If provided, the language and country specification will be used to provide number and date formats to be used for data conversion. This specification will be used before the default languages automatically used. Valid values are 2 character ISO 639-1 alpha-2 codes.
  • country - Used in combination with the language parameter. Valid values are 2 character ISO 3166 codes.

Usage

Simple attachment

{excel:file=^Report.xls}

Sheet selection

{excel:file=Year 2005^Report.xls|sheet=First Quarter, Second Quarter}
Accessing a file in confluence home directory .../script/excel files
{excel:file=/excel files/Report.xls|sheet=1,2,4}

Compatibility With Other Macros

Release History

Version Date State License Price
Show description 3.5.0 (#8) 29 Apr 2008 Stable Freeware / Open Source (BSD) Free

Release Notes

Jira Issues
Key Priority Summary Updated asignee Reporter Status
XL-50 Major in Conf 2.8.1/excel 3.5.0 - Linking to pages in other spaces doesnt render Jun 27, 2008 Andy Brook Open
XL-47 Major Image Handling of displaying Excel-Sheet Nov 21, 2008 Frank Stiller Resolved
XL-46 Major Upgrade to use Macro Security Plugin Apr 29, 2008 Bob Swift Closed
XL-45 Critical Attaching an Excel sheet to my Wiki page, using my version of Office '03, causes garbage characters to appear in hyperlinks May 06, 2008 David Fecker Resolved
XL-39 Major Confluence links embedded in cells are incorrectly rendered as two output columns rather than 1 Apr 29, 2008 Andy Brook Resolved

Contributors

  • Bob Swift — Developer

Show description 3.4.0 (#7) 10 Feb 2008 Stable Freeware / Open Source (BSD) Free

Release Notes

Jira Issues
Key Priority Summary Updated asignee Reporter Status
XL-36 Major Update to JExcelApi 2.6.6 Feb 10, 2008 Bob Swift Closed
XL-31 Major Improperly generated table causes chart macro problems Feb 10, 2008 Bob Swift Closed
XL-30 Critical Invalid HTML generated for uninitialised cells Feb 10, 2008 David Peterson Closed
XL-27 Major trunk doesnt build - pom needs fixing Feb 11, 2008 Andy Brook Resolved
XL-16 Major Turn URL's in Excel cells into links Feb 10, 2008 Daniel Hannum Resolved

Contributors

  • Bob Swift — Developer

Show description 3.3.0 (#6) 25 Jun 2007 Stable Freeware / Open Source (BSD) Free

Release Notes

Jira Issues
Key Priority Summary Updated asignee Reporter Status
XL-32 Major Plugin is broken since upgrade Nov 14, 2007 Anshaj Kumar Mathur Closed
XL-24 Major Update to 2.4.x API level and 2.5.x permission enhancement Jun 25, 2007 Bob Swift Closed
XL-23 Major Maven2 build environment Jun 25, 2007 Bob Swift Closed

Contributors

  • Bob Swift — Developer

Show description 3.2.1 (#5) 25 Mar 2007 Stable Freeware / Open Source (BSD) Free

Release Notes

Jira Issues
Key Priority Summary Updated asignee Reporter Status
XL-19 Major Integrate fixes for common table properties (TBL-21, TBL-23, TBL-24) Mar 25, 2007 Bob Swift Closed

Contributors

  • Bob Swift — Developer

Show description 3.2 (#4) 04 Mar 2007 Stable Freeware / Open Source (BSD) Free

Release Notes

Jira Issues
Key Priority Summary Updated asignee Reporter Status
XL-18 Major Update to Jexcapi 2.6.3 Mar 05, 2007 Bob Swift Closed
XL-17 Major Update common table capability to 3.2 Mar 05, 2007 Bob Swift Closed
XL-14 Major Locale support - use default Confluence locale Mar 05, 2007 Bob Swift Closed

Contributors

  • Bob Swift — Developer

Show description 3.1 (#3) 08 Jan 2007 Stable Freeware / Open Source (BSD) Free

Contributors

  • Bob Swift — Developer

Show description 3.0.1 (#2) 26 Sep 2006 Stable Freeware / Open Source (BSD) Free

Contributors

  • Bob Swift — Developer

Show description 3.0 (#1) 06 Sep 2006 Prerelease Freeware / Open Source (BSD) Free

Contributors

  • Bob Swift — Developer

Open Issues

Labels

plugin plugin Delete
confluence22 confluence22 Delete
repository_current repository_current Delete
confluence23 confluence23 Delete
macro_security macro_security Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Dec 26, 2005

    Jonathan Nolen says:

    Dude, this rocks! So many people are going to love this. Thanks!

    Dude, this rocks! So many people are going to love this. Thanks!

  2. Dec 27, 2005

    Martin Ollesch says:

    Very great and useful macro! Thank You! Btw, linebreaks in Excel cells are lost...

    Very great and useful macro! Thank You!

    Btw, linebreaks in Excel cells are lost if output is html and not wiki.