https://github.com/texnixe/kirby3-spreadsheet

https://github.com/texnixe/kirby3-spreadsheet

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/texnixe/kirby3-spreadsheet
• Owner: texnixe
• Created: 2019-09-29T13:12:52.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-02-12T19:51:45.000Z (almost 5 years ago)
• Last Synced: 2024-05-09T12:02:47.159Z (8 months ago)
• Language: PHP
• Size: 3.71 MB
• Stars: 12
• Watchers: 2
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Kirby 3 Spreadsheet

Version 1.0.0

This plugin for Kirby 3 provides a KirbyTag that allows you to include a table inside a textarea field from a spreadsheet (Excel or CSV files).

## Installation

### Download

[Download the files](https://github.com/texnixe/kirby-spreadsheet/archive/master.zip) and place them inside `site/plugins/kirby-spreadsheet`.

### Kirby CLI

Installing via Kirby's [command line interface](https://github.com/getkirby/cli):

    $ kirby plugin:install texnixe/kirby-spreadsheet

To update the plugin, run:

    $ kirby plugin:update texnixe/kirby-spreadsheet

### Git Submodule

You can add the Kirby Spreadsheet plugin as a Git submodule.

    $ cd your/project/root

    $ git submodule add https://github.com/texnixe/kirby-spreadsheet.git site/plugins/kirby-spreadsheet

    $ git submodule update --init --recursive

    $ git commit -am "Add Kirby Spreadsheet"

Run these commands to update the plugin:

    $ cd your/project/root

    $ git submodule foreach git checkout master

    $ git submodule foreach git pull

    $ git commit -am "Update submodules"

    $ git submodule update --init --recursive

### How to use

Insert the tag into a textarea field.

**Example**:

```

(spreadsheet: pricelist.xlxs class: pricelist)

```

### Options:

#### class

The class you want to use for the table. If no class is given, the default class is 'kirby-spreadsheet'. You can set a different default class in your `config.php`:

```

'texnixe.spreadsheet.tableClass' => 'kirby-spreadsheet'

```

#### header

Set to `false` if the table does not contain a header, default is `true`

```

(spreadsheet: pricelist.xlxs header: false)

```

#### sheet

Optional, the name of the worksheet.

```

(spreadsheet: pricelist.xlsx sheet: Table1)

```

## License

Kirby Spreadsheet is open-sourced software licensed under the MIT license.

Copyright © date Sonja Broda [email protected] https://sonjabroda.com