Documentation Wiki

Last modified by chaney08 on 2021/07/20 19:21

Introduction

The Wiki service of the Collaboratory hosts the main interface to access all the other Collaboratory services. As such, it embodies the full concept of collab workspaces and most users consider it to be the collab service. The Wiki in itself offers a handy way of documenting a user's work with a simple wiki user interface.

Wiki pages are a convenient way of publishing content on the web, either addressing the Team of the collab or making the content completely public, that is, also accessible to visitors who do not have an EBRAINS account.

Users access the Collaboratory Wiki service at https://wiki.ebrains.eu. From the Collab menu option at the top of the page, users can search for existing collabs and create a new collab. When creating a new collab, the wiki home page of the collab is created automatically. Users can then edit this page and add sub-pages. The wiki-page hierarchy appears in the navigation elements in the left margin.

Wiki page edition can be done graphically in a WYSIWYG editor or in source mode. More advanced users can use the XWiki macros which can be inserted when in edit mode by clicking the cog icon in the formatting toolbox at the top of the page, as shown in the figure below:

1624383642729-795.png

New wiki sub-pages offer more diversity: plain blank wiki pages, article pages with an automatic table of content in the right margin, or 3rd party content including an external web page (iframe) embedded in the collab or a community app (an external service designed to be displayed in the Wiki).

Users curious about how a wiki page was written can view the source for it from the kebab menu (upper right). This can be useful at times when the graphical editor does not behave as expected, or to copy a page design to use as a template elsewhere.

Users can run a search on all the wiki pages they have access to from the search widget at the Wiki homepage (https://wiki.ebrains.eu) or from the magnifying-glass icon at the top of this page. This will find words in the page names and in their content, with advanced filters available from the first result page.