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.
Creating card keywords
Card keywords are words, numbers or symbols that Mingle uses to create automatic links in cards and wiki pages. When you're editing a card or wiki page and you add any of these keywords, Mingle will automatically convert them to links.
#. You're editing the description for a card and want to create a link to card number 123. Type
#123in the description to create a hyperlink to card 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. If in doubt, it's better to include more card keywords than you'll probably use.
When you type card keywords in Mingle (e.g. when editing a card description), always type the keyword followed by the card number, e.g.
#123or
card 123. It's irrelevant whether or not you add a space.
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
,story 123
,card 123
,defect 123
,bug 123
,fixed 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.
Using card keywords in source repository messages
One of Mingle's strengths is the ability to link subversion commit messages to specific cards. This means you can link source versions to a bug, story or user requirement.
Using the example in the procedure above, if you type
#123in a commit message, Mingle automatically creates a link to card number 123. When you're editing card number 123, you'll also see the source version and commit message in the card's History tab.
In the History tab for Card 1 above, you can see that Revision 937 addressed some aspect of this card (story 1). Clicking the Revision 937 link would take you to the Source tab where you could see all source files changed for that revision.
Testing card keywords source control integration
Before you begin, you must know the number of a card that has been referenced in a source commit message, e.g. Fixed bug 123.
- 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 number of a card that you know has been referenced in a subversion commit message.
-
Click the Show last 10 matching revisions button.
Mingle displays all matching subversion revisions. If you get results returned, this means you've selected good card keywords and Mingle is picking them up in commit messages.
If you don't see any matches, or not as many as you would expect, try adding different keywords and repeating.
-
Don't forget to click the Update keywords link to save your card keywords if you haven't done so already.