Help

Card keywords

Introduction...

Card keywords are used by Mingle to create automatic links in cards and wiki pages. If you add any of these keywords to a card number while editing a card or wiki page, or submitting a source repository commit message, Mingle will automatically convert the card number to a link to the corresponding card.

For example, if you have a keyword 

#
set up for the project, and you want to create a link to card 123, you can type 
#123

Choose card keywords based on the terminology that your team uses to describe cards, e.g. bug, defect, story, requirement, task, risk. At a minimum, it's a good idea to include card keywords that match the card types you create in card properties.

How to create and update card keywords

  1. Sign in to Mingle as a project administrator and open the project you want to change (if you're not already working in the project).

  2. Click the Project admin tab.

    Project admin tab

    Mingle displays the Project settings page.

    if you are logged in as a project team member, Mingle displays the Team page.

    Project admin menu - keywords link

  3. Click the Card keywords link.

    Mingle displays the Card keywords page.

    Card keyword page

  4. Type the keywords you would like Mingle to recognize and convert to links. Separate your keywords with a comma and a space.

    In the above example, if you want to link to card 123 you can type: 

    #123
    or 
    story 123
    or 
    card 123
    or 
    defect 123
    or 
    bug 123
    or 
    fixed 123
    or 
    fix 123
    and Mingle will automatically create a hyperlink to this card.

  5. If you have integrated your source repository with Mingle, you may wish to check whether your card keywords pick up card numbers in existing commit messages (see below).
  6. Click the Update keywords link.

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/#123
and 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.

Murmurs card links

Like other areas in Mingle (such as source revisions), Murmurs content renders card and wiki page links so that Murmurs provide links to other information stored in Mingle. These card links work by using the existing project card keywords.

In addition to providing links to other cards and pages, Murmurs that are associated with a card are also displayed on the card in the Comments/Murmurs section of the card.

Card comments and Murmurs

Also see...