~zsombi/ubuntu-ui-toolkit/theme-as-singleton : contents of CHANGES.syntax at revision 920

~zsombi/ubuntu-ui-toolkit/theme-as-singleton : (revision 920)

The CHANGES file documents all changes in the toolkit that will break applications.
A strict syntax is defined below that eases the lives of developers.
There are 2 types of changes, a section for each exists for each release of the toolkit:
- API Changes
- Compatibility Breaks

Each change must be reported on a new bullet point and respect one of the following templates:
* $TYPE_OF_CHANGE$ $OBJECT$
* $TYPE_OF_CHANGE$ IN $OBJECT$: $MEMBER_TYPE$ $OLD_SIGNATURE$ TO $NEW_SIGNATURE$
* $TYPE_OF_CHANGE$ IN $OBJECT$: description of the compatibility break

Where $TYPE_OF_CHANGE$ is:
- "DEPRECATED"
- "CHANGED"
- "REMOVED"

Where $OBJECT$ is:
- a QML class
- a JavaScript module
- a context property

Where $MEMBER_TYPE$ is:
- "property"
- "signal"
- "function"



Original version not respecting the syntax:

API Changes
***********  

* "clicked() and pressAndHold() signals of AbstractButton no longer take a mouse parameter as input."
* ComponentUtils module is deprecated (affects componentUtils.js: hasStyle(), style(), delegateProperty() functions)
* Property tools was deprecated for MainView, Tabs and PageStack.
* Property page of Tab can no longer be a URL, but must be an Item (Page recommended).
  Use a Loader if you were using a URL first.

Compatibility Breaks
********************

* Pages now automatically update MainView.toolbar.tools when they become active.
* Disable swiping to switch tabs by default.
* Header is now hidden when it has no title or contents
* Page, PageStack and Tabs automatically determine their anchors and height
  inside a MainView, so there is no need to set them explicitly.
* It is now recommended to always use Pages inside Tabs or PageStack.
  Non-Page items can still be used, but their margins will not automatically
  be set-up to align with the header of the MainView.



Formatted version respecting the syntax:

API Changes
***********  

* CHANGED IN AbstractButton: signal clicked(var mouse) TO clicked()
* CHANGED IN AbstractButton: signal pressAndHold(var mouse) TO pressAndHold()
* DEPRECATED ComponentUtils
* DEPRECATED IN MainView: property ToolbarActions tools
* DEPRECATED IN Tabs: property ToolbarActions tools
* DEPRECATED IN PageStack: property ToolbarActions tools
* CHANGED IN Tab: property var page TO Item page (where var page could be an Item or url)

Compatibility Breaks
********************

* CHANGED IN Page: when it becomes active, MainView's property ToolbarActions toolbar.tools is automatically updated
* CHANGED IN Tabs: swiping to switch tabs is disabled by default
* CHANGED IN Header: becomes hidden when there is no title or contents
* CHANGED IN Page, PageStack, Tabs: automatically determine their anchors and height inside a MainView
* CHANGED IN Tabs, PageStack: it is recommended to always use Pages inside them. Non-Page items can still be used, but their margins will not automatically be set-up to align with the header of the MainView.



432.1.1 by Kaleo Added syntax description for CHANGES file in CHANGES.syntax.	1	The CHANGES file documents all changes in the toolkit that will break applications.
	2	A strict syntax is defined below that eases the lives of developers.
	3	There are 2 types of changes, a section for each exists for each release of the toolkit:
	4	- API Changes
	5	- Compatibility Breaks
	6
432.1.2 by Kaleo Added template for compatibility breaks.	7	Each change must be reported on a new bullet point and respect one of the following templates:
432.1.1 by Kaleo Added syntax description for CHANGES file in CHANGES.syntax.	8	* $TYPE_OF_CHANGE$ $OBJECT$
	9	* $TYPE_OF_CHANGE$ IN $OBJECT$: $MEMBER_TYPE$ $OLD_SIGNATURE$ TO $NEW_SIGNATURE$
432.1.2 by Kaleo Added template for compatibility breaks.	10	* $TYPE_OF_CHANGE$ IN $OBJECT$: description of the compatibility break
432.1.1 by Kaleo Added syntax description for CHANGES file in CHANGES.syntax.	11
	12	Where $TYPE_OF_CHANGE$ is:
	13	- "DEPRECATED"
	14	- "CHANGED"
432.1.3 by Kaleo Added type of change 'REMOVED'.	15	- "REMOVED"
432.1.1 by Kaleo Added syntax description for CHANGES file in CHANGES.syntax.	16
	17	Where $OBJECT$ is:
	18	- a QML class
	19	- a JavaScript module
	20	- a context property
	21
	22	Where $MEMBER_TYPE$ is:
	23	- "property"
	24	- "signal"
	25	- "function"
	26
	27
	28
	29	Original version not respecting the syntax:
	30
	31	API Changes
	32	***********
	33
	34	* "clicked() and pressAndHold() signals of AbstractButton no longer take a mouse parameter as input."
	35	* ComponentUtils module is deprecated (affects componentUtils.js: hasStyle(), style(), delegateProperty() functions)
	36	* Property tools was deprecated for MainView, Tabs and PageStack.
	37	* Property page of Tab can no longer be a URL, but must be an Item (Page recommended).
	38	Use a Loader if you were using a URL first.
	39
	40	Compatibility Breaks
	41	********************
	42
	43	* Pages now automatically update MainView.toolbar.tools when they become active.
	44	* Disable swiping to switch tabs by default.
	45	* Header is now hidden when it has no title or contents
	46	* Page, PageStack and Tabs automatically determine their anchors and height
	47	inside a MainView, so there is no need to set them explicitly.
	48	* It is now recommended to always use Pages inside Tabs or PageStack.
	49	Non-Page items can still be used, but their margins will not automatically
	50	be set-up to align with the header of the MainView.
	51
	52
	53
	54	Formatted version respecting the syntax:
	55
	56	API Changes
	57	***********
	58
	59	* CHANGED IN AbstractButton: signal clicked(var mouse) TO clicked()
	60	* CHANGED IN AbstractButton: signal pressAndHold(var mouse) TO pressAndHold()
	61	* DEPRECATED ComponentUtils
	62	* DEPRECATED IN MainView: property ToolbarActions tools
	63	* DEPRECATED IN Tabs: property ToolbarActions tools
	64	* DEPRECATED IN PageStack: property ToolbarActions tools
432.1.5 by Kaleo Fixed Tab.page example.	65	* CHANGED IN Tab: property var page TO Item page (where var page could be an Item or url)
432.1.1 by Kaleo Added syntax description for CHANGES file in CHANGES.syntax.	66
	67	Compatibility Breaks
	68	********************
	69
	70	* CHANGED IN Page: when it becomes active, MainView's property ToolbarActions toolbar.tools is automatically updated
	71	* CHANGED IN Tabs: swiping to switch tabs is disabled by default
	72	* CHANGED IN Header: becomes hidden when there is no title or contents
	73	* CHANGED IN Page, PageStack, Tabs: automatically determine their anchors and height inside a MainView
	74	* CHANGED IN Tabs, PageStack: it is recommended to always use Pages inside them. Non-Page items can still be used, but their margins will not automatically be set-up to align with the header of the MainView.
	75
	76