Skip navigation

Using Project Wiki Space - Space Cadets

What's a Project Wiki Space?

Each OpenSpaces.org project gets its own dedicated wiki space. 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.

Initial Contents

When you start your project, your wiki space initially includes the following pages, which are placeholders for your team 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 your project team needs 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 Project 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.

Your project Captain might add in the missing information on these pages, or you can volunteer to do it yourself!

What You Can Do on the Project Wiki Space

Adding Pages

You're welcome to add more pages to the project wiki space, 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.

Before adding pages, coordinate with your project team. Try to agree on a logical structure for your project content, which will best serve your software's users, and then add pages according to this agreed-upon structure.

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 are 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 rename a page, edit it, change the page title at the top of the Edit screen, and save the page.
  • To erase a page, visit it, then from the top menu bar, select Admin > This Page > Remove Page.
    If you don't see the Remove Page link, this means the project Captain has not given you permission to erase pages.
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 full content 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).

Changing Viewing and Editing Permissions for a Specific Page

To restrict viewing and 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.

If you can't click the Restrictions button, this means your project Captain has not given you permission to restrict pages.


Other Topics in Space Cadet Guide

Adaptavist Theme Builder Powered by Atlassian Confluence