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 section
Mingle displays the wiki pages you've viewed most recently in the Recently viewed pages side bar section, which is visible in the right hand sidebar when viewing any wiki page.
Click on the page name link to view the corresponding wiki page, or click on the Index of pages link 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 setup.
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.
Cross project card and page linking
In Mingle 3.0 card keyword linking has been extended to support cross project card and page linking. In order to create cross project linking simply precede the card or page link with the project identifier of the project the card or page belongs to.
For example, if you have a project with the identifier "event_management_project" and you want to create a link to card 123 in the "event_management_project" project from another project, you can type
event_management_project/#123and this will link from your current project to the "event_management_project" card number 123.
For wiki page linking just use the project identifier before the wiki page name you can type
[[event_management_project/overview_page]]and this will link from your current project to the other project's wiki page.
You can create card and wiki page links using any of the location project's card keywords. For example, if the current project, where you are creating the card or page link, has the keywords "card" and "story" but not "bug" but the card or page you are linking to belongs to a project where "bug" is a keyword you would be able to use the "bug" keyword to link to that project's card or wiki page.
If cross project card and wiki links are created, when users who do not have permissions to view those cards or pages access them they will be prevented from viewing them.
If you have integrated your source repository with Mingle, you can link your commit messages to cards and pages in other projects by using cross project linking.
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.
Creating project reports in wiki pages and cards
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 access the Mingle macro editor and insert templates for graphs, charts and tables via the icons indicated below.
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.
