From 545d917f165351bd726456c4c38770b8b971e268 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Sun, 11 May 2014 11:54:38 +0200 Subject: [PATCH] update documentation, changelong re: new tables, spreadsheets --- docs/basics.md | 4 ++-- docs/changelog.md | 20 ++++++++++++++++++++ readme.md | 32 +++++++------------------------- 3 files changed, 29 insertions(+), 27 deletions(-) diff --git a/docs/basics.md b/docs/basics.md index b4e3ee93..e227170a 100644 --- a/docs/basics.md +++ b/docs/basics.md @@ -31,8 +31,8 @@ Ignoring some HTML things to conserve space, you get the point. This is a basic - - + + diff --git a/docs/changelog.md b/docs/changelog.md index 78495125..25a8b313 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -1,5 +1,25 @@ ### Sheetsee v3 +## May 10, 2014 +### Better Table Template Options + +Updated `sheetsee-tables` to allow you to re-use a template (rather than duplicating it for each different table you wanted to create). Previously it assumed your HTML table `div` id matched your script template `id`. This means that you can pass in an extra key/value pair in your table options into `Sheetsee.maketable()`. The new pair it takes is: `"templateID" : "yourtemplateid"`. Example below, full `sheetsee-tables` documentation [here](docs/sheetsee-tables.html). + +```JavaScript +var tableOptions = { + "data": gData, + "pagination": 10, + "tableDiv": "#fullTable", + "filterDiv": "#fullTableFilter", + "templateID": "tableTemplte" + } +Sheetsee.makeTable(tableOptions) +``` + +## May 2014 +### Important Google Spreadsheets & Tabletop News + +Google recently updated their Google Spreadsheets and the API. For a bit this was breaking things using the old API, including Tabletop. This has been fixed and the latest version of tabletop.js works on both old and new spreadsheets. **Be sure to include at least version 1.3.4 in your project.** ## August 13, 2013 ### Charting Intake diff --git a/readme.md b/readme.md index c11ce512..298a9835 100644 --- a/readme.md +++ b/readme.md @@ -20,7 +20,7 @@ Each of **sheetsee.js**'s features are divided into modules. Use just the parts | **sheetsee-charts** | Includes 3 basic d3 charts: bar, line and pie. You can also [use your own](docs/custom-charts.md). | [Doc](./docs/sheetsee-charts.md) | -## Making Things +## In the Wild What can you make with **Sheetsee.js**? Lots of things, here are some examples: @@ -29,33 +29,15 @@ What can you make with **Sheetsee.js**? Lots of things, here are some examples: **List your sheetsee project here: file an [issue or pull request](http://www.github.com/jlord/sheetsee.js).** -## Demos - -Demos pages for the documentation. - -- [Table Demo](./demos/demo-table.html) -- [Map Demo](./demos/demo-map.html) -- [Chart Demo](./demos/demo-chart.html) - -## Documentation +# Resources & Documentation More resources on using Sheetsee.js: -#### Getting Started - -- [About Sheetsee.js](./docs/about.md) -- [Building Sheetsee](./docs/building.md) -- [Basics](./docs/basics.md) - -#### Ideas +| Getting Started | Ideas | Use | Demos | +| --- | --- | --- | --- | +| [About Sheetsee.js](./docs/about.md)
[Building Sheetsee](./docs/building.md)
[Basics](./docs/basics.md) | [Fork-n-Go](./docs/fork-n-go.md)
[Tips!](./docs/tips.md)
[Custom charts](./docs/custom-charts.md) | [Sheetsee-core](./docs/sheetsee-core.md)
[Sheetsee-tables](./docs/sheetsee-tables.md)
[Sheetsee-maps](./docs/sheetsee-maps.md)
[Sheetsee-charts](./docs/sheetsee-charts.md) | [Table Demo](./demos/demo-table.html)
[Map Demo](./demos/demo-map.html)
[Chart Demo](./demos/demo-chart.html) | -- [Fork-n-Go](./docs/fork-n-go.md) -- [Tips!](./docs/tips.md) -- [Custom charts](./docs/custom-charts.md) +## Note on New Google Spreadsheets -#### Use +Google recently updated their Google Spreadsheets and the API. For a bit this was breaking things using the old API, including Tabletop. This has been fixed and the latest version of tabletop.js works on both old and new spreadsheets. **Be sure to include at least version 1.3.4 in your project.** -- [Sheetsee-core](./docs/sheetsee-core.md) -- [Sheetsee-tables](./docs/sheetsee-tables.md) -- [Sheetsee-maps](./docs/sheetsee-maps.md) -- [Sheetsee-charts](./docs/sheetsee-charts.md)