Favorites Application
 | Application to manage a panel or menu with a list of Favorite pages. |
| Type | XAR |
| Category | Application |
| Developed by | Ludovic Dubost, XWiki SAS, Alex Cotiugă, Anca Luca |
| Active Installs | 16 |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
| Compatibility | Tested with XWiki 10, XWiki 11 and XWiki 12. Minimum version 10.6.1. |
Table of contents
Description
Application to manage a panel or menu with a list of Favorite pages.
This application allows to show a list of favorite pages from the Wiki in a Panel or in an XWiki Menu.
Favorites can be easily managed using the "Manage Favorites" action and choosing the pages to display:
For new users a default favorites setting is available in the Favorites home page:
Multiwiki usage
Starting with version 1.2, a farm usage was added in the usecases of this application.
In order to use the favorites list in a multiwiki environment, the application needs to be installed on all wikis on which user profiles are stored, but can be installed on other wikis as well.
For example, if on your farm all subwikis have global users (users only stored on the main wiki), then the favorites application can be installed only on the main wiki, and used on the subwikis by including the favorites panel by its complete reference in the list of panels on the subwiki:
This will allow the users to add pages in their favorites list by navigating on the subwiki in question and clicking the "Add current page" button from the favorites panel.
If installed on an XWiki version more recent than 12.2-rc-1 , an entry in the user profile menu will also provide access to the favorites list.
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:
- Log in the wiki with a user having Administration rights
- Go to the Administration page and select the Import category
- Follow the on-screen instructions to upload the downloaded XAR
- Click on the uploaded XAR and follow the instructions
- You'll also need to install all dependent Extensions that are not already installed in your wiki
To activate the panel, you just need to add Favorites.Code.FavoritesPanel in the list of panels from the administration:
To activate the menu, you need to use the {{display}} macro in your Menu page with reference Favorites.Code.FavoritesMenu. A white space is needed before and after the display macro.
Release Notes
v1.2.5
v1.2.4
The following translation have been updated with this release:
v1.2.3
The following translation have been updated with this release:
v1.2.2
The following translation have been updated with this release:
v1.2.1
The following translation have been updated with this release:
v1.2
v1.1
v1.0
Initial version of the Favorites Application
