Wiki source code of XWiki Enterprise 2.5 Milestone 2
Version 38.1 by Sorin Burjan on 2010/10/04
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} | ||
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | Second milestone of the XWiki Enterprise 2.5 version ([[Roadmap>>enterprise:Main.Roadmap]]). | ||
| 6 | |||
| 7 | The highlights of this release are: support for [[viewing attached office documents>>code:Macros.OfficeMacro]] in the wiki, an experimental Extension Manager, experimental [[CSRF>>http://en.wikipedia.org/wiki/CSRF]] protection, a new User Directory, further improvements to the edit UI, more consistent [[use of user avatars>>http://incubator.myxwiki.org/xwiki/bin/view/Improvements/Avatars]], support for activating a special accessibility stylesheet, and an experimental ##xwiki/2.1## wiki syntax. | ||
| 8 | |||
| 9 | = New and Noteworthy (since XWiki Enterprise 2.4) = | ||
| 10 | |||
| 11 | == Support for viewing attached office documents in the wiki == | ||
| 12 | |||
| 13 | XWiki now supports viewing attached office documents without saving them on the client side. | ||
| 14 | |||
| 15 | [[image:OfficePreview.png||style="border:1px solid black;"]] | ||
| 16 | |||
| 17 | We also included a new Macro for the WYSIWYG Editor. It allows to embed a office file into a page. | ||
| 18 | |||
| 19 | [[image:MacroOfficeViewer||style="border:1px solid black;"]] | ||
| 20 | |||
| 21 | == Experimental Extension Manager == | ||
| 22 | |||
| 23 | == New User Directory == | ||
| 24 | |||
| 25 | image:userdir.png | ||
| 26 | |||
| 27 | == Further improvements to the edit UI == | ||
| 28 | |||
| 29 | After the improvements to the object and class editors introduced in 1.8 and 2.4, the wiki and WYSIWYG editors also see some enhancements in this release, bringing in some of the proposed changes from [[an older proposal>>http://incubator.myxwiki.org/xwiki/bin/Improvements/ImprovedEdit]], with some additional improvements. Specifically: | ||
| 30 | |||
| 31 | * A new label for the content area in the wiki editor:((( | ||
| 32 | image:edit-header.png | ||
| 33 | ))) | ||
| 34 | * A more descriptive label for the version summary field | ||
| 35 | * Better positioning of the "minor edit" option | ||
| 36 | * Better positioning and display of the "autosave" option((( | ||
| 37 | image:edit-footer.png | ||
| 38 | ))) | ||
| 39 | |||
| 40 | == More consistent use of user avatars == | ||
| 41 | |||
| 42 | As proposed on [[the design page>>http://incubator.myxwiki.org/xwiki/bin/Improvements/Avatars]], avatars come in three default sizes: | ||
| 43 | |||
| 44 | * small avatars, 30px wide, used in secondary actions and where there's very little space available | ||
| 45 | * medium avatars, 50px wide, the preferred and most frequent display option for avatars | ||
| 46 | * large avatars,120px wide, to be used where a large version of the avatar must be displayed (for example in the user profile) | ||
| 47 | |||
| 48 | Accordingly, the wiki dashboard has been changed to use the medium avatars, and as a new feature user avatars are displayed in the comments area. | ||
| 49 | |||
| 50 | image:comment-avatars.png | ||
| 51 | |||
| 52 | Four new velocity macros have been added for making it easier to display avatars: | ||
| 53 | |||
| 54 | * ###smallUserAvatar('XWiki.username')## | ||
| 55 | * ###mediumUserAvatar('XWiki.username')## | ||
| 56 | * ###largeUserAvatar('XWiki.username')## | ||
| 57 | * ###resizedUserAvatar('XWiki.username', 100)## which allows resizing an avatar to a custom size | ||
| 58 | |||
| 59 | == More image manipulation settings == | ||
| 60 | |||
| 61 | For a long time it was possible to scale attached images on the server, thus reducing the download time and ensuring consistent scaling of images across browsers. This is achieved by appending ##width## and/or ##height## query string parameters to the URL of the image. This feature has been further enhanced: | ||
| 62 | |||
| 63 | * It is now possible to force the same aspect ratio of the original picture even when both width/height parameters were used (the ##keepAspectRatio## parameter). In case the requested width and height don't match the original aspect ratio, the image is resized to fit inside the rectangle defined by the two parameters, i.e. the resized image will not exceed the requested dimensions. | ||
| 64 | * The size of the generated JPGs can be further tweaked by specifying an encoding ##quality## (the configurable default is at 30%, but will be changed to 50% before the final release). This does not affect lossless image formats such as PNG. | ||
| 65 | * The WYSIWYG editor also supports the width and height parameters, setting them as needed when manually resizing the image in the editor. | ||
| 66 | |||
| 67 | {{code language="none"}} | ||
| 68 | /xwiki/bin/download/Spage/Page/logo.jpg?width=1024&height=768&keepAspectRatio=true&quality=0.8 | ||
| 69 | {{/code}} | ||
| 70 | |||
| 71 | Note that this does not affect images from the filesystem, which are served directly by the servlet conainer and do not pass through XWiki's image handling code. Also note that in case the image processing triggers any errors, the original image will be sent unchanged, so the requested image dimensions are not guaranteed. | ||
| 72 | |||
| 73 | Example: | ||
| 74 | |||
| 75 | {{code language="html"}} | ||
| 76 | {{velocity}}{{html wiki=false}} | ||
| 77 | <img src="$doc.getAttachmentURL('mw.jpg', 'download', 'width=150&quality=1')"/> | ||
| 78 | <img src="$doc.getAttachmentURL('mw.jpg', 'download', 'width=150')"/> | ||
| 79 | <img src="$doc.getAttachmentURL('mw.jpg', 'download', 'width=150&quality=0')"/> | ||
| 80 | <img src="$doc.getAttachmentURL('mw.jpg', 'download', 'width=150&height=100&quality=0.7')"/> | ||
| 81 | <img src="$doc.getAttachmentURL('mw.jpg', 'download', 'width=150&height=100&quality=0.7&keepAspectRatio=true')"/> | ||
| 82 | {{/html}}{{/velocity}} | ||
| 83 | {{/code}} | ||
| 84 | |||
| 85 | Gives: | ||
| 86 | |||
| 87 | image:img.png | ||
| 88 | |||
| 89 | == Better handling of attachment versions when rolling back documents == | ||
| 90 | |||
| 91 | Rolling back a document will also roll back the correct attachment version, including restoring a deleted attachment from the trash (if not manually deleted from there). Even if an attachment was deleted and re-uploaded several times, the platform will try to find the right version for the attachment, if it still exists in the attachment trash. As an improvement, if the attachment did not change, then a new version is not created. | ||
| 92 | |||
| 93 | == Preliminary optional accessibility stylesheet == | ||
| 94 | |||
| 95 | Moving further on the quest for better accessibility in the XWiki platform, we introduced a preliminary stylesheet which makes the skin slightly more accessible to people with visual disabilities: bigger fonts by default, and underlined links to make them more easily distinguished by colorblind people. This stylesheet can either be activated globally in a wiki, or individually from each user's preferences. | ||
| 96 | |||
| 97 | Enabling the special stylesheet: | ||
| 98 | |||
| 99 | image:a11y-enable.png | ||
| 100 | |||
| 101 | Bigger fonts and underlined links: | ||
| 102 | |||
| 103 | image:a11y.png | ||
| 104 | |||
| 105 | == Experimental xwiki/2.1 wiki syntax == | ||
| 106 | |||
| 107 | The xwiki wiki syntax sees further improvements as xwiki/2.1, still in an experimental stage. A new feature is an enhanced syntax for links, which is more generic and allows easier extensions with new link types, demonstrated in this release with support for path and [[interwiki links>>http://en.wikipedia.org/wiki/Interwiki_links]]. | ||
| 108 | |||
| 109 | Basic syntax: | ||
| 110 | |||
| 111 | {{code language="none"}} | ||
| 112 | [[label>>referenceType:referenceData]] | ||
| 113 | {{/code}} | ||
| 114 | |||
| 115 | Special ##queryString## and ##anchor## parameters which will be used as the query string, respectively anchor when forming URLs. | ||
| 116 | |||
| 117 | {{code language="none"}} | ||
| 118 | [[label>>doc:My.Page||queryString="a=b&c=d" anchor="HSection1"]] | ||
| 119 | {{/code}} | ||
| 120 | |||
| 121 | Document references are still the implicit default, with the explicit ##doc:## reference type. The other standard reference types are ##url##, ##path##, ##mailto##, ##attach##, ##image##, ##interwiki##. | ||
| 122 | |||
| 123 | Path links allow to link to a relative path on the server, which makes it easier to combine wiki syntax and velocity code, using ##$doc.getURL##, in order to link to non-view actions on documents. | ||
| 124 | |||
| 125 | {{code language="none"}} | ||
| 126 | {{velocity}}[[reset the history>>path:$doc.getURL('reset')||queryString="confirm=1"]]{{/velocity}} | ||
| 127 | {{/code}} | ||
| 128 | |||
| 129 | === [[Interwiki links>>http://en.wikipedia.org/wiki/Interwiki_links]] === | ||
| 130 | |||
| 131 | Basic syntax: | ||
| 132 | |||
| 133 | {{code language="none"}} | ||
| 134 | [[label>>interwiki:wikiAlias:path/data]] | ||
| 135 | [[Interwiki links>>interwiki:wikipedia:Interwiki_links]] | ||
| 136 | {{/code}} | ||
| 137 | |||
| 138 | By default no sister wikis are defined. You can define some in ##xwiki.properties## by adding ##rendering.interWikiDefinitions## values: | ||
| 139 | |||
| 140 | {{code language="none"}} | ||
| 141 | rendering.interWikiDefinitions = wikipedia = http://en.wikipedia.org/wiki/ | ||
| 142 | rendering.interWikiDefinitions = udic = http://www.urbandictionary.com/define.php?term= | ||
| 143 | {{/code}} | ||
| 144 | |||
| 145 | == Various Security improvements == | ||
| 146 | |||
| 147 | Continuing a push for better security started this summer, 2.5M2 fixes some of the few remaining cross-site scripting and SQL injections holes, and tightens the scope of programming rights. Of particular concern: | ||
| 148 | |||
| 149 | * With a default skin, programming rights are no longer available after the main content of the page; this means that the panels and the bottom tabs can't use restricted APIs anymore. | ||
| 150 | * To explicitly drop programming rights, a new API method was introduced: ##$xcontext.dropPermissions()## | ||
| 151 | * An experimental Cross-Site Request Forgery prevention mechanism is included, though not enabled by default. To enable it and test/upgrade your custom applications for compatibility, edit ##xwiki.properties## and flip on the ##core.csrf.enabled## setting. | ||
| 152 | |||
| 153 | = Backward Compatibility and Migration Notes = | ||
| 154 | |||
| 155 | == General Notes == | ||
| 156 | |||
| 157 | {{warning}} | ||
| 158 | If you're running in a multiwiki setup you'll also need to define the property //xwiki.store.migration.databases=all// to your //xwiki.cfg// file or explicitly name all databases to be migrated as in //xwiki.store.migration.databases=db1,db2,...//. | ||
| 159 | {{/warning}} | ||
| 160 | |||
| 161 | You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from the improvements listed above. | ||
| 162 | |||
| 163 | {{warning}} | ||
| 164 | Always make sure you compare your //xwiki.cfg// file with the newest version since some configuration parameters were added. Note you should add //xwiki.store.migration=1// so that XWiki will attempt to automatically migrate your current database to the new schema. Make sure you backup your Database before doing anything. | ||
| 165 | {{/warning}} | ||
| 166 | |||
| 167 | {{warning}} | ||
| 168 | Experimental support for CSRF protection is included in this release, although not enabled by default. This mechanism changes the way data is supposed to be saved, a change which will not completely break custom applications in most cases, but which might insert an extra validation step needed for actually saving the data. | ||
| 169 | {{/warning}} | ||
| 170 | |||
| 171 | It is **strongly recommended** to set up a testing/development environment, enable this feature and fully test all the code. In most cases things should work with no additional changes. If the default edit mode is not used, or if the default velocity templates are not used, it should be enough to add the following line: | ||
| 172 | |||
| 173 | {{code language="html"}} | ||
| 174 | <input type="hidden" name="form_token" value="$!{services.csrf.getToken()}" /> | ||
| 175 | {{/code}} | ||
| 176 | |||
| 177 | == API Breakages == | ||
| 178 | |||
| 179 | The following APIs were modified since XWiki Enterprise 2.4: | ||
| 180 | |||
| 181 | {{code language="none"}} | ||
| 182 | [ERROR] org.xwiki.rendering.transformation.MacroTransformationContext: Method 'public org.xwiki.rendering.internal.transformation.MacroTransformation getMacroTransformation()' has been removed | ||
| 183 | [ERROR] org.xwiki.rendering.transformation.MacroTransformationContext: Method 'public void setMacroTransformation(org.xwiki.rendering.internal.transformation.MacroTransformation)' has been removed | ||
| 184 | [ERROR] org.xwiki.rendering.transformation.Transformation: Method 'public void transform(org.xwiki.rendering.block.Block, org.xwiki.rendering.transformation.TransformationContext)' has been added to an interface | ||
| 185 | [ERROR] org.xwiki.rendering.transformation.TransformationManager: Method 'public void performTransformations(org.xwiki.rendering.block.Block, org.xwiki.rendering.transformation.TransformationContext)' has been added to an interface | ||
| 186 | {{/code}} |
