Getting Started

Last modified by Lucas Charpentier (Sereza7) on 2024/11/28

Welcome to the XWiki "Get Started" page. This guide provides basic information on how to set up and use XWiki. Start by learning more about wikis.

XWiki's use cases are diverse: collaborative intranet, knowledge base, CMS, competitive intelligence, public debate, collaborative creation of school courses, website creation, etc. Read more on what wikis can be used for, what makes XWiki special and a second generation wiki.

You can visit the references page to see a list of varied projects based on XWiki. A short form on this page allows to share your own XWiki project. You can also go to the XWiki project homepage to see some of the companies that use XWiki or check out the testimonials page to view what our users have to say.

Basic information

The first thing you want to do is download and install XWiki. For first time XWiki users and users who wish to quickly try out XWiki, we recommend installing the standalone distribution. If you're not looking to install XWiki from scratch, you can also try it directly online.

Then, as you log in to your wiki, the first thing you see is the wiki homepage.

  1. XWiki is divided into Wikis and Pages. Inside a wiki, you can create a hierarchy of pages, by creating pages inside other pages. This feature is called Nested Pages. From this area, you can add new pages by clicking the "Create" button.
  2. Whenever you want to modify a page, click on the "Edit" button, make your changes and save the page. The modified page now replaces the previous version. Each version of the page is stored in the page history and can be reverted to, if needed. More page actions, such as Administer, Copy, Rename, Delete, Export, are also available from the last menu on the right.
  3. From the upper right corner, you may move to your profile, open the notifications menu and search through your wiki.
  4. By expanding the drawer menu on the right, you can access your profile, logout or go to the wiki administration. You can also access the wiki, application, page and user indexes.
  5. You can edit the title and content of the homepage to replace it with your own.
  6. On both sides of the pages are panels. A panel is a widget you can see on the left or right columns of every page of your wiki. By default, you will see "Applications" and "Navigation" panels on the left and "Tips", "My Recent Modifications" and "Need help?" on the right.
  7. The area with tabs at the bottom of the page contains by default comments, attachments, page history and page information.

GettingStarted.png

The complete list of features will show you all the things you can do with your XWiki instance. You can also get started with the  First Steps guide or skip directly to more advanced topics.

If you need more help with your wiki or you'd like to get in touch with the community please visit the support page. There you'll find more information on:

 

Get Connected