User Guide: XWiki - liquidinvestigations/docs GitHub Wiki
This is one of EIC network's collaborative tools, to organize knowledge. The EIC knowledge base grows stronger with each project. Here is a detailed XWiki User Guide.
Intro
Xwiki deals with Wikis and Pages. A wiki is a collection of wiki pages.
When you start you land on the main wiki (Home).
However it's possible to create other wikis (eg. Subwikis). This can be useful if you wish to have some clean separation between different types of content. You can create as many wikis as you want and as many pages as you want in every wiki.
Usually you start with a single wiki since that's the simplest form of organization, and then when the need outgrows this wiki, you can create other Subwikis.
To create a Subwiki go to the upper right corner and click on the Drawer icon > Wiki Index.
From here you can create a brand new Subwiki.
Home page
On the upper right corner you can set up your user profile, search for pages, get notifications, and also use the Drawer icon to search for page, user and wiki indexes.
Search
Xwiki has a pretty powerful faceted search functionality.
Search Parameters
You can refine and customize the parameters of your search by clicking on 'Facets'. For instance you could only search for images by checking the 'Image' File type.
Search Results
Furthermore you can sort results based on relevance, title, modification date, creator etc. The search results provide a single view of the content's location, the author's last modification date, and the rendered content description.
Furthermore, the left side bar takes you to 'Applications' and 'Navigation' panels.
Applications
- The 'Dashboard' allows you to view pages, tags and your activity stream.
- The 'Help' section, shows you videos, basic features and other details about Xwiki.
Navigation Panel
Located on your left hand, the Navigation Panel allows you to browse through all your wiki pages.
You can also go to the breadcrumb at the top where you can find the position of the current page in the hierarchy.
You can also access directly a certain page if you know the URL.
Create Page
Xwiki allows for Nested Pages (pages with children) and Terminal Pages (without children). Caveat: only admins or advanced users can create Terminal Pages.
On the homepage, go to the 'Create' button on the right upper corner and create your Page.
Use the editor to describe what your page is all about and click Save & View.
Create Nested Pages (children)
To create a child page, go to the parent page and hit the 'Create' button.
Type the name of your child page and hit 'Create'.
The child pages will be grouped under your parent page, and are visible on the left hand side navigation panel.
Page functionalities
At the bottom of each page you will find the following tabs:
- Comments (self explanatory)
- Attachments (files that have been uploaded to the page)
- History (every version of the current page)
- Information (included pages, backlinks)
Attachments
A page can contain attachments which can then later be referenced from within a page. There are several ways to create attachment to a page: from within the Page editor, from the bottom tab called 'Attachments', or for from the upper right corner 'Drawer' icon. Attachments can be moved or deleted.
History
Whenever your make a modification to a page it is stored in that page's version history. You can compare any 2 versions of a page to see what has been changed between them. You can easily rollback to a previous version of a page if a recent modifications appears to be wrong.
Delete a page
To delete a page, go to the upper right corner, click on "More actions" menu and select 'Delete'.
You can choose if you want to delete also the children pages by checking the 'Affect children' box.
Export a page
To export a single wiki page or a set of wiki pages into several formats, go to the upper right corner, click on "Export" in the "More actions" menu.
Select the format of your choice and all the pages to be exported and click on the 'Export' button.
Annotate a page
You can annotate a page by going to the upper right corner, click on "Annotate" in the "More actions" menu.
Select the text you want to annotate and follow the instructions (eg. Command + M) and click the 'Add Annotation' button. Your annotation will appear as a comment at the bottom of the page.
Copy a page
Use the More actions menu and select the page you want to copy.
And move it to the location of your choice, by clicking on the directory icon.
In addition you can use the Rename and Move page functionalities, by accessing the same More actions menu.
Users
User Management and Access Rights are set by the Administrators. For more information please access the User Management Guide and Access Rights Guide.
Back to our detailed User Guide.