source: branches/stable/HELP_SOURCE/oldhelp/unittest.hlp

Last change on this file was 10842, checked in by westram, 11 years ago
File size: 7.4 KB
Line 
1#Please insert up references in the next lines (line starts with keyword UP)
2UP      arb.hlp
3UP      glossary.hlp
4
5#Please insert subtopic references  (line starts with keyword SUB)
6SUB     aci.hlp
7
8# Hypertext links in helptext can be added like this: LINK{ref.hlp|http://add|bla@domain}
9
10#************* Title of helpfile !! and start of real helpfile ********
11TITLE           Unittest example helpfile
12
13OCCURRENCE      nowhere
14
15DESCRIPTION     This is the first paragraph of the description.
16                It may be continued on the next line.
17
18                Another paragraph
19                also
20                belonging to description. It is followed by
21                an enumeration on the same indentation level:
22
23                1. first enum
24                2. second enum which
25                   is continued on the next line.
26                   Now this is no longer misinterpreted as monospaced paragraph.
27                3. third enum
28
29                Again a paragraph - a one liner followed by an item list. It is no longer misplaced now!
30
31                - item 1
32                - item 2
33                - item 3
34                  contains 2 lines
35
36SECTION CUSTOM    A custom section.
37                  Acts like DESCRIPTION, despite the SECTION line will be part of the headline.
38                  In DESCRIPTION it would be part of the first paragraph.
39
40                  First i need to check proper support for different
41                  indentation levels.
42
43                              This paragraph has to be indented one level deeper than
44                              the previous paragraph.
45
46                              That paragraph should be on
47                              the same level.
48
49                                  Here is another one, even deeper.
50
51                                  Same,
52                                  same.
53
54                              Back one step.
55
56                                                            One step down - ignoring deeper
57                                                            indentation in source.
58
59                                                            Consecutive paragraphs are only placed on the same
60                                                            level if their indentation matches.
61
62                                  Using the indentation level used 4 paragraphs above, wont help here.
63
64                                                            But the "wrong" indentation of the previous
65                                                            paragraph forces this paragraph to get indented one
66                                                            level deeper than the paragraphs before.
67
68                                                This does not step back.
69
70                                                same same.
71                                               
72                  Back to top (end of indentation tests).
73
74SECTION Wanted fixes
75
76                  Paragraphs containing multiple spaces will be
77                  treated as monospaced. This is done to support
78                  tabular information like the following:
79
80                                          other
81                              column      column
82                      row     1           2
83                      row2    -           3
84   
85   
86                  Problems occur if there are empty lines inside such a table, like here:
87   
88                                          other
89                              column      column
90   
91                      row     1           2
92                      row2    -           3
93   
94                      (should better be combined)
95
96
97
98                  Here is an itemlist whose items are triggered by '*':
99
100                       * item1
101                         continued on next line
102                       * item2
103                       * item3
104
105                  Itemlist containing paragraphs under some items
106
107                           - item 1
108                           - item 2
109
110                             This is a short
111                             description of item 2.
112                             This description gets indented below the corresponding item.
113
114                           - item 3
115
116                             This is a shorter description of item 3.
117
118                           This is a paragraph which should
119                           be placed outside the itemlist.
120                           Currently this is misinterpreted as part of the itemlist.
121
122                   
123                  And this paragraph should be back where we were before
124                  the itemlist began.
125
126                  Enumeration also work if using letters
127                  instead of digits. You can use capital letters as in
128                  the following enum
129
130                  A. first enum
131                  B. 2nd enum
132                  C. third enum
133                  D. last enum
134
135                  or small letters like here:
136
137                                    a. first enum
138                                    b. 2nd enum
139                                    c. third enum
140                                    d. last enum
141
142                  Check some "illegal" itemlists:
143
144                        ----------------------
145
146                        -noitem
147
148                        -  eithernoitem
149
150                        **********************
151
152                        *noitem
153
154                        *  eithernoitem
155
156SECTION FEATURE TESTS
157
158                Here all existing helpfile features should be tested:
159
160                     - first testing an inlined
161                       link to another help file: LINK{srt.hlp}
162
163                     - and a link to the arb homepage
164                       LINK{http://www.arb-home.de/}
165                       followed by text.
166
167                     - arb help also supports mail-links (like LINK{devel@arb-home.de}).
168                       All 3 sorts of links should be clickable in the html version.
169
170SECTION NESTED LISTS
171
172               text before enum
173
174               1. first enum
175
176                  text below first enum
177
178                  - first item below first enum
179                  - second item below first enum
180                    1. first subenum below second item
181                     - first item below first subenum
182                     - second item below first subenum
183                    2. second subenum below second item
184
185                     text before subsubenum
186
187                     1. first subsubenum below second subenum
188                     2. second subsubenum below second subenum
189
190                     text behind subsubenum
191
192                    3. third subenum below second item
193                  - third item below first enum
194
195               2. second enum
196
197               This text is not indented more than the second enum,
198               but is nevertheless interpreted as sub-elements which
199               belongs to the enum.
200
201               3. third enum
202
203                  behind the last enum, text only becomes a son
204                  of the enum-entry if it is indented.
205
206               text behind enum
207
208NOTES           Note that this test may help me.
209
210EXAMPLES        The whole file is just an example.
211
212WARNINGS        This text wont help you.
213
214         Even if i add more paragraphs here,
215         it will not get more useful.
216
217BUGS            will be detected by the unit test
218                checking the files into which
219                this file gets converted.
Note: See TracBrowser for help on using the repository browser.