[[PageOutline(2-5,Contents,pullout)]]

= Viewer for Microsoft Excel XLST files

== Description

This plugin allows uploaded Excel files on the Wiki or in tickets to be viewed in the web browser as a HTML table. It allows users to easily view the files without downloading and saving the Excel files and without even requiring Microsoft Excel. 

As a use case, upload an Excel document from an up-to-date version of Microsoft Excel as an attachment. As long as it is in the new xlst format the plugin will work. If it doesn't work, then verify that openpyxl is installed correctly by running Python and entering "import openpyxl". You should see no error. Also ensure that ''mime_map'' is set properly as documented in the Installation steps.

This plugin depends on the [https://openpyxl.readthedocs.io/en/default/ openpyxl] library, which itself is MIT/Expat licensed. 

== Bugs/Feature Requests

Existing bugs and feature requests for ExcelXlstViewerPlugin are 
[report:9?COMPONENT=ExcelXlstViewerPlugin here].

If you have any issues, create a 
[/newticket?component=ExcelXlstViewerPlugin new ticket].

[[TicketQuery(component=ExcelXlstViewerPlugin&group=type,format=progress)]]

== Download

Download the zipped source from [export:excelxlstviewerplugin here].

== Source

You can check out ExcelXlstViewerPlugin from [/svn/excelxlstviewerplugin here] using Subversion, or [source:excelxlstviewerplugin browse the source] with Trac.

== Installation

First install the openpyxl library: `easy_install openpyxl`.

General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.

== Configuration

After installation add the following to the ''mime_map'' property in your `trac.ini` file to tell Trac which types of file work with the plugin:

{{{#!sh
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:xlsx,application/vnd.ms-excel.sheet.macroEnabled.12:xlsm
}}}

To make this plugin work on Trac 0.12, use the workaround described [th:#9945 here].

== Recent Changes

[[ChangeLog(excelxlstviewerplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:danrolls] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''