Page Titles and Page Names

Last modified by Eleni Cojocariu on 2026/08/11 20:08

The rules below provide guidance on structure and terminology for page names and titles.

Page Title Rules

  • Page Titles should be consistent with the corresponding Page Name, but they may be more explicit where readability requires it.
  • Page Titles must use Title Case: capitalize the main words, not just the first one (e.g. "Edit a Page Using the WYSIWYG Editor", not "Edit a Page using the WYSIWYG Editor"). Small words like "a", "the", "using", "of" are only capitalized if they start the title.
  • All Page Titles and Page Names must be meaningful and understandable out of context, such that readers should be able to understand what a page is about. This is important because pages are often accessed through search results, bookmarks, links, where context is missing. 
  • Page Titles and Names must not include the type of the page ("How to", "Explanation", etc.). These are considered reserved terms, since the page type is already conveyed though the content, structure, badge, context. Including them in titles or names creates redundancy. 
  • When you want to add a disambiguation to a page title, you can do so by adding a qualifying phrase in parentheses `()` It's not necessary to add it to the page name. (For example:
    All the Pages on the Wiki (for Administrators), All the Pages on the Wiki (for Users), Use Colibri ColorTheme Variables (Deprecated)).

Page Name Rules

Any new page created on xwiki.org, as well as any extension page that has been completely refactored into the new location of Documentation pages (where the only remaining content is a link to the extension documentation and the extension is renamed), must follow the rules for naming:

  • Use the naming strategy for kebab-case when naming pages.
  • Until when XWiki.org is upgraded to XWiki 18.1.0+ Remove stop words manually. Do not include common stop words such as "a", "the", "on", "when", "while" etc. See full list of stop words.
  • Page names should follow page titles as closely as possible while still respecting the rules above.
  • Avoid repetition in URL paths.
    • Do not repeat the same word (or variations of it) in both parent and child page names. Instead, rely on the parent path to provide context. For example, ../wiki-editor-toolbar/wiki-editor-toolbar-support repeats "wiki-editor-toolbar", so the correct name is ../wiki-editor-toolbar/support.

Title and Name Style by Documentation Type (by Diataxis)

Not only is Diataxis reflected in the documentation content, but also in page titles and page names:

 How-toTutorialReferenceExplanation
Page titles

Titles must start with a verb (e.g. "Select", "Apply", "Set", etc)

  • Titles must start with a verb.
  • Be more specific, since tutorials are How-to's applied to a concrete example, the title is also more specific.
  • Titles must not start with a verb.
  • The title must clearly indicate that the page covers the topic extensively.
  • Titles must not start with a verb.
  • Use a phrase that represents the subject of the explanation (answering “why”).
Examples"Edit a Page", "Build an Application" (and not "Editing a Page", "Building an Application"). More examples on How-tos for Users."Build a FAQ Application"."All Wiki Pages", "Common Edit Actions", "Realtime Edit Actions". More examples on References for Users."Simple and Advanced User", "Conflict Resolution". More examples on Explanations for Users.

Get Connected