Link Documentation Page to its Extension

Each documentation page must document one specific extension. The page must therefore be associated with the Technical ID of the extension it documents.

The Technical ID identifies the exact extension to which the documentation belongs. For XWiki extensions, this is the extension ID. For NPM packages, this is the NPM package name. 

This association is important because the documentation is considered part of the extension it documents. For example, if an extension is removed, its documentation could easily be also removed with it.

When creating a documentation page, you must fill in the "Technical ID" field within the documentation page structure of XWiki.org, if the page has a "Technical ID" associated. In cases where no "Technical ID" is linked (for example, installation pages), you do not need to fill in this field. Filling this links each documentation page on the main wiki to the extension it comes from, or to the NPM package it comes from.

Fill In the ExtensionId to the Page

1. Go to the extension page that provides the feature documented in your page.
2. Locate the Id metadata, which is stored in the xobject of type ExtensionCode Class.
3. Access and copy the ID using the Object Editor, as illustrated below:

   

   • If the extension page does not exist on Extensions, it needs to be imported. Make sure to handle the extension page properly and add the "Documentation" button as described.
   • If the page exists but the Id field is not filled in, it needs to be completed.
     • The Extension id follows the format <groupId>:<artifactId>, where the artifactId corresponds to the extension name (e.g., org.xwiki.platform:xwiki-platform-icon-api).

Fill In the NPM Package

1. Go to npmjs.com.
2. Search for the XWiki package you are looking for.