Reference

Description

Inject some content to display instead of the default content of Documentation Pages

Usage

Definition

This Extension Point is contributed by this extension and was added in version 1.7 of that extension.

Category

Page Content

Extension Id

org.xwiki.contrib.documentation.sheet.content

Content to be provided

The UIX content should check the action and depending on whether it's view or edit, provide the script to display what's expected.

Parameters to be provided

There are no parameters.

Example

Example of a UIX displaying xproperties from a DocApp.Code.RenderingMacroClass xclass, to document a Rendering Macro:

{{velocity}}
#set ($macroObject = $doc.getObject('DocApp.Code.RenderingMacroClass'))
#if ($macroObject)
  == Description ==

  $doc.display('description', $macroObject)

  == Usage ==

  $doc.display('usage', $macroObject)

  == Parameters ==

  $doc.display('parameters', $macroObject)

  == Examples ==

  $doc.display('examples', $macroObject)
#end
{{/velocity}}

Results: