Documentation Resources

To make contributing easier, we provide a preconfigured environment that you can import into your XWiki instance. Since screenshots should convey real examples/usages, it’s important that contributors use the same environment to capture screenshots that illustrate practical examples.

Realistic content helps readers understand the documentation. The content is fictive but resembles real scenarios.

To get started:

1. Download the XAR files below.
   • UserProfiles.xar.
   • MainWiki.xar.
     Additionally, you can also import the ProjectsWiki.xar.
2. Import them into your wiki. Before importing the ProjectsWiki.xar, create a wiki named Projects, then import the XAR into that wiki.

Once imported, you can log in as any of the predefined users to explore the environment and take screenshots. For simplicity, each user’s password is the lowercase version of the username (for example, for account with username JohnSmith the password is johnsmith).

The environment includes:

• Three users:
  • John Smith: member of the "AdminGroup",  useful for illustrating administrative features,
  • Ana Smith, 
  • Alex Johnson.
• A main wiki. The XAR for the main wiki contains realistic wiki pages with attachments, translations, linked objects, comments, and multiple revisions.
• Pages for another wiki, if needed, called "Projects". This XAR contains realistic wiki pages with attachments, comments, and multiple revisions. It is less complex than the main wiki.