Setting up quick header links
Setting up quick header links
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.
You can use these shortcuts to create quick links to Mingle's wiki pages, a 'my work' page, and to create new cards (of different types). Since Mingle uses static URLs for most functions and views, you can link to just about anything. Add the
accesskey="x"command to set up a quick access key. Mingle displays this access key with an underline in the quick header link. You can see this in the example above for +Bug, and in the equivalent URL in the example below. The key combination to activate the access key depends on the user's browser, for Firefox it is Alt+Shift.
There are no buttons or links for creating special header links - you set them up by creating a new wiki page.
In the following examples, the macro substitution
{{ project }}
is used to insert your project identifier into the URL.
This is preferable to hard-coding the project identifier into the URLs, as it means these links will not break should you alter the project identifier or use this project as a template for a new project.
-
Wiki pages:
<a href="/projects/{{ project }}/wiki">Wiki Pages</a>This references the root wiki page, which lists all wiki pages page, also available in the Project admin tab Wiki pages link.
-
My work:
<a href="/projects/{{ project }}/wiki/My_Work">My Work</a>This references a user created wiki page called 'My Work'. In this case the page could hold a table which uses the special value (current user) to present cards which are assigned to the currently logged in user.
-
New bug:
<a href="/projects/{{ project }}/cards/new?properties[status]=new&properties[type]=bug" accesskey="b">+Bug</a>This action will create a new instance of a bug card, with the status property set to 'new' and open it for editing. The access key combination in Firefox would be Alt+Shift+b
-
New story:
<a href="/projects/{{ project }}/cards/new?properties[status]=new&properties[type]=story" accesskey="s">+Story</a>This action will create a new instance of a story card, with the status property set to 'new' and open it for editing. The access key combination in Firefox would be Alt+Shift+s
-
New risk:
<a href="/projects/{{ project }}/cards/new?properties[status]=new&properties[type]=risk" accesskey="r">+Risk</a>This action will create a new instance of a risk card, with the status property set to 'new' and open it for editing. The access key combination in Firefox would be Alt+Shift+r
Obtaining URLs for quick header links
You don't have to type in the URLs for header actions from scratch, instead you can navigate to the content you want to link to and copy the URL from your browser. How to do this is explained in the sections below:
URLs for wiki pages
URLs for wiki pages are simple - they are always in this format:
<a href="/projects/{{ project }}/wiki/wiki_page_name">Link Name</a>
- Here wiki_page_name should be replaced by the canonicalized name for the wiki page you are linking to. (lower case with spaces replaced by underscores - so "My Wiki page" becomes "my_wiki_page")
- and Link Name can be any text you wish to display in the header.
To obtain the URL, navigate to the wiki page and copy the URL from your browser.
You should replace the project identifier with the
{{ project }}
macro so that the link will not be broken should the project identifier change.
URLs for new cards
URLs for new cards are more complicated.
How to locate URLs for new cards
-
Sign in to Mingle and open the project for which to add quick header links (if you're not already working in this project).
You don't need to sign in as a project or Mingle administrator.
-
Click the All tab (or any other tab that displays cards).
Mingle displays all cards (or those that match the preset filters).
-
In the Filter list by... section, select the card filters according to the criteria you want to establish in the quick link for creating the new card.
For example, if you want to create a shortcut for a new bug, you might select Release is R1, Status is new, Type is defect.
-
Wait for Mingle to filter the list of cards and then click the Add with detail... button.
Mingle opens a new card.
-
Copy the URL that displays in the browser address bar.
It should look something like this:
http:/mingle.acompany.com/projects/email_application/cards/new?filter_properties[Type]=defect&filter_properties[Status]=new&filter_properties[Release]=R1
- Remove the front part of the URL http:/mingle.acompany.com, and the filter_ prefixes.
-
Add HTML link tags around the URL. So the example above becomes the URL below:
<a href="/projects/email_application/cards/new?properties[Type]=defect&properties[Status]=new&properties[Release]=R1" accesskey="d">+Defect</a>
This is now ready to paste into the Special:HeaderActions wiki page.
See How to Set Up a Quick Header Link below.
How to set up a quick header link
- Identify which quick header links you'd like to create and take a note of their URLs.
-
Sign in to Mingle and open the project for which to add quick header links (if you're not already working in this project).
You don't need to sign in as a project or Mingle administrator.
-
Navigate to the Special:HeaderActions wiki page. In your browser's address bar, type http://your_domain/projects/your_project_name/wiki/Special:HeaderActions and press [Enter]. Where your_domain is the location of Mingle in your organization and your_project_name is your project's name (i.e. the name Mingle assigns your project when first creating the project). If you currently have Mingle open you should be able to see this information in your browser's address bar.
Mingle displays a new blank wiki page, (unless you've already created the Special:HeaderActions page previously, in which case you will need to hit the Edit link to edit the existing page)
- Type or paste the URLs for your quick links into this wiki page.
-
Click the Save link.
Mingle displays the new quick header links at the top of your project page and creates a new wiki page called Special:HeaderActions.
- Test whether your new quick header links work as intended. If not, double-check the URLs and repeat.