Skip to end of metadata
Go to start of metadata

Here you'll find all the information you'll need to handle the interface of the wiki. For more information on specific features, have a look at the Tips & Tricks page. If this is your first time on this wiki, you might want to start with the First steps.

You can click on the small pictures on the right of the text to enlarge them and see the points referred to in bold.

This page contains the following topics:

1. Navigation

The left-hand side of the wiki, also called Navigation pane, is a mirror of the structure of the wiki. Every page you create in the hierarchy will show up here.

This is only true if you use the documentation theme for the layout of the space.

  • The space-specific links (1.) which are defined in the Navigation page (c.f. First steps#3. Creating your Navigation menu)
  • The Page Operations (2.) which contains the following functionalities:
    • Edit the current page (2.a.), see #2. Editing/Creating pages, also accessible using the shortcut ctrl + e !
    • Several uploading tools (2.b.)
    • View (2.c.) returns to the page itself after you've been visiting "special" pages (e.g. Attachments)
  • The Add Content (3.) which allows you to create new pages (and Blog Posts as well)
  • The "Advanced" section (4.) in which you can administrate your space using:

2. Creating pages

In the wiki, as in any other web-site, pages are organized in a hierarchical parent-children manner (called tree). Every Space has a single root (i.e. the parent of all the other pages: Home), you then have the possibility to create as many Children as you want to it (i.e. the leaves of the tree !). In First steps, you created several including Projects and Navigation. Each page can itself be the parent of as many Children page as you want.

Consequently, each time you will be creating a new page, it will be a children of your current page. This means that it does matter, which page you are reading when creating a new page.

However, you can always change the position of any page as described in #6. Organizing the Personal Space. Moreover, when you create links between several pages, you only use its name, meaning you do not need to know its particular location in the tree of your Personal Space.

3. Editing pages

Working with the wiki boils down to writing some text as you would do in a normal Word like editor, with the advantage of being able to create various Pages (i.e. documents), which you can link and organize. Moreover, drafts of your ongoing work is saved automatically every few minutes, you can search throughout the entire wiki in a few clicks and you can share your work easily.

Both Editing and Creating pages lead to the same editor which is composed of five parts:

  • The title of your page (1.), which is also the name of the page (this will be useful when creating links between pages)
  • The editor in itself (2. and 3.), which works just like a text editor. The edit bar (2.) can be used to format the text, which is written in the main editor window (3.).
  • The bottom bar (4.) can be used to change the page's attributes:
    • Restrictions: restrict pages from here on in the hierarchy to a subset of the users who are already allowed to see the page
    • Labels: you can define arbitrary labels for each page, several of them even, to organize your wiki in addition to the inherent hierarchical structure
    • Attachments: also from here you can manage your attachments to this page
    • Comment on what you changed, and notify watchers checkbox: if you change a page, all watchers will be notified, unless you uncheck this box (useful for minor changes). You can also comment on what you changed and why, if you like
    • Preview mode: see how your page looks like
    • Save or cancel your edits. Drafts are automatically created by the system.

On the top of the page you see

A. Breadcrumbs - where are you in the hierarchy
B. Browse.. menu to access pages directly and your name menu to access your profile
C. The search box to search confluence for keywords 

 

 

The Insert Image button opens a window containing:

  • A selection of the "origin" of your image (1.)
  • A list of the available images (2.), with thumbnails ! However, this pop-up is not able to list images that are attached to another page
  • The possibility to Upload (3.) a new image
  • The Thumbnail option (4.) which produces fancy "pop-up-ish" images as in this page

 

The Insert Macro button allows you to choose among the many useful functionalities provided by the wiki (or developed by SystemsX directly) by:

  • Filtering by macro "type" (1.)
  • Filtering using a keyword (2.), or part of it
  • Scrolling through the proposed macros (3.) which you select by clicking on it and filling the corresponding pop-up

You have the complete list of available macros, with details on their usage, in the - Macro reference page.

4. Uploading data

The wiki provides you with three way for uploading data (2.b.). You can :

  • Attach separated files to the current page (using Attachments and the provided Upload button)
  • Upload several files at once, by zipping them into a .zip file and uploading them using the Zip Upload. The .zip file will be automatically opened and each file attached to the current page
  • Use an Office file to produce a new wiki page by using the Doc Import

It is a good practice to attach all your files to the Attachments page so that you do not have documents lying around in random pages (see the - Wiki guidelines#2. Attachments on this topic).

5. Searching the Wiki

The wiki includes a Search field (at the top right corner of each page) which will parse the whole wiki for your keywords. This powerful functionality has a slightly particular syntax to allow you performing refined searches:

  • "": exact match of the word/sentence in between ""
  • AND: looks for multiple words in the same page
  • OR: looks for any of the words
  • NOT: looks for pages not containing the word
  • (): group words to create more complex syntax (e.g. (gene AND codon) OR (NOT allele))
  • *: performs a partial match (e.g. gen* will match with gene and genome and generation and so on). (warning) the word you are searching for cannot start by * (warning)
  • ?: single character partial match (e.g. c?t matches cat and cut and so on)
  • ~: "Fuzzy" search, try to compensate for your typos (e.g. gane~ matches gene)

You can obviously combine all these elements together to create arbitrarily complex searches as in the Confluence search documentation : o?tag* AND past~ AND ("blog" AND "post").

6. Using Templates

Event though editing pages is highly fun, you might want to use Templates as they allow you, when creating a new page, to "paste" its content into the empty page. Given that there are common Templates in the lab (see - Wiki guidelines#1. Projects and - Templates), you may want to create these Templates in your own space, to avoid copy-pasting them every time.

Creating a new Template is done by clicking on Browse Space (1.), Advanced (2.) and Templates (3.). You can then Add New Space Template to open a Wiki Markup editor with the Name (4.), a Description (5.) and the text (6.) of the Template. After saving it (7.) you will have the possibility to reuse it when creating a new page.

7. Organizing the Personal Space

Organization of the different pages of your space is very important as, in addition to direct link, each page has a Parent page and Children pages. In addition, the order of the Children pages influences some macros (e.g. children) as well as the order of the links in your Navigation pane.

This organization can be changed in an intuitive drag-and-drop manner by clicking first on Browse Space (1.) and Pages (2.). This page displays a dynamic tree-like organization of your Personal Space which you can "explore" by using the tiny +/- signs (3.) to show/hide the children of each page. You can then move a page to a different location by dragging it (4.).

Each "page" being a link to the corresponding page, make sure you hold your click while dragging it otherwise you will open it

8. Using Tasklists

Tasklists are very powerful (but simple) organization tools. You can either create them using the Insert menu in the Rich Text editor or using the following macro:

{tasklist:List name}
{tasklist}

It's usage is as trivial as it looks:

  1. Write in your new task/to-do/idea/suggestion/... (1.)
  2. Add it to the list (2.)
  3. Check the Done box (3.) when.. you're done !
  4. You can move them up and down (or even to another Tasklist) using the square-ish button (4.)

9. Using the Blog

The Wiki offers a personal Blog which functionality can be very useful to create your own Diary. The advantage of this technique being that each Blog Post you create (in Add Content) is a totally normal page with the same functionalites/interface/editor that stores in addition the date and time of its creation !

10. Now what ?

Congratulation ! You now have all the tools in hand to work efficiently with the wiki ! However, before diving into science, read the - Wiki guidelines as there are few rules which need to be followed in order for the lab to work in a coherent (thus more efficient) manner.

Refer to the - Tips & Tricks page for more advanced usage of the wiki, and do not hesitate to contribute to it if you find a good/easy/better functionality/solution/macro !

  • No labels