Document Information Panel
Add settings or information to the document information panel used in edit mode
Usage
The content of the document information panel displayed in Wiki and WYSIWYG edit mode is completely based on extensions of this extension point. This can be used to both display additional information/links as well as additional settings, as shown in the following screenshot with the activation status of heading numbering where the area of the extension point as well as the individual extensions are highlighted with red boxes:
Definition
This Extension Point is contributed by this extension and was added in version 14.0-rc-1 of that extension.
- Category
- Panel
- Extension Id
- org.xwiki.platform.panels.documentInformation
- Content to be provided
At least one <dt>-element and as many <dd>-elements as desired such that its content can be used as part of a definition list in the vertical form layout. Note that this means that the HTML macro with the clean parameter set to false must be used.
- Parameters to be provided
- order: The order in which the item will be displayed. The content provided by XWiki Standard has orders 100 (default locale), 200 (syntax), 300 (hidden status) and 1000 (included pages).
Example
The following shows how a UI for activating heading numbering can be displayed. The activation status is stored in the property of an XObject which is created on-the-fly if it doesn't exist yet:
{{velocity}}
{{html clean="false"}}
<dt><label for="NumberedHeadings.Code.NumberedHeadingsClass_0_status">$escapetool.xml($services.localization.render('numbered.headings.activationUI.label'))</label></dt>
<dd>
#createObjectAndPropertyIfMissing('NumberedHeadings.Code.NumberedHeadingsClass.status')
#displayObjectProperty('NumberedHeadings.Code.NumberedHeadingsClass.status' 'edit')
<input name="objectPolicy" type="hidden" value="updateOrCreate" />
</dd>
{{/html}}
{{/velocity}}
Additionally, the parameter order=500 is set.
