r-labs » TestLink Link

[[PluginUsage|日本語]]

h1. Plugin Usage

{{>toc}}

h2. testlink(testcase, testreport) Macro

Writes macro like this format: 

<pre><code class="plain">

    {{testlink(KEY, ID [, ...])}}

    {{testcase(ID)}}

    {{testreport(ID, PlanID [, output_item, ...])}}

</code></pre>

In *KEY*, describes the key which specifies an link target.

The *testcase*, *testreport* macro is the one omitted *case*, *report* key respectively.

And the arguments since then ID change with the specified key. (Almost key no argument)

The link target which can be used is the following.

|_. Key     |_. Link target      |

| case      | Test case          |

| suite     | Test suite         |

| project   | Test project       |

| plan      | Test plan          |

| milestone | Milestone	         |

| build     | Build target       |

| cfield    | Custom field       |

| keyword   | Keyword infomation |

| user      | User infomation    |

+Example+:

<pre><code class="plain">

  {{testcase(sample-1)}}

  {{testlink(case, sample-1)}}

  {{testlink(suite, 2)}}

  {{testlink(project, 1)}}

  {{testlink(plan, 5)}}

  {{testlink(milestone, 1)}}

  {{testlink(build, 1)}}

  {{testlink(cfield, 1)}}

  {{testlink(user, 1)}}

</code></pre>

For test result (TestLink 1.8 or later).

|_. KEY      |_. Link target        |_.  Remarks                       |

| report     | Test report          | ID need two. Enable output items |

| planreport | Test plan report     | ID need two. Enable output items |

| metrics    | Metrics              |                                  |

| result     | Test result          | Enable status                    |

| graph	     | Graph of test result |                                  |

The required ID is changed by specifid key.

An ID of test case is found out at once, but Others is not.

Finds it from page adress and so on.

h3. Arguments of "report" and "planreport"

Keys of report and planreport need two ID (ID, PlanID) arguments.

And can be given output items after them.

|_. Output Item |_. Description           |_. report |_. planreport |

| toc           | Table of Contents       |    ○    |      ○      |

| header        | Test Suite description  |    ○    |      ○      |

| summary       | Test Case Summary       |    ○    |      ○      |

| body          | Test Case Scenario      |    ○    |      ○      |

| author        | Test Case Author        |    ○    |      ○      |

| keyword       | Test Case keywords      |    ○    |      ○      |

| cfields       | Test Case Custom Fields |    ○    |      ○      |

| passfail      | Test results            |    ○    |              |

| metrics       | Metrics                 |    ○    |              |

| testplan      | Test Plan description   |          |      ○      |

If omit output items, set default items which set in this plugin setting page.

<pre><code class="plain">

  {{testreport(2,6)}}

  {{testlink(report, 2, 6)}}

  {{testreport(2,6, header, summary, toc, body, cfields, author, keyword, passfail, metrics)}}

  {{testlink(planreport, 2, 6)}} 

  {{testlink(planreport, 2, 6, header, summary, toc, body, cfields, author, keyword, testplan)}}

  {{testlink(metrics, 6)}} 

  {{testlink(graph, 6)}}

</code></pre>

h3. Argument of *result*

Can give a target status in the *result* key.

If omits status, show test cases of all status.

|_. Status |_. Description |

| f | Failed Test Cases  |

| b | Blocked Test Cases |

| n | Not run Test Cases |

+Example+:

<pre><code class="plain">

  {{testlink(result, 6)}}

  {{testlink(result, 6, f)}}

</code></pre>

h2. *testfile* Macro

*testfile* Macro links to output file in MS Word form, MS Excell and so on.

(TestLink 1.8 or later)

Writes macro like this: 

<pre><code class="plain">

    {{testfile(format_name, target, ID [, ...])}}

</code></pre>

This macro is same as *testlink* except first argument specified format name.

Enable key are changed by a specified format name.

|_. Format          |_. Format Name |_. Enable Key       |

| OpenOffice Writer | odt           | report, planreport |

| OpenOffice Calc   | ods           | metrics, result    |

| MS Excel          | xls           | metrics, result    |

| MS Word           | doc           | report, planreport |

+Example+:

<pre><code class="plain">

  {{testfile(odt, report, 2,6)}}

  {{testfile(odt, planreport, 2, 6, header, summary, toc, body)}} 

  {{testfile(ods, metrics, 6)}} 

  {{testfile(ods, result, 6)}}

  {{testfile(ods, result, 6, n)}}

</code></pre>