PluginUsageEn » 履歴 » バージョン 3
Mitsuyoshi Yoshida, 2011/11/20 11:09
1 | 1 | Mitsuyoshi Yoshida | [[PluginUsage|日本語]] |
---|---|---|---|
2 | |||
3 | h1. Plugin Usage |
||
4 | |||
5 | {{>toc}} |
||
6 | |||
7 | 3 | Mitsuyoshi Yoshida | h2. testlink(testcase) Macro |
8 | 1 | Mitsuyoshi Yoshida | |
9 | Writes macro like this format: |
||
10 | |||
11 | <pre><code class="plain"> |
||
12 | 3 | Mitsuyoshi Yoshida | {{testlink(KEY, ID)}} |
13 | 1 | Mitsuyoshi Yoshida | {{testcase(ID)}} |
14 | </code></pre> |
||
15 | |||
16 | 3 | Mitsuyoshi Yoshida | In *KEY*, describes the key which specifies a link target. |
17 | The *testcase* macro is the one omitted *case* key. |
||
18 | 1 | Mitsuyoshi Yoshida | |
19 | 3 | Mitsuyoshi Yoshida | Specifies an object ID of a target by *ID*. |
20 | An object ID of test case is found out at once, but Others is not. |
||
21 | Finds it from page adress and so on. |
||
22 | 1 | Mitsuyoshi Yoshida | |
23 | 3 | Mitsuyoshi Yoshida | The link target which can be used is following: |
24 | 1 | Mitsuyoshi Yoshida | |
25 | 3 | Mitsuyoshi Yoshida | |_. Key |_. Link target |_. Remarks | |
26 | | case | Test case | | |
||
27 | | suite | Test suite | | |
||
28 | | project | Test project | TestLink 1.8 or later | |
||
29 | | plan | Test plan | | |
||
30 | | milestone | Milestone | | |
||
31 | | build | Build target | | |
||
32 | | cfield | Custom field | | |
||
33 | | keyword | Keyword infomation | | |
||
34 | | user | User infomation | | |
||
35 | 1 | Mitsuyoshi Yoshida | |
36 | 3 | Mitsuyoshi Yoshida | +Examples+: |
37 | 1 | Mitsuyoshi Yoshida | |
38 | <pre><code class="plain"> |
||
39 | {{testcase(sample-1)}} |
||
40 | {{testlink(case, sample-1)}} |
||
41 | {{testlink(suite, 2)}} |
||
42 | {{testlink(project, 1)}} |
||
43 | {{testlink(plan, 5)}} |
||
44 | {{testlink(milestone, 1)}} |
||
45 | {{testlink(build, 1)}} |
||
46 | {{testlink(cfield, 1)}} |
||
47 | {{testlink(user, 1)}} |
||
48 | </code></pre> |
||
49 | |||
50 | |||
51 | 3 | Mitsuyoshi Yoshida | h2. Link to test results |
52 | |||
53 | If The version of TestLink is 1.8 or later, You can link to a test reslut. |
||
54 | |||
55 | <pre><code class="plain"> |
||
56 | {{testlink(KEY, ID [, ...])}} |
||
57 | {{testreport(ID, PLAN_ID [, OUTPUT_ITEM, ...])}} |
||
58 | </code></pre> |
||
59 | |||
60 | The *testreport* macro is the one omitted *report* key respectively. |
||
61 | |||
62 | The arguments since then *ID* change with the specified key. |
||
63 | |||
64 | The link target for test results is following: |
||
65 | |||
66 | 1 | Mitsuyoshi Yoshida | |_. KEY |_. Link target |_. Remarks | |
67 | | report | Test report | ID need two. Enable output items | |
||
68 | | planreport | Test plan report | ID need two. Enable output items | |
||
69 | | metrics | Metrics | | |
||
70 | | result | Test result | Enable status | |
||
71 | | graph | Graph of test result | | |
||
72 | |||
73 | 3 | Mitsuyoshi Yoshida | Keys of report and planreport need two ID (ID, PLAN_ID) arguments. |
74 | 1 | Mitsuyoshi Yoshida | And can be given output items after them. |
75 | |||
76 | 3 | Mitsuyoshi Yoshida | |_. OUTPUT_ITEM |_. Description |_. report |_. planreport | |
77 | 1 | Mitsuyoshi Yoshida | | toc | Table of Contents | ○ | ○ | |
78 | | header | Test Suite description | ○ | ○ | |
||
79 | | summary | Test Case Summary | ○ | ○ | |
||
80 | | body | Test Case Scenario | ○ | ○ | |
||
81 | | author | Test Case Author | ○ | ○ | |
||
82 | | keyword | Test Case keywords | ○ | ○ | |
||
83 | | cfields | Test Case Custom Fields | ○ | ○ | |
||
84 | | passfail | Test results | ○ | | |
||
85 | | metrics | Metrics | ○ | | |
||
86 | | testplan | Test Plan description | | ○ | |
||
87 | |||
88 | If omit output items, set default items which set in this plugin setting page. |
||
89 | |||
90 | 3 | Mitsuyoshi Yoshida | !setting_report_en.png! !setting_planreport_en.png! |
91 | |||
92 | +Examples+: |
||
93 | |||
94 | 1 | Mitsuyoshi Yoshida | <pre><code class="plain"> |
95 | {{testreport(2,6)}} |
||
96 | {{testlink(report, 2, 6)}} |
||
97 | {{testreport(2,6, header, summary, toc, body, cfields, author, keyword, passfail, metrics)}} |
||
98 | {{testlink(planreport, 2, 6)}} |
||
99 | {{testlink(planreport, 2, 6, header, summary, toc, body, cfields, author, keyword, testplan)}} |
||
100 | {{testlink(metrics, 6)}} |
||
101 | {{testlink(graph, 6)}} |
||
102 | </code></pre> |
||
103 | |||
104 | |||
105 | h3. Argument of *result* |
||
106 | |||
107 | 3 | Mitsuyoshi Yoshida | In the *result* case, A status of test case is given after ID argument, and The output result is filtered. |
108 | 1 | Mitsuyoshi Yoshida | If omits status, show test cases of all status. |
109 | |||
110 | 3 | Mitsuyoshi Yoshida | <pre><code class="plain"> |
111 | {{testlink(result, ID, STATUS)}} |
||
112 | </code></pre> |
||
113 | |||
114 | |_. STATUS |_. Description | |
||
115 | 1 | Mitsuyoshi Yoshida | | f | Failed Test Cases | |
116 | | b | Blocked Test Cases | |
||
117 | | n | Not run Test Cases | |
||
118 | |||
119 | 3 | Mitsuyoshi Yoshida | +Examples+: |
120 | 1 | Mitsuyoshi Yoshida | |
121 | <pre><code class="plain"> |
||
122 | {{testlink(result, 6)}} |
||
123 | {{testlink(result, 6, f)}} |
||
124 | </code></pre> |
||
125 | |||
126 | |||
127 | 3 | Mitsuyoshi Yoshida | h2. Macros(*testfile*) for file download |
128 | 1 | Mitsuyoshi Yoshida | |
129 | 3 | Mitsuyoshi Yoshida | *testfile* macro links to output file in MS Word form, MS Excell and so on. |
130 | 1 | Mitsuyoshi Yoshida | (TestLink 1.8 or later) |
131 | |||
132 | Writes macro like this: |
||
133 | |||
134 | <pre><code class="plain"> |
||
135 | 3 | Mitsuyoshi Yoshida | {{testfile(FORMAT_NAME, KEY, ID [, ...])}} |
136 | 1 | Mitsuyoshi Yoshida | </code></pre> |
137 | |||
138 | 3 | Mitsuyoshi Yoshida | This macro is same as *testlink* except first argument(*FORMAT_NAME*) specified format type. |
139 | Enable *KEY* are changed by a specified format name. |
||
140 | 1 | Mitsuyoshi Yoshida | |
141 | 3 | Mitsuyoshi Yoshida | |_. Format |_. FORMAT_NAME |_. Enable KEY | |
142 | 1 | Mitsuyoshi Yoshida | | OpenOffice Writer | odt | report, planreport | |
143 | | OpenOffice Calc | ods | metrics, result | |
||
144 | | MS Word | doc | report, planreport | |
||
145 | 3 | Mitsuyoshi Yoshida | | MS Excel | xls | metrics, result | |
146 | 1 | Mitsuyoshi Yoshida | |
147 | +Example+: |
||
148 | |||
149 | <pre><code class="plain"> |
||
150 | {{testfile(odt, report, 2,6)}} |
||
151 | {{testfile(odt, planreport, 2, 6, header, summary, toc, body)}} |
||
152 | {{testfile(ods, metrics, 6)}} |
||
153 | {{testfile(ods, result, 6)}} |
||
154 | {{testfile(ods, result, 6, n)}} |
||
155 | </code></pre> |