Choose the Right Location for a Page
Last modified by Eleni Cojocariu on 2026/04/28 16:18
All documentation must be located as children pages of the documentation page.
The location of a documentation page is determined as follows:
- First, check whether the Extension is bundled in XS or not:
- Every documentation page must be associated with an Extension and be located accordingly, either under XWiki Standard, or under Extensions. The association with the specific extension is done by setting the extensionId.
- Bundled Extensions: place the page under documentation.xs.
- Non-bundled Extensions: place the page under documentation.extensions.
- Every documentation page must be associated with an Extension and be located accordingly, either under XWiki Standard, or under Extensions. The association with the specific extension is done by setting the extensionId.
- Then, choose the appropriate target audience:
- user (e.g., under User Documentation),
- admin (e.g., under Administrator Documentation),
- developer (e.g., under Developer Documentation).
- Finally, place the page under the most relevant existing topic or subtopic in the navigation structure.
- Topics and subtopics correspond to major XWiki features. In the documentation structure, there are "topic top-level" pages (e.g., User, or Like) that are listed first in the navigation. These pages serve as main entry points for specific topics. Below these top-level pages, you’ll find child pages that expand upon the topic. Place new pages under an existing topic if they cover the same subject. If the page doesn’t fit any existing topic or subtopic, create a new top-level page.
- Pay attention to the page name strategy.
- Nest documentation pages where it makes sense. For example, if one feature or action logically leads to another, or if a page describes options or consequences of another page, it should be placed as a child under that main page.