This server will be upgraded at 3pm Sydney time on December 3rd (December 2nd, 8pm PST) and will be down for up to 30 minutes.
This documentation relates to the latest version of Confluence.
If you are using an earlier version, please go to the documentation home page and select the relevant version.

Configuring Shortcut Links

All Versions
Click for all versions
Confluence 2.10 Documentation

Index

Shortcut links provide a quick way of linking to resources frequently referenced from Confluence. When you create a shortcut link, you are assigning a key to a URL so that when a user edits Confluence documents they can type the key instead of the complete URL.

Here is an example:

Most Google searches look like this: http://www.google.com/search?q=. If you create a shortcut for this search with the key 'google', every time a user needs to use http://www.google.com/search?q=searchterms, they can just type [searchterms@google] instead.

Here is a screenshot showing the shortcuts currently defined on http://confluence.atlassian.com:

Shortcut links are added and maintained by Confluence administrators from the Administration Console.

To create a shortcut link,

  1. Go to the 'Administration Console' and click 'Shortcut Links' in the left panel.
  2. Enter a 'Key' for your shortcut. This is the shortcut name a user will use to reference the URL.
  3. Enter the 'Expanded Value'. This is the URL for the link. You can use '%s' in the URL to specify where the user's input is inserted. If there is no '%s' in the URL, the user's input will be put at the end.
  4. (Optional. Available in Confluence version 2.3 and later.) Enter a 'Default Alias'. This is the text of the link which will be displayed on the page where the shortcut is used, with the user's text being substituted for '%s'.
  5. Click 'Save'.




Using Shortcut Links

Specify in the link what should go on the end of the shortcut URL, followed by an at-sign (@) and the key of the shortcut. Shortcut names are case-insensitive. So, for example, using the keys shown in the above screenshot:

To link to...
Type this
Resulting URL Demonstration
a JIRA issue [CONF-1000@JIRA] http://jira.atlassian.com/secure/QuickSearch.jspa?searchString=CONF-1000 CONF-1000
a Google search [Atlassian Confluence@Google] http://www.google.com/search?q=Atlassian+Confluence Atlassian Confluence@Google

Shortcut links can have titles just like any other link:

To link to...
Type this
Resulting URL Demonstration
Internet Movie Database [Fight Club|tt0137523@IMDB] http://us.imdb.com/Title?tt0137523 Fight Club
Google Cache [Cached Homepage|www.atlassian.com@cache] http://www.google.com/search?q=cache:www.atlassian.com Cached Homepage

Deleting Shortcut Links

Once you have created a shortcut link, it is listed under 'Shortcut Links' in the 'Administration Console'. Click 'Remove' to delete the shortcut.

RELATED TOPICS

Labels

admin-other admin-other Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Apr 14, 2007

    Evgeny Roubinchtein says:

    Is it possible to have multiple replaceable parameters in a shortcut link. ...

    Is it possible to have multiple replaceable parameters in a shortcut link.  For example, say I have a URL to (a web interface to) an LDAP database I want to query using a person's first and last name.  Can I make a "shortcut link" like: http://host/path?firstName=FIRST&lastName=LAST, where FIRST and LAST would _both_ be replacable.  If I name the above shortcut myLDAPQuery, I would like to be able to write

    [John Doe|THE_SYNTAX_I_WANT_YOU_TO_SHOW_ME@myLDAPQuery]

    and have it expanded to

    http://host/path?firstName=John&lastName=Doe

    1. Apr 14, 2007

      David Peterson [CustomWare] says:

      Unfortunately not. Basically, it just throws it on the end of the URL. If you wa...

      Unfortunately not. Basically, it just throws it on the end of the URL. If you want this kind of customisation, the best option is to create a User Macro. Let's say you create one called "my-ldap-query", it would have the following body:

      <a href="http://host/path?firstName=$param0&lastName=$param1>$body</a>
      

      And would be used like this:

      {my-ldap-query:John|Doe}John Doe{my-ldap-query}
      
      1. Apr 29, 2007

        Don Willis says:

        Just a quick clarification: The search term only goes on the end of the URL if...

        Just a quick clarification:

        The search term only goes on the end of the URL if there is no %s in the URL. If you specify %s in the URL, then the search term will replace it.

        In all other regards David's advice is correct.

  2. May 15, 2007

    John Allen says:

    Does using Shortcut Links circumvent the Trackback functionality from working? ...

    Does using Shortcut Links circumvent the Trackback functionality from working?

    Our current testing seems to indicate that they do.

    1. May 21, 2007

      Ivan Benko says:

      It would be appreciated if you could create a support case and describe your env...

      It would be appreciated if you could create a support case and describe your environment and exactly what is the situation that you are experiencing . Thaks,Ib

Add Comment