= Complete basic cartography suite in GRASS GIS wxGUI Map Display =

|| Title: || '''Complete basic cartography suite in GRASS GIS wxGUI Map Display''' ||
||Student Name: || Adam Laza, [http://www.cvut.cz Czech Technical University in Prague] ||
||Organization: || [http://www.osgeo.org OSGeo - Open Source Geospatial Foundation] ||
|| Mentor Name: || Anna Petrasova, [http://grasswiki.osgeo.org/wiki/User:Wenzeslaus Vaclav Petras] ||
|| GSoC proposal: ||https://summerofcode.withgoogle.com/projects/#6052618879107072 view proposal]   ||
|| Link to code: || TODO ||
|| Documentation: || TODO ||

== Brief description ==

Currently a GRASS GIS user is forced to use Cartographic Composer or use another software (e.g. QGIS) to create hard copy map outputs with all features. The aim of this project is to develop complete basic cartography suite for the wxGUI Map Display so it could serve for most of the science publications. The goal is not to substitute QGIS Cart Comp or similar, it's just about completing all features so the cartography scripting abilities of GRASS GIS and its potential can be fully used.



== State before GSoC ==

GRASS GIS contains some modules which would be good to implement into cartography suite for wxGUI Map Display. There are d.barscale, d.graph, d.histogram, d.legend and many other d.* commands to use. There are bugs in some of them and it needs to be fixed (options for map window size). Then there are some modules which need to be enhanced. Legend background is currently transparent ­> add an options for opacity, border and corner settings. It's possible to set number of breaks/ticks for legend but values are not rounded ­> add an option for manual brakes/ticks, add an option for automatic breaks/ticks (every ten, hundred).



== Addition to the project ==

GRASS GIS is an important OSGeo project but it is perceived as not suitable for cartography which prevents a lot of users from utilizing as a GIS. Completing basic cartography suite in GRASS GIS should satisfy needs of significant part of potential user community.
Moreover, GRASS GIS provides an easy way to automate simple map creation using scripting. However, only with complete suite of basic functions implemented in this GSoC project, the cartography scripting abilities of GRASS GIS can be fully used.

== Project plan ==

The idea of the project is to start with easy­to­implement stuff and step­by­step implement the more difficult ones. There are many details which need to be improved and many others which are missing entirely so the users have to use another software (legend background, north arrow orientation)

|||||| '''Project plan'''	||
||Date ||Goals 	||status||
||MAY 23          ||Starting GoSC|| ||
||MAY 23 -­ 27     ||Store legend, scale bar, north arrow and text in workspace, bug fixing (e.g. workspace loading) (wxGUI).|| ||
||MAY 30 ­- JUNE 3      ||Add units to legend (optionally also title) as parameter. Option for switch  legend to linear/logarithmic scale. Manual/automatic breaks/ticks for legend (option for rounded values, option for every ten,hundred).|| ||
||JUNE 6 ­- 10      ||Legend background (border, rounded corners, opacity settings) (d.legend, C).Support map units in scale bar (not only meters).Allow user to set the length of scale bar (in map units) (d.barscale).|| ||
||JUNE 13 ­- 17     ||Possibility to add any image (as in animation tool). Use cases: logo/watermark, workaround for overview maps.|| ||
||JUNE 20 ­- 24    ||General shapes.|| ||
||JUNE 20 ­- 27    ||'''Midterm evaluations'''|| ||
||JUNE 27 ­- 1 JULY     ||General shapes.|| ||
||JULY 4 ­- 8   ||Include map­display­like object.|| ||
||JULY 11 ­- 15    ||Include map­display­like object.|| ||
||JULY 18 ­- 22    ||Implement vector legend. Enhance d.vect.thematic.)|| ||
||JULY 25 ­- 29   ||Implement vector legend. Enhance d.vect.thematic. Testing, writing documentation.|| ||
||AUGUST 1 -­ 5    ||Testing, writing documentation.|| ||
||AUGUST 8 ­- 12  ||One week buffer in case of delay.|| ||
||AUGUST 15 ­- 23  ||Submitting code and evaluations.|| ||
||AUGUST 23 ­- 29  ||'''Final Evaluations'''|| ||
||AUGUST 30       ||'''Ending GSoC'''|| ||

== Tickets ==

We are using keywords [query:keywords=~cartography cartography] and [query:keywords=~gsoc2016 gsoc2016] to mark the tickets which are tasks for this GSoC.

[[TicketQuery(keywords=~cartography|~gsoc2016,order=priority)]] 
== Vector legend ==

Draft of legend implementation. Please edit or change completely.

* 1st prototype
 * d.legend.vector
 * in: list of d.vect commands from layer manager
 * Python
 * extract: symbol color1 color2 size width text
  * symbol
   * symbols for lines and areas must be created
   * icon if v.info returns lines, then use the new symbol for lines
   * icon if v.info returns areas, then use the new symbol for areas
   * use icon for points
   * use icon when explicitly specified (there is a default but GUI does not put it there unlike history)
   * if mixed feature types, either special symbols or separate entries or just use symbol (needs to be decided)
  * color1=color
  * color2=fill_color
  * size=size
  * width=width
  * text=title or name
 * generates d.graph file
 * GUI takes d.vect commands, calls this module and uses the output in d.graph when rendering
* 2nd stage
 * text format for customization
 * `symbol color1 color2 size width text...`
 * `legend/lines_z` red none 5 2 State border

G7:d.graph code:

{{{
color red
polygon
10 10
10 20
20 20
20 10
color black
move 22 10
size 24 24
text Red area
}}}

See for example: source:grass-addons/tools/std_dataset_display.py and [https://grasswiki.osgeo.org/w/images/Std_dataset_nc_stripe.png the resulting image].
== Development ==
 
== Weekly reports ==
 === Bounding period ===
Setting up the environment. Installing Ubuntu, GRASS GIS.
 
 === Week 1 ===
TODO