source: trunk/UNIT_TESTER/run/help/unittest.xml

Last change on this file was 18781, checked in by westram, 3 years ago
File size: 11.7 KB
Line 
1<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2<!DOCTYPE PAGE SYSTEM 'arb_help.dtd' [
3  <!ENTITY nbsp "&#160;">
4  <!ENTITY acute "&#180;">
5  <!ENTITY eacute "&#233;">
6  <!ENTITY apostr "&#39;">
7  <!ENTITY semi "&#59;">
8]>
9
10  <!--automatically generated from ../source/unittest.hlp -->
11<PAGE name="unittest" edit_warning="devel" source="source/unittest.hlp">
12  <UP dest="arb.hlp" type="hlp" source_line="2"/>
13  <UP dest="glossary.hlp" type="hlp" source_line="3"/>
14  <SUB dest="aci.hlp" type="hlp" source_line="6"/>
15  <SUB dest="srt.hlp" type="hlp" source_line="156"/>
16  <TITLE>Unittest example helpfile</TITLE>
17  <SECTION name="OCCURRENCE">
18    <P>
19      <T reflow="1">
20        nowhere</T>
21    </P>
22  </SECTION>
23  <SECTION name="DESCRIPTION">
24    <P>
25      <T reflow="1">
26        This is the first paragraph of the description.
27        It may be continued on the next line.</T>
28    </P>
29    <P>
30      <T reflow="1">
31        Another paragraph
32        also
33        belonging to description. It is followed by
34        an enumeration on the same indentation level:</T>
35    </P>
36    <ENUM>
37      <ENTRY enumerated="1">
38        <T reflow="1">
39          first enum</T>
40      </ENTRY>
41      <ENTRY enumerated="2">
42        <T reflow="1">
43          second enum which
44          is continued on the next line.
45          Now this is no longer misinterpreted as monospaced paragraph.</T>
46      </ENTRY>
47      <ENTRY enumerated="3">
48        <T reflow="1">
49          third enum</T>
50      </ENTRY>
51    </ENUM>
52    <P>
53      <T reflow="1">
54        Again a paragraph - a one liner followed by an item list. It is no longer misplaced now!</T>
55    </P>
56    <LIST>
57      <ENTRY item="1">
58        <T reflow="1">
59          item 1</T>
60      </ENTRY>
61      <ENTRY item="1">
62        <T reflow="1">
63          item 2</T>
64      </ENTRY>
65      <ENTRY item="1">
66        <T reflow="1">
67          item 3
68          contains 2 lines</T>
69      </ENTRY>
70    </LIST>
71  </SECTION>
72  <SECTION name="CUSTOM    A custom section.">
73    <P>
74      <T reflow="1">
75        Acts like DESCRIPTION, despite the SECTION line will be part of the headline.
76        In DESCRIPTION it would be part of the first paragraph.</T>
77    </P>
78    <P>
79      <T reflow="1">
80        First i need to check proper support for different
81        indentation levels.</T>
82      <P>
83        <T reflow="1">
84          This paragraph has to be indented one level deeper than
85          the previous paragraph.</T>
86      </P>
87      <P>
88        <T reflow="1">
89          That paragraph should be on
90          the same level.</T>
91        <P>
92          <T reflow="1">
93            Here is another one, even deeper.</T>
94        </P>
95        <P>
96          <T reflow="1">
97            Same,
98            same.</T>
99        </P>
100      </P>
101      <P>
102        <T reflow="1">
103          Back one step.</T>
104        <P>
105          <T reflow="1">
106            One step down - ignoring deeper
107            indentation in source.</T>
108        </P>
109        <P>
110          <T reflow="1">
111            Consecutive paragraphs are only placed on the same
112            level if their indentation matches.</T>
113        </P>
114        <P>
115          <T reflow="1">
116            Using the indentation level used 4 paragraphs above, wont help here.</T>
117          <P>
118            <T reflow="1">
119              But the "wrong" indentation of the previous
120              paragraph forces this paragraph to get indented one
121              level deeper than the paragraphs before.</T>
122          </P>
123          <P>
124            <T reflow="1">
125              This does not step back.</T>
126          </P>
127          <P>
128            <T reflow="1">
129              same same.</T>
130          </P>
131        </P>
132      </P>
133    </P>
134    <P>
135      <T reflow="1">
136        Back to top (end of indentation tests).</T>
137    </P>
138  </SECTION>
139  <SECTION name="Wanted fixes">
140    <P>
141      <T reflow="1">
142        Paragraphs containing multiple spaces will be
143        treated as monospaced. This is done to support
144        tabular information like the following:</T>
145      <P>
146        <T reflow="0">
147                    other
148        column      column
149row     1           2
150row2    -           3</T>
151      </P>
152    </P>
153    <P>
154      <T reflow="1">
155        Problems occur if there are empty lines inside such a table, like here:</T>
156      <P>
157        <T reflow="0">
158            other
159column      column</T>
160      </P>
161      <P>
162        <T reflow="0">
163row     1           2
164row2    -           3</T>
165      </P>
166      <P>
167        <T reflow="1">
168          (should better be combined)</T>
169      </P>
170    </P>
171    <P>
172      <T reflow="1">
173        Here is an itemlist whose items are triggered by &apostr;*&apostr;:</T>
174      <LIST>
175        <ENTRY item="1">
176          <T reflow="1">
177            item1
178            continued on next line</T>
179        </ENTRY>
180        <ENTRY item="1">
181          <T reflow="1">
182            item2</T>
183        </ENTRY>
184        <ENTRY item="1">
185          <T reflow="1">
186            item3</T>
187        </ENTRY>
188      </LIST>
189    </P>
190    <P>
191      <T reflow="1">
192        Itemlist containing paragraphs under some items</T>
193      <LIST>
194        <ENTRY item="1">
195          <T reflow="1">
196            item 1</T>
197        </ENTRY>
198        <ENTRY item="1">
199          <T reflow="1">
200            item 2</T>
201          <P>
202            <T reflow="1">
203              This is a short
204              description of item 2.
205              This description gets indented below the corresponding item.</T>
206          </P>
207        </ENTRY>
208        <ENTRY item="1">
209          <T reflow="1">
210            item 3</T>
211          <P>
212            <T reflow="1">
213              This is a shorter description of item 3.</T>
214          </P>
215        </ENTRY>
216      </LIST>
217      <P>
218        <T reflow="1">
219          This is a paragraph which should
220          be placed outside the itemlist.
221          Currently this is misinterpreted as part of the itemlist.</T>
222      </P>
223    </P>
224    <P>
225      <T reflow="1">
226        And this paragraph should be back where we were before
227        the itemlist began.</T>
228    </P>
229    <P>
230      <T reflow="1">
231        Enumeration also work if using letters
232        instead of digits. You can use capital letters as in
233        the following enum</T>
234    </P>
235    <ENUM>
236      <ENTRY enumerated="A">
237        <T reflow="1">
238          first enum</T>
239      </ENTRY>
240      <ENTRY enumerated="B">
241        <T reflow="1">
242          2nd enum</T>
243      </ENTRY>
244      <ENTRY enumerated="C">
245        <T reflow="1">
246          third enum</T>
247      </ENTRY>
248      <ENTRY enumerated="D">
249        <T reflow="1">
250          last enum</T>
251      </ENTRY>
252    </ENUM>
253    <P>
254      <T reflow="1">
255        or small letters like here:</T>
256      <ENUM>
257        <ENTRY enumerated="a">
258          <T reflow="1">
259            first enum</T>
260        </ENTRY>
261        <ENTRY enumerated="b">
262          <T reflow="1">
263            2nd enum</T>
264        </ENTRY>
265        <ENTRY enumerated="c">
266          <T reflow="1">
267            third enum</T>
268        </ENTRY>
269        <ENTRY enumerated="d">
270          <T reflow="1">
271            last enum</T>
272        </ENTRY>
273      </ENUM>
274    </P>
275    <P>
276      <T reflow="1">
277        Check some "illegal" itemlists:</T>
278      <P>
279        <T reflow="1">
280          ----------------------</T>
281      </P>
282      <P>
283        <T reflow="1">
284          -noitem</T>
285      </P>
286      <P>
287        <T reflow="0">
288-  eithernoitem</T>
289      </P>
290      <P>
291        <T reflow="1">
292          **********************</T>
293      </P>
294      <P>
295        <T reflow="1">
296          *noitem</T>
297      </P>
298      <P>
299        <T reflow="0">
300*  eithernoitem</T>
301      </P>
302    </P>
303  </SECTION>
304  <SECTION name="FEATURE TESTS">
305    <P>
306      <T reflow="1">
307        Here all existing helpfile features should be tested:</T>
308      <LIST>
309        <ENTRY item="1">
310          <T reflow="1">
311            first testing an inlined
312            link to another help file: <LINK dest="srt.hlp" type="hlp" source_line="160"/>
313          </T>
314        </ENTRY>
315        <ENTRY item="1">
316          <T reflow="1">
317            and a link to the arb homepage
318            <LINK dest="http://www.arb-home.de/" type="www" source_line="163"/>
319            followed by text.
320          </T>
321        </ENTRY>
322        <ENTRY item="1">
323          <T reflow="1">
324            arb help also supports mail-links (like <LINK dest="devel@arb-home.de" type="email" source_line="167"/>).
325            All 3 sorts of links should be clickable in the html version.
326          </T>
327        </ENTRY>
328      </LIST>
329    </P>
330  </SECTION>
331  <SECTION name="NESTED LISTS">
332    <P>
333      <T reflow="1">
334        text before enum</T>
335    </P>
336    <ENUM>
337      <ENTRY enumerated="1">
338        <T reflow="1">
339          first enum</T>
340        <P>
341          <T reflow="1">
342            text below first enum</T>
343        </P>
344        <LIST>
345          <ENTRY item="1">
346            <T reflow="1">
347              first item below first enum</T>
348          </ENTRY>
349          <ENTRY item="1">
350            <T reflow="1">
351              second item below first enum</T>
352            <ENUM>
353              <ENTRY enumerated="1">
354                <T reflow="1">
355                  first subenum below second item</T>
356                <LIST>
357                  <ENTRY item="1">
358                    <T reflow="1">
359                      first item below first subenum</T>
360                  </ENTRY>
361                  <ENTRY item="1">
362                    <T reflow="1">
363                      second item below first subenum</T>
364                  </ENTRY>
365                </LIST>
366              </ENTRY>
367              <ENTRY enumerated="2">
368                <T reflow="1">
369                  second subenum below second item</T>
370                <P>
371                  <T reflow="1">
372                    text before subsubenum</T>
373                </P>
374                <ENUM>
375                  <ENTRY enumerated="1">
376                    <T reflow="1">
377                      first subsubenum below second subenum</T>
378                  </ENTRY>
379                  <ENTRY enumerated="2">
380                    <T reflow="1">
381                      second subsubenum below second subenum</T>
382                  </ENTRY>
383                </ENUM>
384                <P>
385                  <T reflow="1">
386                    text behind subsubenum</T>
387                </P>
388              </ENTRY>
389              <ENTRY enumerated="3">
390                <T reflow="1">
391                  third subenum below second item</T>
392              </ENTRY>
393            </ENUM>
394          </ENTRY>
395          <ENTRY item="1">
396            <T reflow="1">
397              third item below first enum</T>
398          </ENTRY>
399        </LIST>
400      </ENTRY>
401      <ENTRY enumerated="2">
402        <T reflow="1">
403          second enum</T>
404        <P>
405          <T reflow="1">
406            This text is not indented more than the second enum,
407            but is nevertheless interpreted as sub-elements which
408            belongs to the enum.</T>
409        </P>
410      </ENTRY>
411      <ENTRY enumerated="3">
412        <T reflow="1">
413          third enum</T>
414        <P>
415          <T reflow="1">
416            behind the last enum, text only becomes a son
417            of the enum-entry if it is indented.</T>
418        </P>
419      </ENTRY>
420    </ENUM>
421    <P>
422      <T reflow="1">
423        text behind enum</T>
424    </P>
425  </SECTION>
426  <SECTION name="NOTES">
427    <P>
428      <T reflow="1">
429        Note that this test may help me.</T>
430    </P>
431  </SECTION>
432  <SECTION name="EXAMPLES">
433    <P>
434      <T reflow="1">
435        The whole file is just an example.</T>
436    </P>
437  </SECTION>
438  <SECTION name="WARNINGS">
439    <P>
440      <T reflow="1">
441        This text wont help you.</T>
442    </P>
443    <P>
444      <T reflow="1">
445        Even if i add more paragraphs here,
446        it will not get more useful.</T>
447    </P>
448  </SECTION>
449  <SECTION name="BUGS">
450    <P>
451      <T reflow="1">
452        will be detected by the unit test
453        checking the files into which
454        this file gets converted.</T>
455    </P>
456  </SECTION>
457</PAGE>
Note: See TracBrowser for help on using the repository browser.