What's New Application

Last modified by Admin on 2023/11/27 14:50

cogProvide information about what's new in XWiki
TypeXAR
CategoryApplication
Developed by

XWiki Development Team

Rating
0 Votes
LicenseGNU Lesser General Public License 2.1
Bundled With

XWiki Standard

Compatibility

XWiki 15.2RC1

Installable with the Extension Manager

Description

Displays news about XWiki and its ecosystem, directly into your XWiki instance. The UI is using the What's New API to gather the news.

FAQ

Does it show info only about installed extensions?

Right now, the news items shown do not depend on the version of XWiki installed, nor on the installed extensions and their versions. 

Note that the underlying API currently supports returning news only for a given version of XWiki but it's not used yet.

The API also supports returning certain categories of news (Admin User, Simple User, Advanced User, Extensions) but for the moment the news for all categories are returned. 

From whatsnew.vm:

## TODO: For now, show all categories until we implement support for either Admin UI selection of categories
## or we decide to automatically show categories based on whether the current user is a simple or advanced user,
## and whether he/she has Admin rights on the wiki.
#set ($newsSource = $newsSource.forCategories("simple_user, advanced_user, admin_user, extension"))

Is it limited (as an upper limit) to the XWiki instance version it runs on?

Not at the moment, the see the FAQ answer above.

Is it limited (lower limit) to the version of the running instance before the latest installed update?

Not at the moment, the see the FAQ answer above.

Is it only showing the new features of the instance versions as opposed to the previous one?

Not at the moment, the see the FAQ answer above.

What is its target audience?

At the moment all news are returned but categories of audience are already implemented. See XWIKI-21470.

Using

To use it, go to the Drawer Menu and select "What's New" as in:

whatsnew-drawer.png

This will display the news:

whatsnew-display.png

Configuring

See API configuration.

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Dependencies

Dependencies for this extension (org.xwiki.platform:xwiki-platform-whatsnew-ui 15.10):

Tags:
    

Get Connected