日本語

Plugin Usage¶

• 目次
• Plugin Usage
  • testlink(testcase, testreport) Macro
    • Arguments of "report" and "planreport"
    • Argument of result
  • testfile Macro

testlink(testcase, testreport) Macro¶

Writes macro like this format:

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

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:

  {{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)}}

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.

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.

  {{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)}}

Argument of result¶

Can give a target status in the result key.
If omits status, show test cases of all status.

f	Failed Test Cases
b	Blocked Test Cases
n	Not run Test Cases

Example:

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

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:

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

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:

  {{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)}}