Help:Spreadsheet format

From semantic-mediawiki.org
Spreadsheet format
Outputs the result in spreadsheet file formats (xlsx, xls, ods and csv).
Further Information
Provided by: Extension "Semantic Result Formats"
Added: 3.1.0
Removed: still supported
Requirements: "PHPSpreadsheed" library (handled by Composer)
Format name: spreadsheet
Enabled? Indicates whether the result format is enabled by default upon installation of the respective extension. yes
Authors: Stephan Gambke
Categories: export
Table of Contents

The result format spreadsheet is used to format query results as a spreadsheet. It is similar to the csv format except that value types are now explicitly handled. Previously one could export to csv and then import to e.g. MS Excel or LibreOffice Calc, however values could be wrongly interpreted as numbers when they were in fact strings. This format fixes that issue. It was introduced with version 3.1.0 of extension "Semantic Result Formats"Provides additional formats for semantic queries and replaces the recursing result format "Excel"Outputs the result in Microsoft Office Excel file format (xls).1.

Note that the precursing result format identifier "excel" is now an alias to "spreadsheet".

This format will automatically be available if the required PhpSpreadsheet library is installed.

Parameters

Parameter Type Default Description
templatefile text empty The name of a spreadsheet file from the File namespace used for formatting the generated file
filename text empty The filename for the download of the generated spreadsheet file
fileformat text xlsx The format to be produced for the spreadsheet file. Allowed values: xlsx, xls, ods, csv. Default: xlsx
Available values for the parameters listed above:
  • filename: xlsx, xls, odt, csv (default: xlsx)

Example[edit]

This result format is not available on this wiki. Thus an example output cannot be provided.
Syntax
{{#ask:
 [[Category:City]]
 [[located in::Germany]] 
 |?Population
 |?Area#km² = Size in km²
 |searchlabel=Download result as xlsx-file for MS Excel
 |format=spreadsheet
}}

Installation[edit]

This section describes how to install the required PHPSpreadsheet library with Composer. To do this add the following as the last line of the "require" section in your "composer.local.json" file not forgetting to add a comma to the end of the preceding line:

"phpoffice/phpspreadsheet": "~1"

Now run the following command from the root directory of your wiki to complete the installation:

composer update --no-dev

References

  1. ^  Semantic Result Formats: GitHub issue gh:srf:382