Handle Extensions.XWiki.org Pages

Last modified by Eleni Cojocariu on 2026/06/17 15:41

There are two situations in which you may need to update the content of an extension page:

  1. You have published a new extension
  2. You are migrating existing documentation

You Have Published a New Extension

If you published the extension on extensions.xwiki.org, make sure that:

You are Migrating Existing Documentation

If you are migrating and refactoring documentation and need to remove content from the extension page after it has been converted, make sure that:

Include the "Documentation" Button

Before the migration and refactoring of documentation process, documentation was written directly on the extension page in the "Description" section. Now, extension pages must contain only technical information (dependencies, prerequisites, etc.), along with a "Documentation" button that links to a dynamically generated page listing all documentation pages related to that extension. 

Example of a generated documentation page:
documentation-page-extension.png

The link will be available on the extension page as a "Documentation" button:
documentation-button.png

To create the link that generates the page, in the right place:

  1. Edit the documentation page from "Extensions" with the Object editor.
  2. Expand the "Objects of type ExtensionCode.ExtensionClass" using the dropdown:

    expand-object.png

  3. Find the Website field and complete it as it follows:
    • put the base link https://www.xwiki.org/xwiki/bin/view/DocApp/Code/ExtensionLD
    • add query parameters:
      • the id of the extension page, which is found in the page's id field:

        id-field.png

      • the name which will be the name displayed in the dynamically generated page.
  4. The result link will have the format:
    https://www.xwiki.org/xwiki/bin/view/DocApp/Code/ExtensionLD?id=<page id>&name=%22<page name>%22.

    For example:

    website-field.png

Check how it is done for the Like Application page.

Get Connected