Document Docextra

Last modified by Eleni Cojocariu on 2026/05/05 15:20

Adds a new tab at the bottom of the page which can be opened

Usage

Warning

Doc page being refactored at Page extra area UIXP.

The extension point uses the parameters to create a new tab title on the bottom of the page, the extensions content is loaded only when the tab is opened.

docextra-uix.png

Definition

This Extension Point is contributed by this extension and was added in version 13.6-rc-1 of that extension.

Category
Page Layout
Extension Id
org.xwiki.plaftorm.template.docextra
Content to be provided

The code displayed in the docextra tab when it's activated.

Parameters to be provided
  • show: boolean value, if set to false or missing the docextra won't be displayed.
  • title: string value, this is the title displayed on top of the tab.
  • itemnumber: integer value, a number displayed next to the title, if the value is set to -1 it's not displayed.
  • name: string value, a short unique name without space or special characters, used for the shortcut
  • shortcut: string value, a key combination to use to display this docextra (e.g. alt+k)
  • order: integer value, the parameter used to sort the docextra to display them

Get Connected