Title: Making Links with the Link Tool

Publishing, editing and linking pages is the core strength of wiki platforms. The Link Tool is a GUI launched from the Article Editor that makes it easy to make any one of 5 different types of links to:

Links made to existing articles and comments, by TractionID or by Page Name support bi-directional linking with referential integrity persisting through edits and across permission boundaries.

Likewise, Links by Wiki Page Name are maintained even when the Page Names are changed.

Power users may prefer to use wiki markup (e.g. simply type "[[Making Links with the Link Tool]]" to link to this article by name) or TractionIDs (e.g. simply type "Doc509" to link to this article by TractionID) to make links, but most users will prefer the interactive Link Tool.

Note: With TeamPage Release 5.0, the term 'project' was renamed to 'space'. Some older screenshots may use the original 'project' terminology. The definition of Space as TeamPage's named container for a set of sharable TeamPage Articles did not change - only its name, see Customer2797.

Overview of Making Links with the Link Tool

Before you choose from one of the 5 link types, you can adjust the Text to Display and whether to Open Link in a new window.

Link to an External URL

Choosing this option makes it easy to insert a link to a web page outside of your Traction server.

Type or paste the URL to link to into the External URL box, then click the Insert button to insert the link.

Internal Linking Examples

The New Article window here shows 3 completed links. The link tool images shown after the article show how the example links were created using the Link to an Article, Link to a Named Page and Link to a View options.

Link to an Article, Paragraph or Attachment

This tab in the Link Tool lets you specify the Traction ID of an article, or you can search for the article's title or body content and then select from a list.

The Employee Pension Program Link is made by choosing to Link to an Article, Comment or Attachment. In this case, the user starts by typing Pension.

When the word is completed, a list of articles and comments with the matching word appear.

The text displayed for the resulting link can optionally include the Traction ID (in this case HR72).

When you have chosen a page to link to, you will also be presented a list of paragraphs and attachments (if any) in that article that can be linked to directly.

If you know ahead of time that the link target was TractionID HR72, then then you could simply write HR72 into the article text. Extending the term to HR72.04 will link to Item 04 of the article. A new permanent Item ID is attached to each new Item in the article as it is created, and stays attached to the same Item as new Items are added or old items are deleted.

For more detail on linking to existing Traction Articles, see Making Links to Traction Articles

Link to a Named Page

The 401K Policy for Employees link is made by choosing Link to a Named Page. In this case, the user started typing the characters "Policy". A list of Named Pages with the word Policy in their Page Name appears and the user selects the 401K Policy for Employees name. For more information on the mechanics of Named Pages including how to use Wiki Markup syntax (e.g. "[[401K Policy for Employees]]", see Linking to Named Pages.

Link to a View

The final click here link that links to all policies is made by choosing Link to a View. From here, you can choose to link to:

The example below links to the content of the Active Policies section in the HR space. The view volume is Details which will show title, date and author of the articles in the Active Policies section.

See below for a screenshot of the Article after it's published. You see the three links. Below the comment form, you can see that there are two explicit link references from this article.

Because "Allow Links to this Article by Name" was checked in the Article Editor, the resulting article is also given a Page Name. Under Article Names, you can see the assigned Page Names - which includes the article title and any independently chosen alias names.

Bi-Directional Link References

When you link directly to an Article via Traction ID or Page Name, a bi-directional relationship is created between the two pages. If links cross Traction space boundaries, the incoming links are only displayed if user has permission to see the space where the link originates. For example if you clicked the Employee Pension Program link shown above you'd see Employee Pension Program article below.

Look at the Referenced By list below the Comment form. There's an incoming link from Retirement Policy Overview (the page published in the example above). There's also an incoming link from a page Executive Perks that's posted in the ExecutiveTeam space. If, as a user, you did not have Read permission in the ExecutiveTeam space, the incoming link and the Executive Pension Plan page name wouldn't be shown in the Referenced By list.

Incoming links from Draft (rather than published) articles only appear to readers who are able to Read Draft.

Link to a Shared File or Folder

Each space has a Share Folder. You can choose the Link to Shared File or Folder to link to any file or folder within the Space Share Folder.

This option lets you navigate the list of spaces and their share folders to select a file or folder to insert a link to.

Note: At this time, the Link Tool cannot be used to link to article-level Shared Files or Folders. These links will need to be created using the Link to an External URL option.

Related Articles
Article: Doc509 (permalink)
Date: December 26, 2008; 1:10:20 PM Eastern Standard Time

Author Name: Paul Needham
Author ID: pan