Update docs for v1.1.0 (#43)

Author: alshan

CHANGELOG.md

@@ -7,14 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [1.0.1-dev-1] - 2020-10-07
+## [1.1.0] - 2020-11-xx
 ### Added
- - Parameters `map`, `mapJoin` in `geom_polygon, geom_path, geom_point, geom_text`
- - Converter from `org.geotools.data.simple.SimpleFeatureCollection` to `jetbrains.letsPlot.spatial.SpatialDataset`
+ - GeoTools support (see [geotools.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/geotools.md)).
+ - API for tooltip customization (see [tooltips.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/tooltips.md)).
+ - `geom_map()`.
+ - `labelFormat` parameter in `geom_text()`.
+ - `reverse` parameter in `scale_x/y_discrete()`.
+ - `scale_x_discrete_reversed()`, `scale_y_discrete_reversed()`
+
+### Changed
+ - Built with Lets-Plot v1.5.4 (was v1.5.2).
+  
+    See Lets-Plot [CHANGELOG.md](https://github.com/JetBrains/lets-plot/blob/master/CHANGELOG.md) for changes and fixes in 1.5.3, 1.5.4.
 
 ### Fixed
  - `ggsave()` ignores raster format file extension.
- - `as_discrete()`: if more than one is used in the same mapping block then all but one of them are ignored. 
+ - `as_discrete()`: if more than one is used in the same mapping block, then all but one of them are ignored. 
 
 ## [1.0.0] - 2020-08-13
 ### Added

README.md

@@ -41,8 +41,10 @@
     - [Data sampling](#sampling)
     - [GGBunch](#ggbunch)
     - [Saving plot to file](#export)
-    
-- [What is new in 1.0.0](#new)
+    - [Tooltip customization](#tooltip-customization)
+    - [GeoTools support](#geotools)
+        
+- [What is new in 1.1.0](#new)
 - [Change log](#change_log)
 - [License](#license)    
 
@@ -151,7 +153,7 @@ See [README_DEV.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/RE
 
 Sampling is a special technique of data transformation, which helps to deal with large datasets and overplotting.
 
-[Learn more](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/sampling.md) about sampling in Lets-Plot. 
+Learn more: [Data Sampling](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/sampling.md). 
 
 <a id="ggbunch"></a>
 #### GGBunch
@@ -191,23 +193,45 @@ ggsave(p, "density.png")
 <img src="https://raw.githubusercontent.com/JetBrains/lets-plot-kotlin/master/docs/examples/images/ggsave_demo.png" alt="Couldn't load ggsave_demo.png" width="500" height="250"/>
 <br/>
 
-See [ggsave documentation](https://htmlpreview.github.io/?https://raw.githubusercontent.com/JetBrains/lets-plot-kotlin/master/docs/api-reference/plot-api/jetbrains.lets-plot.export/ggsave.html) 
+See `ggsave()` [documentation](https://htmlpreview.github.io/?https://raw.githubusercontent.com/JetBrains/lets-plot-kotlin/master/docs/api-reference/plot-api/jetbrains.lets-plot.export/ggsave.html) 
 for more information about the function arguments and default values.
 
+<a id="tooltip-customization"></a>
+#### Tooltip customization
+
+You can customize the content of tooltips for the layer by using the parameter `tooltips` of `geom` functions.
+
+Learn more: [Tooltip Customization](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/tooltips.md). 
+
+<a id="geotools"></a>
+#### GeoTools support
+
+[GeoTools](https://www.geotools.org/) is an open source Java GIS Toolkit.
+
+Lets-Plot supports visualization of a set of `SimpleFeature`-s stored in `SimpleFeatureCollection`, as well as 
+individual `Geometry` and `ReferencedEnvelope` objects. 
+
+Learn more: [GeoTools Support](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/geotools.md).
+ 
+
 <a id="new"></a>
-## What is new in 1.0.0
+## What is new in 1.1.0
 
-Maven artifact __group id__ has changed in this release.
+- Tooltip Customization
 
-Now it is: `org.jetbrains.lets-plot-kotlin` (before was: `org.jetbrains.lets-plot`).
+    New API for customization of tooltip contents. See [Tooltip Customization](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/tooltips.md)) for details.
+ 
+- Formatting labels in `geom_text()`
 
-To include Lets-Plot Kotlin API to your Gradle project for example, use the following dependency: 
+    New parameter, 'labelFormat' to define a formatting pattern.
 
-```groovy
-dependencies {
-    api "org.jetbrains.lets-plot-kotlin:lets-plot-kotlin-api:<api version>"
-}
-``` 
+    See demo: [label_format.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/label_format.ipynb)
+    
+- GeoTools support
+
+    Visualization of GeoTools's `SimpleFeature`-s and other objects. See [GeoTools Support](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/geotools.md)) for details.
+
+- Other changes and fixes - see [CHANGELOG.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/CHANGELOG.md) for details.       
 
 <a id="change_log"></a>
 ## Change Log

docs/examples.md

@@ -1,13 +1,27 @@
 ## Example Notebooks
 
-Try the following examples to study more features of the `Lets-Plot` library.
-
+Try the following tutorials and examples to learn and evaluate various features of the `Lets-Plot` library.
+
+- [Quickstart and User Guide](#quickstart)
+- [Geoms and Stats](#geoms_n_stats)
+- [Position Adjustment](#pos)
+- [Scales](#scales)
+- [Facets](#facets)
+- [GGBunch](#ggbunch)
+- [`as_discrete()` function](#as_discrete)
+- [Export to File](#export)
+- [Theme](#theme)
+- [Data Sampling](#sampling)
+- [Tooltip Customization](#tooltip)
+- [GeoTools Support](#geotools)
+
+<a id="quickstart"></a>
 #### Quickstart and User Guide
 
-[quickstart.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/quickstart.ipynb)
-
-[user_guide.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/guide/user_guide.ipynb)
+* [quickstart.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/quickstart.ipynb)
+* [user_guide.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/guide/user_guide.ipynb)
 
+<a id="geoms_n_stats"></a>
 #### Geoms and Stats
 
 `geom_histogram, geom_density, geom_vline, geom_freqpoly, geom_boxplot`:
@@ -32,56 +46,85 @@ Try the following examples to study more features of the `Lets-Plot` library.
 
 [contours.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/contours.ipynb)
 
+`geom_text`, label format
+
+[label_format.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/label_format.ipynb)
 
 
+<a id="pos"></a>
 #### Position Adjustment
 
-`position_dodge` : [error_bars.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/error_bars.ipynb)
+* `position_dodge` : [error_bars.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/error_bars.ipynb)
+* `position_jitter` : [scatter_plot.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/scatter_plot.ipynb)
 
-`position_jitter` : [scatter_plot.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/scatter_plot.ipynb)
 
+<a id="scales"></a>
 #### Scales
 
-`scale_color_manual, scale_fill_manual` :
+* `scale_color_manual, scale_fill_manual` :
  [error_bars.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/error_bars.ipynb)
-
-`scale_x_continuous, scale_shape_manual` :
+* `scale_x_continuous, scale_shape_manual` :
  [scatter_plot.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/scatter_plot.ipynb)
-
-`scale_color_gradient` : [density_2d.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/density_2d.ipynb)
-
-`scale_fill_hue, scale_fill_grey, scale_color_gradient` : [contours.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/contours.ipynb)
+* `scale_color_gradient` : [density_2d.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/density_2d.ipynb)
+* `scale_fill_hue, scale_fill_grey, scale_color_gradient` : [contours.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/contours.ipynb)
 
 
+<a id="facets"></a>
 #### Facets
 
-`facet_grid`: 
+* `facet_grid`: 
 [distributions.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/distributions.ipynb)
 
+
+<a id="ggbunch"></a>
 #### GGBunch
 
 GGBunch allows to show a collection of plots on one figure. Each plot in the collection can have arbitrary location and size. There is no automatic layout inside the bunch.
 
-[ggbunch.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/ggbunch.ipynb) 
+* [ggbunch.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/ggbunch.ipynb) 
+* [geom_smooth.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/geom_smooth.ipynb) 
 
-[geom_smooth.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/geom_smooth.ipynb) 
 
+<a id="as_discrete"></a>
 #### `as_discrete()` function 
 
-[geom_smooth.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/geom_smooth.ipynb) 
+* [geom_smooth.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/geom_smooth.ipynb) 
+
 
+<a id="export"></a>
+#### Export to File
+
+The `ggsave()` function is an easy way to export plot to a file in SVG, HTML or raster formats.
+
+* [export_to_file.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/export_to_file.ipynb)
+
+
+<a id="theme"></a>
 #### Theme
 
 Legend layout and axis presentation options : 
 
-[legend_and_axis.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/legend_and_axis.ipynb)
+* [legend_and_axis.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/legend_and_axis.ipynb)
 
+<a id="sampling"></a>
 #### Data sampling 
 
 Sampling is a special technique of data transformation, which helps dealing with large datasets and overplotting.
 
-[Learn more](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/sampling.md) about sampling in Lets-Plot. 
+See: [Sampling in Lets-Plot](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/sampling.md).
+
+* Pick sampling on Bar-chart: [sampling_pick.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/sampling_pick.ipynb)
+* Stratified sampling: [sampling_stratified.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/sampling_stratified.ipynb)
+
+<a id="tooltip"></a>
+#### Tooltip Customization
+
+* [tooltip_config.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/tooltip_config.ipynb)
+
+
+<a id="geotools"></a>
+#### GeoTools Support
 
-Pick sampling on Bar-chart: [sampling_pick.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/sampling_pick.ipynb)
+See [GeoTools Support](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/geotools.md).
 
-Stratified sampling: [sampling_stratified.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/sampling_stratified.ipynb)
+* [geotools_naturalearth.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/geotools_naturalearth.ipynb)