DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:tfslink

TFSLink Plugin

Compatible with DokuWiki

  • 2017-02-19 "Frusterick Manners" unknown
  • 2016-06-26 "Elenor Of Tsort" unknown
  • 2015-08-10 "Detritus" unknown
  • 2014-09-29 "Hrun" yes

plugin Provides a convenient way to add links to TFS work items.

Last updated on
2015-01-06
Provides
Syntax, Action
Repository
Source

Tagged with links, tfs

This plugin allows you to insert links to Team Foundation Server work items via an interwiki-like syntax. It additionally provides a wizard that is accessible via the toolbar.

Installation

Install the plugin using the Plugin Manager and the download URL above, which points to latest version of the plugin. Refer to Plugins on how to install plugins manually.

Examples

[[wi>#356]]
[[wi>#356|Custom title for #356 at the default project collection]]
[[wi>teamfs#1793]] 
[[wi>teamfs#1793|title for #1793 at the custom project collection named teamfs]]

Syntax

Basic syntax:

[[wi>projectCollectionShorthand#workItemId|title]]
  • projectCollectionShorthand can be one of the pre-configured shorthands (optional)
  • workItemId is the numeric identifier of the targeted work item
  • title is self-explaining (optional)

Configuration and Settings

How to retrieve the Guid of a TFS project collection

  • TFS 2012/2013 and TFS Service (Online)
    1. Open any work item via the TFS web interface
    2. Click on the 'email workitem' button
    3. Look for 'pcguid=your-guid' within the hyperlink of the work item (Id column)
  • TFS 2010
    1. Open any work item for edit via the TFS web interface
    2. Look for 'pguid=your-guid' within the url on the top of the new window

Minimal settings

Aside from some default options that are configurable from the Configuration Manager,
your need to define at least the default TFS project collection to use:

local.tfslink.php
// configure your default collection here
$conf['plugin']['tfslink']['defaultCollection'] = array
    (
        'baseUrl'   => 'https://tfs.yourdomain.com/tfs',
        'name'      => 'DefaultCollection',
        'guid'      => '<Enter the Guid of the project collection here>',
        'title'     => 'your tfs',
        'version'   => 2013 // set to 2013 for TFS Service
    );

Optional settings

Multiple project collections

If needed, you can define multiple TFS project collections, see the example below.
:!: The shorthand defined here needs to be specified later on use according to the syntax.

local.tfslink.php
// configure additional tfs project collections here, if needed
$conf['plugin']['tfslink']['collections']['<your shorthand>'] = array
    (
        'baseUrl'   => 'http://anothertfs.yourdomain.com:8080/tfs',
        'name'      => 'DefaultCollection',
        'guid'      => '<Enter the Guid of the project collection here>',
        'title'	    => 'your other tfs',
        'version'   => 2010
    );

Development

Change Log

Release Log

* 2015-01-06

  • Initial release.

Known Bugs, Issues and requests

Please refer to GitHub to report bug and share feature requests.

plugin/tfslink.txt · Last modified: 2015-09-04 20:17 by Aleksandr