Last modified by Thomas Mortagne on 2023/10/13

Show last authors
1 (% style="font-size:x-large;" %)
4 {{box cssClass="floatinginfobox" title="**Contents**"}}
5 {{toc/}}
6 {{/box}}
8 This is the second milestone of the XWiki Enterprise 4.1 version ([[Roadmap>>Main.Roadmap]]). This version brings improvements to the Extension Manager's handling of updates to configuration documents, new localization through timezone settings, and customization of chart colors as well as many bug fixes and improvements.
10 = New and Noteworthy (since XWiki Enterprise 4.1 version) =
12 == Custom Chart Colors ==
14 It's now possible to select [[custom colors in Chart graphs>>extensions:Extension.Chart Macro]]. For example:
16 {{code}}
17 {{chart type="pie" source="inline" params="range:B2-D5;series:columns;colors:C3E3F7,1D9FF5,015891,012A45" title="Chart Test" width="320" height="240"}}
18 | |X |Y |Z
19 |Q1|1.2|3.4|1.3
20 |Q2|4.5|3.4|2.3
21 |Q3|1.2|4.5|9.0
22 |Q4|3.4|1.2|1.2
23 {{/chart}}
24 {{/code}}
26 Will generate:
28 {{image reference="extensions:Extension.Chart [email protected]"/}}
30 == Hide Technical Documents ==
32 * In the activity stream, events (such as edit or delete) triggered by hidden documents do not appear unless the user chose to "display hidden documents" in his user preferences.
34 == Extension Manager improvements ==
36 XWiki Enterprise 4.1 milestone 2 comes with a first version of the Merge Conflict Resolution UI. From now on, when your upgrade a XAR extension and the extension manager fails to automatically merge your changes with the changes from the new version of the extension the extension manager will guide you to resolve the conflict.
38 {{image reference="EM-mergeConflict.png"/}}
40 In its first iteration the UI only allows you to choose which version to keep. You can compare the versions to make the right decision. Only the document content changes are displayed for the moment. The plan is to show all document changes (including meta data, objects, class, attachments) in 4.1 final and to allow you to edit the diff, i.e. create a custom version, in XWiki Enterprise 4.2.
42 Other minor improvements of the extension manager UI include:
44 * Mark 'Show Details', 'Hide Details' and 'Back to list' buttons as secondary buttons
45 * Display an "upgrade" button instead of an "install" one when an extension is already installed
46 * Better messages for empty search results
48 See the [[Extension Manager Application documentation>>doc:extensions:Extension.Extension Manager Application]] for more details.
50 == Global and per-user timezone setting ==
52 Wiki administrators can now decide to use a specific timezone, without having to take care of the one set on the server. The following setting can be found under **Administration > Localization**.
53 Users will find the same setting, allowing them to see dates reflecting their current location. The user setting is accessible through **Profile > Preferences > Localization Preferences**.
55 {{image reference="timezone.jpg"/}}
57 == New macro for sending messages ==
59 The control which allows users to send messages that is displayed on top of the Activity Stream can now be used outside of the activity macro by calling {{{{{messageSender /}}}}}.
61 {{image reference="messageSenderMacro.png"/}}
63 == For developers ==
65 * There's a [[new Script Service allowing to access the Component Manager directly from scripts>>Documentation.DevGuide.Scripting||anchor="HXWikiComponentAccess"]]. For example:(((
66 {{code}}
67 {{groovy}}
68 def myComponent = services.component.getInstance(MyComponentRole.class)
69 {{/groovy}}
70 {{/code}}
71 )))
72 * We added a [[new Velocity uberspector that tries to convert method arguments>>doc:extensions:Extension.Velocity Module||anchor="HMethodArgumentsUberspector"]] to formal parameter types when the passed arguments don't match the method signature. For example:(((
73 {{code}}
74 $obj.someMethod('VALUE')
75 // will forward to
76 obj.someMethod(SomeEnum.VALUE)
77 // if obj has a method with signature someMethod(SomeEnum) and not someMethod(String)
78 {{/code}}
80 But this is not limited to enums. The conversion is done using the [[Properties Module>>doc:extensions:Extension.Properties Module]] which means you can create and register custom converters for data types specific to your application domain.
81 )))
82 * It's now much easier to share variable between languages. You're now allowed to write (for example):(((
83 {{code language="none"}}
84 {{groovy}}
85 var = "toto"
86 {{/groovy}}
88 {{velocity}}
89 $var
90 {{/velocity}}
91 {{/code}}
92 )))
94 = Bug fixes and improvements =
96 * Filenames of entries in XAR files are now [[always decoded using UTF-8 during import>>]]. The previous behavior was to use the platform encoding. The filenames have always been encoded using UTF-8 in XAR files, but now also the Unicode extra fields are included, so unpacking XAR files with InfoZIP will result in the filenames beeing properly reencoded with the local filesystems character set.
98 * Temporary files are now placed in a special sub-directory of the normal temporary directory, this sub-directory called "xwiki-temp" is deleted after each startup of the xwiki system so it is critical that nothing else it placed in it. This improvement means that temporary files such as cached attachments will be removed even if the JVM crashes.
100 * It is now possible to delete pages and attachments before the initial import of wiki contents.
102 * The ability to delete messages from the Activity Stream is working again. It had [[stopped working>>]] since 3.5.
104 See the full list of [[JIRA issues>>]] fixed in this release.
106 == Upgrades ==
108 The following dependencies have been upgraded:
110 * Restlet 2.0.14
111 ** Prior to Restlet 2.0.14, there was a REST bug allowing arbitrary filesystem read access for registered users.
112 * Reflections 0.9.7
114 = Test Report =
116 You can check the [[manual test report>>TestReports.ManualTestReportXE41M2]] to learn about what was tested and the results on various browsers.
118 == Tested Browsers ==
120 Here's the list of browsers tested with this version (i.e. browsers that we've tested as working - Check the list of [[supported browsers>>dev:Community.BrowserSupportStrategy]]):
122 {{browser name="firefox" version="12.0.1"/}}
124 == Tested Databases ==
126 {{database name="hsqldb" version="2.2.8"/}}
128 = Known issues =
130 * [[Bugs we know about>>]]
132 = Upgrade Notes =
134 == Version-specific Upgrade Notes ==
136 * The location where the HSQLDB database is located in the Standalone distribution has changed from ##database/## to ##data/database## in order to group all data in the same directory. The location of the HSQLDB is specified in ##hibernate.cfg.xml## with a default value of {{code}}jdbc:hsqldb:file:${environment.permanentDirectory}/database/xwiki_db;shutdown=true{{/code}}. Notice the introduction of the new ##${environment.permanentDirectory}## variable which points to the directory defined in in the ##environment.permanentDirectory## property (which defaults to ##data## for the Standalone distribution). When upgrading, make sure the location you have in your ##hibernate.cfg.xml## file matches the location where your HSQLDB database is located.
137 * The behavior of the ##justify## parameter of the ##{~{container}}## macro, and its usage in the ##{~{dashboard}}## macro have changed. Initially, specifying ##justify="true"## when using the ##container## macro used to justify all the text inside it, but due to a regression in 3.1, the parameter stopped working as [[documented>>doc:extensions:Extension.Container Macro]]. The regression has been remedied, and now the ##justify## parameters works again. However, the dashboard macro doesn't specify this parameter anymore, and so the text inside the dashboard widgets is not justified. If you still want to have justified text in certain widgets, we recommend that you explicitly change the style of those widgets only.
139 == General Upgrade Notes ==
141 {{info}}
142 If you're running in a multiwiki setup you'll also need to define the property // in your //xwiki.cfg// file if you want to explicitly name some databases to be migrated as the default is now to migrate all databases. Database that are not migrated could not be accessed.
143 {{/info}}
145 You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from all the improvements listed above.
147 {{warning}}
148 Always make sure you compare your ##xwiki.cfg## and files with the newest version since some configuration parameters were added. Note that you should add so that XWiki will attempt to automatically migrate your current database to the new schema. Make sure you backup your Database before doing anything.
149 {{/warning}}
151 == API Breakages ==
153 The following APIs were modified since version 4.0:
155 * Breakage in Query module done to support adding several Filters to a Query:(((
156 {{code language="none"}}
157 org.xwiki.query.QueryFilter: Method 'public java.util.List filterResults(java.util.List)' has been added to an interface
158 {{/code}}
159 )))
160 * This method should have been internal from the beginning:(((
161 {{code language="none"}}
162 org.xwiki.environment.EnvironmentConfiguration: Class org.xwiki.environment.EnvironmentConfiguration removed
163 {{/code}}
164 )))
165 * The Job module is new and is still considered a "young API":(((
166 {{code language="none"}}
167 org.xwiki.job.AbstractJob: Changed type of field status from org.xwiki.job.internal.DefaultJobStatus to org.xwiki.job.internal.AbstractJobStatus
168 org.xwiki.job.AbstractJob: Return type of method 'protected org.xwiki.job.internal.DefaultJobStatus createNewStatus(org.xwiki.job.Request)' has been changed to org.xwiki.job.internal.AbstractJobStatus
169 org.xwiki.job.AbstractJob: Method 'protected java.lang.String getId()' has been removed
170 org.xwiki.job.AbstractRequest: Return type of method 'public java.lang.String getId()' has been changed to java.util.List
171 org.xwiki.job.Job: Method 'public void join()' has been added to an interface
172 org.xwiki.job.Job: Method 'public boolean join(long, java.util.concurrent.TimeUnit)' has been added to an interface
173 org.xwiki.job.JobManager: Method 'public org.xwiki.job.event.status.JobStatus getJobStatus(java.util.List)' has been added to an interface
174 org.xwiki.job.Request: Return type of method 'public java.lang.String getId()' has been changed to java.util.List
175 org.xwiki.job.event.JobEvent: Return type of method 'public java.lang.String getJobId()' has been changed to java.util.List
176 org.xwiki.job.event.JobFinishedEvent: Return type of method 'public java.lang.String getJobId()' has been changed to java.util.List
177 org.xwiki.job.event.JobStartedEvent: Return type of method 'public java.lang.String getJobId()' has been changed to java.util.List
178 org.xwiki.job.event.status.JobStatus: Method 'public java.util.Date getEndDate()' has been added to an interface
179 org.xwiki.job.event.status.JobStatus: Method 'public java.util.Date getStartDate()' has been added to an interface
180 {{/code}}
181 )))
182 * The Extension module is relatively new and is still undergoing some API tuning:(((
183 {{code language="none"}}
184 org.xwiki.extension.job.plan.ExtensionPlan: Return type of method 'public java.util.Collection getTree()' has been changed to org.xwiki.extension.job.plan.ExtensionPlanTree
185 org.xwiki.extension.version.VersionConstraint: Method 'public boolean isCompatible(org.xwiki.extension.version.Version)' has been added to an interface
186 {{/code}}
187 )))
188 * This class was added in 3.2M2 by error in a user-public package. It's been moved again in the internal package as it should have been. We don't expect many users to be affected by this:(((
189 {{code language="none"}}
190 com.xpn.xwiki.doc.merge.MergeUtils: Class com.xpn.xwiki.doc.merge.MergeUtils removed
191 {{/code}}
192 )))
193 * In 2.2M1 we refactored BaseCollection to add getXClass() but we forgot to add it to the ObjectInterface interface. Even though this could break user we think it's very limited since nobody should implement directly ObjectInterface; instead everyone should extend BaseClass or BaseCollection:(((
194 {{code language="none"}}
195 com.xpn.xwiki.objects.ObjectInterface: Method 'public com.xpn.xwiki.objects.classes.BaseClass getXClass(com.xpn.xwiki.XWikiContext)' has been added to an interface
196 {{/code}}
197 )))
198 * The Autotag plugin has been extracted from the oldcore module and is now a module on its own so the following are not real breakages:(((
199 {{code language="none"}}
200 com.xpn.xwiki.plugin.autotag.AutoTagPlugin: Class com.xpn.xwiki.plugin.autotag.AutoTagPlugin removed
201 com.xpn.xwiki.plugin.autotag.AutoTagPluginAPI: Class com.xpn.xwiki.plugin.autotag.AutoTagPluginAPI removed
202 com.xpn.xwiki.plugin.autotag.FrenchStemmer: Class com.xpn.xwiki.plugin.autotag.FrenchStemmer removed
203 com.xpn.xwiki.plugin.autotag.Tag: Class com.xpn.xwiki.plugin.autotag.Tag removed
204 com.xpn.xwiki.plugin.autotag.TagCloud: Class com.xpn.xwiki.plugin.autotag.TagCloud removed
205 {{/code}}
206 )))
207 * The WYSIWYG Diff and Sync plugins have been extracted into their own modules so the following are not real breakages:(((
208 {{code language="none"}}
209 org.xwiki.gwt.wysiwyg.client.Images: Method 'public sync()' has been removed
210 org.xwiki.gwt.wysiwyg.client.Strings: Method 'public java.lang.String sync()' has been removed
211 org.xwiki.gwt.wysiwyg.client.diff.AddDelta: Class org.xwiki.gwt.wysiwyg.client.diff.AddDelta removed
212 org.xwiki.gwt.wysiwyg.client.diff.ChangeDelta: Class org.xwiki.gwt.wysiwyg.client.diff.ChangeDelta removed
213 org.xwiki.gwt.wysiwyg.client.diff.Chunk: Class org.xwiki.gwt.wysiwyg.client.diff.Chunk removed
214 org.xwiki.gwt.wysiwyg.client.diff.DeleteDelta: Class org.xwiki.gwt.wysiwyg.client.diff.DeleteDelta removed
215 org.xwiki.gwt.wysiwyg.client.diff.Delta: Class org.xwiki.gwt.wysiwyg.client.diff.Delta removed
216 org.xwiki.gwt.wysiwyg.client.diff.Diff: Class org.xwiki.gwt.wysiwyg.client.diff.Diff removed
217 org.xwiki.gwt.wysiwyg.client.diff.DiffAlgorithm: Class org.xwiki.gwt.wysiwyg.client.diff.DiffAlgorithm removed
218 org.xwiki.gwt.wysiwyg.client.diff.DiffException: Class org.xwiki.gwt.wysiwyg.client.diff.DiffException removed
219 org.xwiki.gwt.wysiwyg.client.diff.DifferentiationFailedException: Class org.xwiki.gwt.wysiwyg.client.diff.DifferentiationFailedException removed
220 org.xwiki.gwt.wysiwyg.client.diff.PatchFailedException: Class org.xwiki.gwt.wysiwyg.client.diff.PatchFailedException removed
221 org.xwiki.gwt.wysiwyg.client.diff.Revision: Class org.xwiki.gwt.wysiwyg.client.diff.Revision removed
222 org.xwiki.gwt.wysiwyg.client.diff.RevisionVisitor: Class org.xwiki.gwt.wysiwyg.client.diff.RevisionVisitor removed
223 org.xwiki.gwt.wysiwyg.client.diff.SimpleDiff: Class org.xwiki.gwt.wysiwyg.client.diff.SimpleDiff removed
224 org.xwiki.gwt.wysiwyg.client.diff.ToString: Class org.xwiki.gwt.wysiwyg.client.diff.ToString removed
225 org.xwiki.gwt.wysiwyg.client.diff.myers.DiffNode: Class org.xwiki.gwt.wysiwyg.client.diff.myers.DiffNode removed
226 org.xwiki.gwt.wysiwyg.client.diff.myers.MyersDiff: Class org.xwiki.gwt.wysiwyg.client.diff.myers.MyersDiff removed
227 org.xwiki.gwt.wysiwyg.client.diff.myers.PathNode: Class org.xwiki.gwt.wysiwyg.client.diff.myers.PathNode removed
228 org.xwiki.gwt.wysiwyg.client.diff.myers.Snake: Class org.xwiki.gwt.wysiwyg.client.diff.myers.Snake removed
229 org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncPlugin: Class org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncPlugin removed
230 org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncPluginFactory: Class org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncPluginFactory removed
231 org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncResult: Class org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncResult removed
232 org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncService: Class org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncService removed
233 org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncServiceAsync: Class org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncServiceAsync removed
234 org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncStatus: Class org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncStatus removed
235 org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncTools: Class org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncTools removed
236 org.xwiki.wysiwyg.server.plugin.sync.SyncEngine: Class org.xwiki.wysiwyg.server.plugin.sync.SyncEngine removed
237 org.xwiki.wysiwyg.server.plugin.sync.SyncException: Class org.xwiki.wysiwyg.server.plugin.sync.SyncException removed
238 {{/code}}
239 )))

Get Connected