Help

Using the Mingle Wiki

Introduction

A wiki is a loose collection of free-text pages that lets anybody add information on any topic relevant to a community. Wiki pages can be linked to one another to provide structured navigation.

What's different about the Mingle wiki

The Mingle wiki is an integral part of Mingle. Because of this it has direct access to the underlying data stored in Mingle, so you can easily embed graphs, charts and tables derived from live project data into wiki pages. You can also link directly to cards from wiki pages, and if you embed a MQL query that returns cards, then you will automatically be able to click through to view and edit any of the cards listed.

Mingle wiki pages can be made into favorites and tabs to allow quick access from the Mingle user interface, the Overview page being one example.

The overview tab

The Overview tab is a predefined wiki page which is always directly accessible from the Mingle user interface, and typically acts as an access page into other linked wiki pages. Mingle supports support the creation of charts and tables in the Wiki which query the Mingle database to display up-to-date project information graphically. The standard project templates generally have some project reporting in the form of charts and tables on the overview tab.

You can take a look at this example project overview page to see how that might look

Recently viewed wiki pages control

Mingle displays the wiki pages you've viewed most recently in the Recently viewed pages control, which is visible in the right hand sidebar when viewing any wiki page.

Recently viewed pages

Click on the page name link to view the corresponding wiki page, or click on the Index of pages to view a list of all wiki pages.

Linking between wiki pages and cards

Mingle wiki pages can be linked to from card descriptions as well as from other Mingle wiki pages by typing the wiki page name enclosed in double square brackets e.g.

[[wiki_page_name]]
.

You can also link to specific cards from within wiki pages by typing in the card number prefixed by a card keyword e.g.

#123
. In this case the card keyword is the
#
symbol, however the actual prefix you use in front of card numbers depends on the card keywords you set up.

You can also reference Mingle wiki pages directly using URL's e.g. http://mingle.yourcompany.com/projects/your_project/wiki/new_wiki_page, however you will still have to sign in to Mingle in order view the referenced wiki page.

Formatting and the wiki toolbar

To apply formatting to Mingle's wiki pages, you must type various special text and symbols (wiki markup) before or after your text to change the appearance of your text. When you edit a wiki page, Mingle displays a list of common markup formatting that you can apply to your text, but a full formatting reference guide is also available.

Using wiki markup lets you add links, graphics, headings, tables and text formatting (e.g. bold, underline).

Most common formatting tasks are also available as buttons in the wiki toolbar.

Wiki toolbar

Embedding project reporting in wiki pages

Mingle supports support the creation of graphs, charts and tables in the Wiki which query the Mingle database to display up-to-date project information graphically.

The wiki toolbar allows you to insert templates for graphs, charts and tables via the icons indicated below

Wiki toolbar - with graph, chart and table icons highlighted

Special header actions

In Mingle, you can create header actions which act as shortcuts to any page, saved view, or to create a new card by creating a wiki page called Special:HeaderActions. These shortcuts display in the top part of your project's header, as in the example below.

Example header actions