Skip navigation

Using Project Wiki Space - Captains

This page provides the following instructions:

What's a Project Wiki Space?

As Project Captain, you get a dedicated wiki space for your project. A wiki space can have one or more content pages.

Wiki means that your project content is completely editable by anyone from your project team, or anyone else to whom you give editing permission.

Initial Contents

When you start your project, your wiki space initially includes the following pages, which are placeholders for you to add your project information:

Page Function Initial Contents Naming Convention
Project Homepage Provides basic information about your project, and links to more detailed information and downloads. An overview of the project, basic info such as current version and contributors (which you need to fill in), a site map of the wiki space, and a place to add details about features and capabilities. The page name must be the same as your project name, as listed in the Projects List.
Project Documentation Provides information on how to use the software you are developing. Empty sections for installation instructions, usage instructions, examples, and screenshots. Always named Project Documentation.
Do not change the name.
Project Downloads Provides downloadable files related to your project, primarily source and binaries. Empty download lists for source code and binaries; instructions on uploading and linking to files; a place for links to API documentation (if you have it). Always named Project Downloads.
Do not change the name.

So What Do I Need to Add?

We have already filled in some of the information in your project homepage, but there is some missing information, marked by the following symbols:

Missing information which you must fill in, first thing, for your project to be moved to the Active Projects tab on the Projects page. You can leave these out only if they aren't relevant (for example, installation instructions are irrelevant if you don't supply any binaries).
Missing information which you're encouraged to fill in.

Next to these symbols, we've added instructions for you. Once you've added the relevant info, or decided you won't add the relevant info, be sure to remove these instructions as they might confuse your Space Cadets and users.

A reference that is always available to you is the Project Wiki Space Example. So once you finished setting up your project homepage, you can delete all admin comments, leaving only the headlines, tables, and the Under Construction boxes. Once you wish to add documentation and downloads, you can check out the reference space for instructions.

Feel free to add any other information about your project. You can also add more pages to your space, either as sub-pages of Downloads or Documentation, or in addition to these pages.

Linking to Your Space Cadets' User Names

The information table at the top of your homepage has a row labeled Contributors. In this row, add links to the usernames of your Space Cadets (project contributors):

  1. Click the Edit link on the homepage – the link appears under the page title, when you are logged in and viewing your project wiki space.
  2. Select the Wiki Markup tab to edit in Wiki Markup mode (editing modes are explained in more detail below).
  3. Using your browser's find option, search for the word contributors| (including the pipe symbol).
  4. To the right of the | symbol, you will see a link to your own user name, with the following syntax:

    Add the rest of the members using the same syntax, substituting their usernames after the ~. Use commas to separate the links, like this:

    [~contributor1], [~contributor2], [~contributor3]
  5. Click Save.

What You Can Do on the Project Wiki Space

Adding Pages

You're welcome to add more pages to your project wiki space as you go along, using the Add Page link (you can find this link under the page title, when you are logged in and viewing your project wiki space).

When you add a page, be sure to select the Location at the top of the Edit screen. This specifies where the page appears in your project's content tree. For example, if you add a new page with Location = Project Documentation, this page will appear under the Project Documentation page in the tree. This is reflected in the Project Site Map and in the breadcrumbs at the top of the page.

If you add more pages to your documentation, make sure you add links to them (see instructions) from the relevant pages in your project wiki. New pages will also automatically appear in the site map on your homepage.

Editing Pages

Click the Edit link on an existing page to change the content of that page (you can find this link under the page title, when you are logged in and viewing your project wiki space). A web-based editor opens, which allows you to edit either in Rich Text mode (WYSISYG) or in Wiki Markup mode (similar to the notation of messages on forums).

If you're new to wikis, you might want to start with Rich Text mode (see instructions), but if you want to do more advanced stuff, you're need to use Wiki Markup (see the Help Tips at the right of the Edit screen or the wiki markup notation guide).

Be aware that editing in Rich Text mode might disrupt the layout of pages, add redundant line spaces, and have other annoying results. None of this is irreversible – you can always edit in Wiki Markup mode and fix the layout problems in the code.

Erasing and Renaming Pages

  • To erase a page, visit it, then from the top menu bar, select Admin > This Page > Remove Page.
  • To rename a page, edit it, change the page title at the top of the Edit screen, and save the page.
Please don't:
  • Rename the homepage, the downloads page or the documentation page. This will break the links in the project navigation bar and elsewhere.
  • Delete the homepage, downloads page or documentation page. If you really need to remove one of these pages, contact the OpenSpaces Admin and get permission.

Watching Pages – Getting Notified About Changes

You can watch a page or your entire wiki space – this means you will get email notifications whenever the content changes. The notifications contain the actual contents of the page, and provide a link back to the original page.

  • To watch a specific page, visit the page, and click the mail Watch Page link (visible under the title when you are logged in).
  • To stop watching a page, click the mail Watch Page link again (it's a toggle).
  • To watch your entire space (which means you get notified about any change on any page related to your project), on the top menu bar, select Admin > Advanced > Space Adv. Config., then in the left toolbar, click Start watching this space.

Changing Viewing and Editing Permissions for a Specific Page

To restrict viewing or editing on a specific page, simply edit it and click the Restrictions button at the bottom of the Edit screen. You can define who will be permitted to view and who will be permitted to edit the page from now on.

Changing Editing Permissions for Entire Project Wiki Space

As Project Captain you can define who can do what in your project wiki space. Permissions are quite granular and include the ability to edit/create pages, restrict pages, add attachments to pages, etc.

To edit permissions for your space:

  1. Visit any page in your project wiki space.
  2. From the top menu bar, select Admin > Advanced > Space administration.
  3. In the toolbar on the left, click Permissions.
  4. Edit permissions for users or groups.
    Be careful when editing permissions for Anonymous Users – this refers to anyone who accesses the site, even non-registered users.

Other Administration Features

For more space administration options, see the Confluence Administrators Guide. Here's how to access the screens referred to in this guide:

  • Space Administration – from the top menu bar, select Admin > Advanced > Space administration
  • Advanced Space Configuration – from the top menu bar, select Admin > Advanced > Adv. Space Config.

Other Topics in Captain Guide

Adaptavist Theme Builder Powered by Atlassian Confluence