Card keywords
Introduction
Card keywords are used by Mingle to create automatic links in cards and pages. If you add any of these keywords to a card number while editing a card or page, or submitting a source repository commit message, Mingle will automatically convert the card number to a link to the corresponding card. The link will display a tooltip to show you the name of the card when you hover your mouse over the card links. This allows users to better understand the context of any content (comments, murmurs or card descriptions) which contain the card links.
For example, if you have a keyword
#setup 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
- 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).
-
Click the Project admin tab.
Mingle displays the Project settings page.
if you are logged in as a project team member, Mingle displays the Team page.
-
Click the Card keywords link.
Mingle displays the Card keywords page.
-
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
orstory 123
orcard 123
ordefect 123
orbug 123
orfixed 123
orfix 123
and Mingle will automatically create a hyperlink to this card. - 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).
- Click the Update keywords link.
Cross project card and page linking
Card keyword linking supports 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 "event_management_project" from another project, you can type the following to create a link from your current project to the "event_management_project" card number 123 (note that no brackets are required):
event_management_project/#123
To link from a card or page in your Mingle project to a page in another Mingle project, just use the project identifier before the page name (note that brackets are required):
[[project_identifier/page]]
- You can create card and 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", and 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 page.
- If cross project card and page links are created, users who do not have permission to view those cards or pages 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.
See inline links to learn how to link to other resources in your Mingle project.
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. To associate a murmur with a card either murmur from a card or include a link to that card in the content of you murmur.
In Mingle 3.1, most card links in Mingle will display a tooltip to show you the name of the card when you hover your mouse over the card links. This allows users to better understand the context of any content (comments, murmurs or card descriptions) which contain the card links.
Please note that when murmurs are displayed on a card there is a small navigation icon at the end of each murmur. When you click on this icon it will take you to that murmur on the Murmurs tab. This will allow you to understand that murmur in the context of other murmurs that occurred before or after it.
