README.txt in Easychart 7

-- SUMMARY --

Easy Chart provides a way to create charts based on the powerful Highcharts library (http://www.highcharts.com/products/highcharts).

This module:

* Defines a new Content Type named 'Chart' that allows you to add one or more charts to your website.
* Creates a Chart widget that you can use in your own content types.
* Integrates with the WYSIWYG module and provides an editor button that allows you to add charts to your WYSIWYG content (CKeditor and TinyMCE are supported).
* Gives you an easy interface to configure your charts through the Easy Chart jQuery plugin.

Please note that using the Highcharts library might require you to purchase a license: http://shop.highsoft.com/highcharts.html


-- INSTALLATION --

1. Download and install the Easy Chart module: https://drupal.org/project/easychart

2. Download the Highcharts plugin at http://www.highcharts.com/download and place it in /sites/all/libraries/highcharts

3. Download the v1.1 Easy Chart plugin at https://github.com/bestuurszaken/easychart and place it in /sites/all/libraries/easychart. The result should be /sites/all/libraries/easychart/jquery.easychart.js.


-- WYSIWYG PLUGIN ---

To use the WYSIWYG plugin, you will need to do the following:

1. Download and install the WYSIWYG module at https://drupal.org/project/wysiwyg. Follow the install instructions to add the CKeditor or TinyMCE editors.

2. Enable the Easy Chart button:
   Go to http://YOUR_SITE/admin/config/content/wysiwyg and click edit next to the text format(s) that you want to allow a chart to be added.
   Check 'Easy Chart' under 'Buttons and plugins' and save.

3. Enable the Easy Chart filter:
   Go to http://YOUR_SITE/admin/config/content/formats and click configure next to the Text Format(s) from step 2.
   Check 'Insert Easy Chart charts' and save.
   Note: if you don't do this, you will see [[chart-nid:x]] whe viewing your node. The filter will replace that placeholder with the actual Chart.

4. Make sure that DIV tags are allowed in your  Text Format.
   Go to http://YOUR_SITE/admin/config/content/formats and click configure next to the Text Format(s) from step 2.
   If 'Limit allowed HTML tags' is checked, than add 'div' to the allowed tags.


-- POSSIBLE ISSUES --

1. I get a javascript error: 'uncaught exception: Highcharts error #13: www.highcharts.com/errors/13'
   The chart needs a div to be printed in. If your Text Format does not allow DIV's to be printed, you will get the error above, and the chart will not be printed.
   See step 4 under 'WYSIWYG PLUGIN' for the solution.

2. I see [[chart-nid:x]] instead of the actual chart.
   See step 3 under 'WYSIWYG PLUGIN' for the solution.



This project is sponsored by Bestuurszaken, Vlaamse Overheid: http://www.bestuurszaken.be