Panels Application

The XWiki Panels Applications allows creating menus for performing various actions in the wiki(s): search a space or the wiki, create a page, display the wiki statistics, navigation and so on.

XWiki provides a default set of panels grouped in 5 main categories: 

  • Information - some panels for the Statistics Application, the "Blog Categories", the "Applications" panel, the "Quick Links" panel etc.
  • Navigation - "Blog Archive", "Recent Blog Posts", "Recently Visited Documents"
  • Tools - the "Search" panel, the "New Page" panel 
  • Administration
  • Other

Also there are 2 possible context actions for panels: view or edit. 

In order to create and edit panels or to change the panels layout, you need to have administration rights.

Access The Panels Home Page

To access the Panels Application home page, click the DrawerMenuIcon.png icon which launches the drawer menu, then on "Application Index" in order to access the list of installed applications and finally on "Panels".

ApplicationIndexDrawer.pngPanelsAppIndex.png

The new and improved Panels home page displays a livetable with the available panels that can filter panels by name, description, type (edit or view) and category (Information, Navigation, Tools, Administration and Other). Provided you have administration rights, you will also be able to edit or delete panels.

PanelsHomePage.png

Create a Panel

To create a panel, go to the Panels home page, fill in the name of your new panel and then click on "Create".

CreateNewPanel.png

A new page will open in "Inline Form" mode so that you can continue the panel creation by filling in the corresponding fields.

CreateNewPanelEditMode.png

Finalize the process by saving the page.

ViewPanelAfterCreation.png

Panel Wizard

The Panel Wizard provides a dedicated UI for an easier customization of the panels layout and it is available globally, in the wiki administration page and locally, on the space administration pages. 

To access the global Panel Wizard, go to the Panels home page and locate the "Available Panels" section. Finally, click the "Panel Wizard" link in information message with a magic wand icon.

PanelWizardHomepage.png

Another way is to click the DrawerMenuIcon.png button which opens the drawer menu, then on "Administer Wiki".

AdministerWikiMenu

In the wiki preferences page, click on the "Panel Wizard" link from the vertical menu to the left,

PanelWizardIcon.png

select the Panel you wish to use from the "Panel List" tab,

PanelWizardList.png

drag the panel from the "Panel List",

PanelWizardListDrag.png

and drop it into the panels area (left or right).

PanelWizardListDrop.png

Don't forget to scroll to the bottom of the page and click on "Save the new layout" after you are done.

SavePanelsLayout.png

If you now go to any wiki page you will be able to see the panel in the same area you dropped it in.

PanelAfterSave.png

To remove a panel from the left or right column without deleting it, just follow the reverse process: drag the panel from the column and drop it to the "Panel List", then click on "Save the new layout".

Change the Panels Visibility

By default, the panels you drag & drop with the Panel Wizard from the wiki administration are displayed on all the wiki pages. 

Display a Panel for a Nested Page and its Children

In case you want to display a panel only on a specific nested page and its children, you will have to access its Panel Wizard. To do so, click the cog button, then on "Administer Page".

PageMenuNonTerminal.png

Next, click on the "Panel Wizard" link from the vertical menu to the left and follow the steps described in the previous section.

PanelWizardSpaceAdmin.png

Display a Panel on a Single Page

In order to display a panel only on a specific page, you have 2 possibilities. In case you don't need to further customize the look & feel of the panel, i.e. use the default skin and color theme, you can use the {{panel /}} macro as follows:

{{panel title="My Panel"}}
Content of the panel.
{{/panel}}

You can place any XWiki content in the content of the panel. Also, the title parameter is optional.

If in return you want to use a custom CSS, one solution would be to use the panelheader and panelfooter Velocity macros, then to define CSS rules for the .panel class as shown in the "Skins Extensions" tutorial.

Example:

{{velocity}}
#panelheader('My panel')
Some panel content
#panelfooter()
{{/velocity}}

Other available Velocity macros which are distributed with a standard XWiki Enterprise instance are:

  • #largepanelheader($title)
  • #hiddenpanelheader($title)
  • #largepanelfooter()
  • #hiddenpanelfooter()

Customize the Panels Layout

By default, only the right panel column is displayed in the wiki pages. In order to customize the page layout, you can use either the Panel Wizard or the "Page Elements" section from the wiki or the nested page administration page.

Modify the Panels Layout using the "Panel Wizard"

To set the panels layout for the whole wiki, click the DrawerMenuIcon.png button to open the drawer menu, then on "Administer Wiki".

AdministerWikiMenu.png

In the wiki preferences page, click on the "Panel Wizard" link from the vertical menu.

PanelWizardIcon.png

Next, click on the "Page Layout" tab, select one of the different layouts and you will be able to preview the new page layout instantly. Provided you decide to keep the changes, click on "Save the new layout".

PageLayoutBothColumns.png

To set the panels layout for a nested page, click the cog icon, then on "Administer Page".

PageMenuNonTerminal.png

In the preferences page, click on the "Panel Wizard" link from the vertical menu to the left and follow the steps described in the above paragraphs.

Modify the Panels Layout from the "Page Elements" Section

Click the DrawerMenuIcon.png button to open the drawer menu, then click on "Administer Wiki". In the preferences page, click on the link "Page Elements" from the vertical menu to the left.

PageElementsAdminSection.png

If you take a look at the "Panels" section you will notice that by default only the right column is displayed. Also, any panel you drag & drop from the "Panel Wizard" will be listed in the "Panels Displayed on the Left/Right" text-boxes. In case you already know the name of the panels you wish to be displayed and you don't want to use the Panel Wizard, you may specify them here in a coma-separated list, as you can see in the image below.

PageElementsPanelsSection.png

Additionally, you can choose the width of each panel column - the available options are small, medium (default) and large.

PanelColumnWidth.png

After you made your changes, don't forget to scroll to the bottom of the page and click on the "Save" button.

You can control whether to display or not the "Annotations", "Comments", "History", "Attachments" and "Information" sections by enabling or disabling the corresponding drop-down menus in the "Page Metadata Visibility" section.

DocumentMetadata.png

Delete a Panel

To delete a panel you have 2 possibilities. You can either locate it in the Panel Wizard, then click on "Delete"

DeletePanelFromWizard.png

or you can navigate to the panels home page, search for the panel in the livetable, then click the corresponding "Delete" link.

DeletePanel.png

"Applications" Panel

The "Applications" panel is a special panel displayed on the left column which lists the extensions installed on the wiki and dedicated buttons for easy access. Wiki administrators can choose which applications to display as explained in the dedicated documentation page.

New Panels

Nested Pages Panels

Given that starting with version XWiki has adopted the "Nested Pages" paradigm, there have been 2 main changes in the Panels application:

  • the "Navigation" panel displays nested pages and since version 8.2 it has been moved to the left column
  • the "SpaceDocs Panel" has been deprecated and replaced by 2 new panels:
    • the "Sibling Pages" panel displays the siblings of a terminal page
    • the "Child Pages" panel displays the children of a nested page
NavigationPanel.pngSiblingsPanel.pngChildrenPanel.png

Tips Panel

The "Tips" panel is part of the Help Application and displays useful tips and tricks about how to use XWiki.

TipsPanel.pngTipsPanel2.pngTipsPanel3.png

"Need Help" Panel

The "Need Help?" panel was added to the column on the right and comes with dedicated links in order to get community and professional support.

        

Search this space