Summary of the XWiki 7.x Cycle (XWiki.org)

This is a summary of the release notes for [[XWiki Commons>>http://commons.xwiki.org]], [[XWiki Rendering>>http://rendering.xwiki.org]], [[XWiki Platform>>http://platform.xwiki.org]] and [[XWiki Enterprise>>http://enterprise.xwiki.org]], for the whole 7.x cycle (i.e. the whole year 2015). They share the same release notes as they are released together and have the same version.

6

7

The biggest highlight of this cycle is definitely the introduction of Nested Pages and all the consequences that ensued (see below). More work on Nested Pages has also been done in the 8.x cycle.

= Work Done =

The work is organised using [[JIRA>>http://jira.wiki.org]] and here are some [[JIRA stats of what happened during the 7.x cycle>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=13692]]:

12

* 1557 issues were closed (See the [[full JIRA issue list>>http://jira.xwiki.org/issues/?filter=14396]])

13

* 696 bugs closed, 541 improvements, 83 new features and more:(((

14

15

)))

16

* And the top JIRA participants (these are those contributing to more than 1% of the total jira issue number):(((

)))

Congrats to all who participated!

= Top 10 Features =

For our users, here are some top 10 features that we wish to highlight (arbitrarily hand-picked; it's hard to pick 10 out of 624 improvements and new features!).

== Document Diffs ==

The document history view that shows the differences between two versions of a document has been improved:

31

32

* The new summary gives you an overview of the changes and provides fast navigation.

33

* The changes made to the short text properties (e.g. title, which has only one line of text) are more readable now.

34

* You can see the changes that have been made to a text attachment. For non-text attachments you can see the difference in the file size.

35

* You can see detailed changes to a class definition (e.g. which meta properties, like 'Custom Display', have been modified).

36

37

{{image reference="ReleaseNotes.ReleaseNotesXWiki70RC1@history-compareDocumentVersions.png"/}}

38

39

See the [[Version Control feature documentation>>platform:Features.VersionControl]] for more details.

== Wiki Creation ==

* During the wiki creation, Distribution Wizard is not triggered anymore. Instead, the whole wiki creation process has been moved into a job, and everything happens inside the Wiki Creation Wizard (with a progress bar and a logging area):(((

44

45

)))

46

* The Wiki Provisioning Step has been integrated into the job too.

47

* When a wiki is created from a template, we now have a message in the logs that displays which document is copied.

48

49

== Document Index Tree Finder ==

50

51

You can now easily find documents and attachments from the tree view of the Document Index.

Checkout the [[Index Application>>extensions:Extension.Index Application]] for more details.

== Solr Search ==

* We worked on making the search UI responsive on small screens. On mobile phones the list of search facets is now collapsed above the search results and the user can toggle it with a tap. We improved the way the search results of type Object and Object Property are displayed (check the result title and location / breadcrumb). We switched to using the icon themes for the search result icons and we also fixed some small spacing and alignment issues introduced by the migration from the old Colibri skin to the new Flamingo skin. Last but not least, we worked on refreshing the search UI without reloading the entire page when the user sorts the search results, uses the pagination or drills down the results using the search facets.(((

60

61

)))

62

* It's now possible to disable highlighting and faceting which are very slow tasks. Can be controlled directly from the search UI or from the Main.SolrSearchConfig document.(((

63

{{image reference="ReleaseNotes.ReleaseNotesXWiki71RC1@solr_options.png"/}}

64

)))

65

66

See the [[Solr Search Application>>extensions:Extension.Solr Search Application]] documentation for more details.

== Nested Pages ==

It's now possible to create wiki pages inside other wiki pages. More specifically we've decided to drop the concept of Space in the UI (it's still there at the API/platform level) and instead, to replace it with the concept of Nested Pages.

71

72

We've also decided to drop the concept of Parent/Child relationship since it was too complex for end users to have 2 hierarchies: the Space/Page hierarchy and the Parent/Child hierarchy. The Parent/Child hierarchy also had limitations: you couldn't inherit page permissions for example. Thus the idea is to have a single hierarchy based on Nested Pages.

73

74

Advantages of Nested Pages:

75

76

* The URL reflects the page hierarchy

77

* Finer-grained control: Ability to set permissions at each level

78

* Generally speaking, a nicer and simpler way to organize your content hierarchically

79

* Moving and Deleting pages updates the hierarchy

Terminology:

* **Nested Page** (a.k.a **Non-Terminal Page**): This is a wiki page that can have children pages. Technically a Nested Page is implemented as a Nested Space (i.e. a **WebHome** page).

84

* **Non-Nested Page** (a.k.a **Terminal Page**): This a wiki page that cannot have children pages. Applications and script can create Terminal Pages. Advanced Users will also be able to create Terminal Pages from the UI. Standard Users will only be able to create Nested Pages.

85

* **Nested Space**: A Space which has another Space as parent. As mentioned above, a Nested Page is technically implemented as a Nested Space. You will used the term Nested Space when speaking technically about XWiki APIs for example but when talking about UI you should favor using the term Nested Page instead.

86

87

For more information, see [[Content Organization>>platform:Features.ContentOrganization||anchor="HHistory"]].

88

89

We have worked a lot to minimize the retro-compatibility issues. However, some Extensions are not adapted for //Nested Pages// yet, and their execution is still sub-optimal. For the next releases, we plan to work on the adaptation of these Extensions.

== Script right ==

A new Script Right has been added to allow controlling who has the right to write Scripts. Specifically anyone with Edit rights can edit a page and write a Script in it. However, when the page is rendered the script will only execute if the last author of the page has the Script right.

94

95

Example when the author of a script doesn't have the Script right:

The Script Right is set to DENY by default, meaning that if you do not have it explicitly, you will not be able to execute the scripts that you write with your user account.

100

101

However, for backward-compatibility reasons, the standard XWiki Enterprise distribution comes with the Script Right being allowed for all users at the main wiki level, so that, unless you (as an Admin) explicitly revoke the right for some users or explicitly deny it, they will be able to execute the scripts they wrote, just like before.

102

103

{{image reference="ReleaseNotes.ReleaseNotesXWiki72@scriptRightsExplicitlyAllowedInXWikiPreferences.png"/}}

== Flamingo ==

Following the introduction of the Nested Pages feature, we have changed a lot our default skin, Flamingo:

108

109

* The top menu has been removed and replaced by a //drawer// menu that you can expand by clicking on the top right icon

110

* The add menu has been relocated near the edit one

111

* The L&F of the Add, Edit, and "More Actions" menus has been changed

112

* A lot of actions have been moved to the "More Actions" menu

113

* The page breadcrumb has suffered some changes:

114

** it is now also displayed on the wiki home page

115

** the wiki home page is now included when it is part of the current document's hierarchy, i.e. for children and descendants of the wiki home page. See [[XWIKI-12423>>http://jira.xwiki.org/browse/XWIKI-12423]] for more details.

116

** the sub-wiki pretty name is included between the home icon and the local page path

117

* The actions menus (edit, create, more actions) are now available from the rename, copy and delete actions.

118

* The create, copy and rename page actions have been modified to support nested pages:

119

** The source and target pages are displayed using the breadcrumb

120

** The target page can be selected using a document tree picker

121

** For advanced users there is also the option to specify the target page using some text input fields (location advanced edit mode). This is useful especially if you want to create/move the page under a parent that doesn't exist yet (you cannot use the tree picker in this case because the parent would not be available in the tree).

122

* The delete action proposes to delete the children of the page.

123

* The welcome message from the main wiki home page has been updated.

124

* The "Spaces" widget from the wiki dashboard has been replaced with "Pages" which shows the hierarchy of nested pages from that wiki.

125

* For non terminal pages, we have introduced a "Page Administration", where you will find settings that concern the page and its children (it's actually the old space administration behind the scene). But we have also introduced 2 sections for setting rights on these pages:

126

** a section to set rights for the page only.

127

** a section to set rights for the page and its children.

128

* For terminal pages, nothing changes, you can change the access rights of the page in the "edit" menu. The only addition is a "Administer Parent" link in the "More actions" menu to administer the parent page (which again is the space administration behind the scene).

129

* The create action has been re-looked (with the introduction of the "page type" field) and proposes to import an office document.

130

* A new "children" viewer is now accessible in the "more actions" menu, along with the other viewers.

131

* For Terminal Pages, a new "siblings" viewer is present, which replaces the old "space index" feature.

author	version	line-number	content
		1	{{box cssClass="floatinginfobox" title="Contents"}}
		2	{{toc/}}
		3	{{/box}}
		4
		5	This is a summary of the release notes for [[XWiki Commons>>http://commons.xwiki.org]], [[XWiki Rendering>>http://rendering.xwiki.org]], [[XWiki Platform>>http://platform.xwiki.org]] and [[XWiki Enterprise>>http://enterprise.xwiki.org]], for the whole 7.x cycle (i.e. the whole year 2015). They share the same release notes as they are released together and have the same version.
		6
		7	The biggest highlight of this cycle is definitely the introduction of Nested Pages and all the consequences that ensued (see below). More work on Nested Pages has also been done in the 8.x cycle.
		8
		9	= Work Done =
		10
		11	The work is organised using [[JIRA>>http://jira.wiki.org]] and here are some [[JIRA stats of what happened during the 7.x cycle>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=13692]]:
		12	* 1557 issues were closed (See the [[full JIRA issue list>>http://jira.xwiki.org/issues/?filter=14396]])
		13	* 696 bugs closed, 541 improvements, 83 new features and more:(((
		14	{{image reference="jira-issue-types-7x.png"/}}
		15	)))
		16	* And the top JIRA participants (these are those contributing to more than 1% of the total jira issue number):(((
		17	{{image reference="jira-assignees-7x.png"/}}
		18	)))
		19
		20	Congrats to all who participated!
		21
		22	= Top 10 Features =
		23
		24	For our users, here are some top 10 features that we wish to highlight (arbitrarily hand-picked; it's hard to pick 10 out of 624 improvements and new features!).
		25
		26	{{toc scope='local' depth='2'/}}
		27
		28	== Document Diffs ==
		29
		30	The document history view that shows the differences between two versions of a document has been improved:
		31
		32	* The new summary gives you an overview of the changes and provides fast navigation.
		33	* The changes made to the short text properties (e.g. title, which has only one line of text) are more readable now.
		34	* You can see the changes that have been made to a text attachment. For non-text attachments you can see the difference in the file size.
		35	* You can see detailed changes to a class definition (e.g. which meta properties, like 'Custom Display', have been modified).
		36
		37	{{image reference="ReleaseNotes.ReleaseNotesXWiki70RC1@history-compareDocumentVersions.png"/}}
		38
		39	See the [[Version Control feature documentation>>platform:Features.VersionControl]] for more details.
		40
		41	== Wiki Creation ==
		42
		43	* During the wiki creation, Distribution Wizard is not triggered anymore. Instead, the whole wiki creation process has been moved into a job, and everything happens inside the Wiki Creation Wizard (with a progress bar and a logging area):(((
		44	{{image reference="[email protected]" width="45%"/}} {{image reference="[email protected]" width="45%"/}}
		45	)))
		46	* The Wiki Provisioning Step has been integrated into the job too.
		47	* When a wiki is created from a template, we now have a message in the logs that displays which document is copied.
		48
		49	== Document Index Tree Finder ==
		50
		51	You can now easily find documents and attachments from the tree view of the Document Index.
		52
		53	{{image reference="[email protected]"/}}
		54
		55	Checkout the [[Index Application>>extensions:Extension.Index Application]] for more details.
		56
		57	== Solr Search ==
		58
		59	* We worked on making the search UI responsive on small screens. On mobile phones the list of search facets is now collapsed above the search results and the user can toggle it with a tap. We improved the way the search results of type Object and Object Property are displayed (check the result title and location / breadcrumb). We switched to using the icon themes for the search result icons and we also fixed some small spacing and alignment issues introduced by the migration from the old Colibri skin to the new Flamingo skin. Last but not least, we worked on refreshing the search UI without reloading the entire page when the user sorts the search results, uses the pagination or drills down the results using the search facets.(((
		60	{{image reference="[email protected]"/}}
		61	)))
		62	* It's now possible to disable highlighting and faceting which are very slow tasks. Can be controlled directly from the search UI or from the Main.SolrSearchConfig document.(((
		63	{{image reference="ReleaseNotes.ReleaseNotesXWiki71RC1@solr_options.png"/}}
		64	)))
		65
		66	See the [[Solr Search Application>>extensions:Extension.Solr Search Application]] documentation for more details.
		67
		68	== Nested Pages ==
		69
		70	It's now possible to create wiki pages inside other wiki pages. More specifically we've decided to drop the concept of Space in the UI (it's still there at the API/platform level) and instead, to replace it with the concept of Nested Pages.
		71
		72	We've also decided to drop the concept of Parent/Child relationship since it was too complex for end users to have 2 hierarchies: the Space/Page hierarchy and the Parent/Child hierarchy. The Parent/Child hierarchy also had limitations: you couldn't inherit page permissions for example. Thus the idea is to have a single hierarchy based on Nested Pages.
		73
		74	Advantages of Nested Pages:
		75
		76	* The URL reflects the page hierarchy
		77	* Finer-grained control: Ability to set permissions at each level
		78	* Generally speaking, a nicer and simpler way to organize your content hierarchically
		79	* Moving and Deleting pages updates the hierarchy
		80
		81	Terminology:
		82
		83	* Nested Page (a.k.a Non-Terminal Page): This is a wiki page that can have children pages. Technically a Nested Page is implemented as a Nested Space (i.e. a WebHome page).
		84	* Non-Nested Page (a.k.a Terminal Page): This a wiki page that cannot have children pages. Applications and script can create Terminal Pages. Advanced Users will also be able to create Terminal Pages from the UI. Standard Users will only be able to create Nested Pages.
		85	* Nested Space: A Space which has another Space as parent. As mentioned above, a Nested Page is technically implemented as a Nested Space. You will used the term Nested Space when speaking technically about XWiki APIs for example but when talking about UI you should favor using the term Nested Page instead.
		86
		87	For more information, see [[Content Organization>>platform:Features.ContentOrganization\|\|anchor="HHistory"]].
		88
		89	We have worked a lot to minimize the retro-compatibility issues. However, some Extensions are not adapted for //Nested Pages// yet, and their execution is still sub-optimal. For the next releases, we plan to work on the adaptation of these Extensions.
		90
		91	== Script right ==
		92
		93	A new Script Right has been added to allow controlling who has the right to write Scripts. Specifically anyone with Edit rights can edit a page and write a Script in it. However, when the page is rendered the script will only execute if the last author of the page has the Script right.
		94
		95	Example when the author of a script doesn't have the Script right:
		96
		97	{{image reference="[email protected]"/}}
		98
		99	The Script Right is set to DENY by default, meaning that if you do not have it explicitly, you will not be able to execute the scripts that you write with your user account.
		100
		101	However, for backward-compatibility reasons, the standard XWiki Enterprise distribution comes with the Script Right being allowed for all users at the main wiki level, so that, unless you (as an Admin) explicitly revoke the right for some users or explicitly deny it, they will be able to execute the scripts they wrote, just like before.
		102
		103	{{image reference="ReleaseNotes.ReleaseNotesXWiki72@scriptRightsExplicitlyAllowedInXWikiPreferences.png"/}}
		104
		105	== Flamingo ==
		106
		107	Following the introduction of the Nested Pages feature, we have changed a lot our default skin, Flamingo:
		108
		109	* The top menu has been removed and replaced by a //drawer// menu that you can expand by clicking on the top right icon
		110	* The add menu has been relocated near the edit one
		111	* The L&F of the Add, Edit, and "More Actions" menus has been changed
		112	* A lot of actions have been moved to the "More Actions" menu
		113	* The page breadcrumb has suffered some changes:
		114	** it is now also displayed on the wiki home page
		115	** the wiki home page is now included when it is part of the current document's hierarchy, i.e. for children and descendants of the wiki home page. See [[XWIKI-12423>>http://jira.xwiki.org/browse/XWIKI-12423]] for more details.
		116	** the sub-wiki pretty name is included between the home icon and the local page path
		117	* The actions menus (edit, create, more actions) are now available from the rename, copy and delete actions.
		118	* The create, copy and rename page actions have been modified to support nested pages:
		119	** The source and target pages are displayed using the breadcrumb
		120	** The target page can be selected using a document tree picker
		121	** For advanced users there is also the option to specify the target page using some text input fields (location advanced edit mode). This is useful especially if you want to create/move the page under a parent that doesn't exist yet (you cannot use the tree picker in this case because the parent would not be available in the tree).
		122	* The delete action proposes to delete the children of the page.
		123	* The welcome message from the main wiki home page has been updated.
		124	* The "Spaces" widget from the wiki dashboard has been replaced with "Pages" which shows the hierarchy of nested pages from that wiki.
		125	* For non terminal pages, we have introduced a "Page Administration", where you will find settings that concern the page and its children (it's actually the old space administration behind the scene). But we have also introduced 2 sections for setting rights on these pages:
		126	** a section to set rights for the page only.
		127	** a section to set rights for the page and its children.
		128	* For terminal pages, nothing changes, you can change the access rights of the page in the "edit" menu. The only addition is a "Administer Parent" link in the "More actions" menu to administer the parent page (which again is the space administration behind the scene).
		129	* The create action has been re-looked (with the introduction of the "page type" field) and proposes to import an office document.
		130	* A new "children" viewer is now accessible in the "more actions" menu, along with the other viewers.
		131	* For Terminal Pages, a new "siblings" viewer is present, which replaces the old "space index" feature.
		132
		133	{{gallery}}
		134	image:[email protected]
		135	image:[email protected]
		136	image:ReleaseNotes.ReleaseNotesXWiki72M3@more_actions.png
		137	image:[email protected]
		138	image:[email protected]
		139	image:[email protected]
		140	image:ReleaseNotes.ReleaseNotesXWiki72M3@homepageInBreadcrumbs-after.png
		141	image:[email protected]
		142	image:[email protected]
		143	image:[email protected]
		144	image:[email protected]
		145	image:[email protected]
		146	image:[email protected]
		147	image:[email protected]
		148	image:[email protected]
		149	image:[email protected]
		150	image:[email protected]
		151	image:[email protected]
		152	image:ReleaseNotes.ReleaseNotesXWiki72RC1@AdminPageAndChildrenRights.png
		153	image:[email protected]
		154	image:[email protected]
		155	image:[email protected]
		156	image:[email protected]
		157	image:[email protected]
		158	image:[email protected]
		159	{{/gallery}}
		160
		161	== More Flamingo ==
		162
		163	=== Navigation bar ===
		164
		165	The user's avatar is now displayed between the search icon and the drawer icon:
		166
		167	(((
		168	{{image reference="[email protected]"/}}
		169	)))
		170
		171	Also, the search bar at the top of the screen has been improved a bit. When the user clicks on the search button, the search bar is opened and gets the focus. Then, when the users clicks in some other place, the search bar is closed, slowly.
		172
		173	* Closed:(((
		174	{{image reference="[email protected]"/}}
		175	)))
		176	* Open:(((
		177	{{image reference="[email protected]"/}}
		178	)))
		179
		180	=== Menus ===
		181
		182	The "More Options" menu has been split and a new "Page Administration" menu has been introduced:
		183
		184	{{gallery}}
		185	image:ReleaseNotes.ReleaseNotesXWiki73M2@content_menus.png
		186	image:[email protected]
		187	image:[email protected]
		188	{{/gallery}}
		189
		190	=== Delete ===
		191
		192	* The delele UI now uses the 'title' and 'location' columns to list the children that may be affected by the delete action:(((
		193	{{image reference="[email protected]" width="33%"/}}
		194	)))
		195
		196	=== Drawer ===
		197
		198	* In the Drawer (top right menu), the pages for which the user doesn't have permissions to access are not displayed anymore.
		199
		200	== Breadcrumb ==
		201
		202	When the hierarchy of a Nested Pages is long, we do not display it entirely any more. Instead, we display a limited version, that the user can expand by clicking on the "ellipsis" character ('...'):
		203
		204	* limited:(((
		205	{{image reference="[email protected]"/}}
		206	)))
		207	* full:(((
		208	{{image reference="[email protected]"/}}
		209	)))
		210
		211	Note that this behavior have also been added to all hierarchy breadcrumbs, including location of search results, etc...
		212
		213	(((
		214	{{image reference="[email protected]"/}}
		215	)))
		216
		217	The breadcrumb has now support for tree navigation. Each breadcrumb element has a drop down tree that shows the siblings and the children, helping you navigate easily around the wiki.
		218
		219	{{image reference="[email protected]"/}}
		220
		221	The breadcrumb tree navigation doesn't show the document translations any more when multilingual is disabled, because navigating to a document translation when multilingual is off doesn't have any effect: the default translation is displayed instead. You can still see the translations in the [[Page Index Tree>>extensions:Extension.Index Application\|\|anchor="HAllDocumentsinatreeview"]] though.
		222
		223	== Notifications & Watchlist ==
		224
		225	* A new menu has been added to the top bar, on the right: the "notifications" menu (represented by a bell). In the future, it will be the place where you can find notifications about some events happening on the wiki (personal message, a page has been modified, etc...).(((
		226	{{image reference="[email protected]"/}}
		227	)))
		228	* In this menu, we have moved the Watchlist icons (watch this page, watch this wiki, etc...). These actions can be triggered with the new switch buttons.(((
		229	{{image reference="[email protected]"/}}
		230	)))
		231	* The livetable of the [[WatchList macro>>extensions:Extension.Watchlist Application]] have been updated to support Nested Pages.(((
		232	{{image reference="[email protected]"/}}
		233	)))
		234
		235	= Detailed Release Notes =
		236
		237	If you wish to see the full details of all features and improvements you can check each release note.
		238
		239	{{include reference = "ReleaseNotes.ReleaseNotesXWiki7x.WebHome"/}}

Wiki source code of Summary of the XWiki 7.x Cycle

Quick Links

Let us know

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected