source: branches/lib/UNIT_TESTER/run/help/unittest.html

Last change on this file was 19575, checked in by westram, 4 weeks ago
  • reintegrates 'help' into 'trunk'
    • preformatted text gets checked for width now (to enforce it fits into the arb help window).
    • fixed help following these checks, using the following steps:
      • ignore problems in foreign documentation.
      • increase default help window width.
      • introduce control comments to
        • accept oversized preformatted sections.
        • enforce preformatted style for whole sections.
        • simply define single-line preformatted sections
          Used intensive for definition of internal script languages.
    • fixed several non-related problems found in documentation.
    • minor layout changes for HTML version of arb help (more compacted; highlight anchored/all sections).
    • refactor system interface (GUI version) and use it from help module.
  • adds: log:branches/help@19532:19574
File size: 12.2 KB
Line 
1<HTML><!--Generated from XML - XSLT-Stylesheet by Ralf Westram (ralf@arb-home.de) --><HEAD><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><META NAME="Author" CONTENT="ARB development"><meta http-equiv="expires" content="86400"><TITLE>ARB help: Unittest example helpfile</TITLE><style type="text/css">
2          div {
3          margin-left:+10pt;
4          padding-top:3pt; padding-bottom:3pt;
5          }
6          ul,ol,pre { margin-top:0pt; margin-bottom:0pt; }
7          h2.section { background-color: whitesmoke; }
8          a.section { color: darkblue; text-decoration:none; }
9          tr.shaded, h2.section:target { background-color: #d8edff; }
10          h2 { padding:0px; padding-top:6px; padding-top:6px; margin:8px; }
11          h3 { font-weight:normal; padding:0px; padding-top:3pt; margin:0px; }
12        </style></HEAD><BODY LEFTMARGIN="10" TEXT="black" BGCOLOR="white" LINK="blue" VLINK="green" ALINK="red"><TABLE width="95%"><TR><TD align="left" valign="top"><FORM method="GET" action="http://www.google.com/search" name="google"><A HREF="http://www.google.com"><IMG SRC="Logo_25wht.gif" width="75" height="32" border="0" ALT="Google" align="absmiddle"></A><INPUT TYPE="hidden" name="q"><INPUT TYPE="hidden" name="hl" value="en"><INPUT TYPE="hidden" name="as_sitesearch" value="help.arb-home.de"><INPUT TYPE="text" name="q2" size="31" maxlength="255"><INPUT type="submit" name="btnG" VALUE="Search help" onClick="google.q.value=google.q2.value;return true;"><INPUT type="submit" name="btnG" VALUE="Search site" onClick="google.as_sitesearch.value='arb-home.de';google.q.value=google.q2.value;return true;"></FORM></TD><TD valign="top" align="right"><FONT size="-1"><NOBR>More docs on the
13                <A href="http://rtfm.arb-home.de/">ARB website</A>.</NOBR><BR>
14                See also <A href="help_index.html">index</A> of helppages.<BR>
15                Last update on
1610. Nov 2025
17  .
18              </FONT></TD></TR></TABLE><TABLE border="0" width="98%" align="center"><TR class="shaded">
19            <TD valign="top" width="50%">Main topics:<BR><UL><LI><A href="arb.html">ARB: a Short Introduction</A></LI><LI><A href="glossary.html">Glossary</A></LI></UL></TD>
20            <TD valign="top">Related topics:<BR><UL><LI><A href="aci.html">ARB Command Interpreter (ACI)</A></LI><LI><A href="srt.html">Search and Replace Tool (SRT)</A></LI></UL></TD>
21            </TR><TR><TD colspan="2"><H1>Unittest example helpfile</H1><UL><LI><A href="#OCCURRENCE">OCCURRENCE</A></LI><LI><A href="#DESCRIPTION">DESCRIPTION</A></LI><LI><A href="#CUSTOM____A_custom_section.">CUSTOM    A custom section.</A></LI><LI><A href="#Wanted_fixes">Wanted fixes</A></LI><LI><A href="#FEATURE_TESTS">FEATURE TESTS</A></LI><LI><A href="#NESTED_LISTS">NESTED LISTS</A></LI><LI><A href="#NOTES">NOTES</A></LI><LI><A href="#EXAMPLES">EXAMPLES</A></LI><LI><A href="#WARNINGS">WARNINGS</A></LI><LI><A href="#BUGS">BUGS</A></LI></UL><H2 class="section" id="OCCURRENCE"><A class="section" href="#OCCURRENCE">OCCURRENCE</A></H2><TABLE width="100%" border="0"><TR><TD align="right"><TABLE width="97%" border="0"><TR><TD>
22    <DIV><H3>nowhere</H3></DIV>
23  </TD></TR><TR><TD> </TD></TR></TABLE></TD></TR></TABLE><H2 class="section" id="DESCRIPTION"><A class="section" href="#DESCRIPTION">DESCRIPTION</A></H2><TABLE width="100%" border="0"><TR><TD align="right"><TABLE width="97%" border="0"><TR><TD>
24    <DIV><H3>This is the first paragraph of the description. It may be continued on the next line.</H3></DIV>
25    <DIV><H3>Another paragraph also belonging to description. It is followed by an enumeration on the same indentation level:</H3></DIV>
26    <OL><LI>
27        first enum
28      </LI><LI>
29        second enum which is continued on the next line. Now this is no longer misinterpreted as monospaced paragraph.
30      </LI><LI>
31        third enum
32      </LI></OL><BR>
33    <DIV><H3>Again a paragraph - a one liner followed by an item list. It is no longer misplaced now!</H3></DIV>
34    <UL><LI>
35        item 1
36      </LI><LI>
37        item 2
38      </LI><LI>
39        item 3 contains 2 lines
40      </LI></UL><BR>
41  </TD></TR><TR><TD> </TD></TR></TABLE></TD></TR></TABLE><H2 class="section" id="CUSTOM____A_custom_section."><A class="section" href="#CUSTOM____A_custom_section.">CUSTOM    A custom section.</A></H2><TABLE width="100%" border="0"><TR><TD align="right"><TABLE width="97%" border="0"><TR><TD>
42    <DIV><H3>Acts like DESCRIPTION, despite the SECTION line will be part of the headline. In DESCRIPTION it would be part of the first paragraph.</H3></DIV>
43    <DIV><H3>First i need to check proper support for different indentation levels.</H3><DIV>
44        This paragraph has to be indented one level deeper than the previous paragraph.
45      </DIV><DIV>
46        That paragraph should be on the same level.
47        <DIV>
48          Here is another one, even deeper.
49        </DIV>
50        <DIV>
51          Same, same.
52        </DIV>
53      </DIV><DIV>
54        Back one step.
55        <DIV>
56          One step down - ignoring deeper indentation in source.
57        </DIV>
58        <DIV>
59          Consecutive paragraphs are only placed on the same level if their indentation matches.
60        </DIV>
61        <DIV>
62          Using the indentation level used 4 paragraphs above, wont help here.
63          <DIV>
64            But the "wrong" indentation of the previous paragraph forces this paragraph to get indented one level deeper than the paragraphs before.
65          </DIV>
66          <DIV>
67            This does not step back.
68          </DIV>
69          <DIV>
70            same same.
71          </DIV>
72        </DIV>
73      </DIV></DIV>
74    <DIV><H3>Back to top (end of indentation tests).</H3></DIV>
75  </TD></TR><TR><TD> </TD></TR></TABLE></TD></TR></TABLE><H2 class="section" id="Wanted_fixes"><A class="section" href="#Wanted_fixes">Wanted fixes</A></H2><TABLE width="100%" border="0"><TR><TD align="right"><TABLE width="97%" border="0"><TR><TD>
76    <DIV><H3>Paragraphs containing multiple spaces will be treated as monospaced. This is done to support tabular information like the following:</H3><DIV>
77        <PRE><FONT color="navy" size="-1">                    other
78        column      column
79row     1           2
80row2    -           3</FONT></PRE>
81      </DIV></DIV>
82    <DIV><H3>Problems occur if there are empty lines inside such a table, like here:</H3><DIV>
83        <PRE><FONT color="navy" size="-1">            other
84column      column</FONT></PRE>
85      </DIV><DIV>
86        <PRE><FONT color="navy" size="-1">row     1           2
87row2    -           3</FONT></PRE>
88      </DIV><DIV>
89        (should better be combined)
90      </DIV></DIV>
91    <DIV><H3>Here is an itemlist whose items are triggered by '*':</H3><UL><LI>
92          item1 continued on next line
93        </LI><LI>
94          item2
95        </LI><LI>
96          item3
97        </LI></UL><BR></DIV>
98    <DIV><H3>Itemlist containing paragraphs under some items</H3><UL><LI>
99          item 1
100        </LI><LI>
101          item 2
102          <DIV>
103            This is a short description of item 2. This description gets indented below the corresponding item.
104          </DIV>
105        </LI><LI>
106          item 3
107          <DIV>
108            This is a shorter description of item 3.
109          </DIV>
110        </LI></UL><BR><DIV>
111        This is a paragraph which should be placed outside the itemlist. Currently this is misinterpreted as part of the itemlist.
112      </DIV></DIV>
113    <DIV><H3>And this paragraph should be back where we were before the itemlist began.</H3></DIV>
114    <DIV><H3>Enumeration also work if using letters instead of digits. You can use capital letters as in the following enum</H3></DIV>
115    <OL type="A"><LI>
116        first enum
117      </LI><LI>
118        2nd enum
119      </LI><LI>
120        third enum
121      </LI><LI>
122        last enum
123      </LI></OL><BR>
124    <DIV><H3>or small letters like here:</H3><OL type="a"><LI>
125          first enum
126        </LI><LI>
127          2nd enum
128        </LI><LI>
129          third enum
130        </LI><LI>
131          last enum
132        </LI></OL><BR></DIV>
133    <DIV><H3>Check some "illegal" itemlists:</H3><DIV>
134        ----------------------
135      </DIV><DIV>
136        -noitem
137      </DIV><DIV>
138        <PRE><FONT color="navy" size="-1">-  eithernoitem</FONT></PRE>
139      </DIV><DIV>
140        **********************
141      </DIV><DIV>
142        *noitem
143      </DIV><DIV>
144        <PRE><FONT color="navy" size="-1">*  eithernoitem</FONT></PRE>
145      </DIV></DIV>
146  </TD></TR><TR><TD> </TD></TR></TABLE></TD></TR></TABLE><H2 class="section" id="FEATURE_TESTS"><A class="section" href="#FEATURE_TESTS">FEATURE TESTS</A></H2><TABLE width="100%" border="0"><TR><TD align="right"><TABLE width="97%" border="0"><TR><TD>
147    <DIV><H3>Here all existing helpfile features should be tested:</H3><UL><LI>
148          first testing an inlined link to another help file: <A href="srt.html">ÂŽSearch and Replace Tool (SRT)ÂŽ</A>
149        </LI><LI>
150          and a link to the arb homepage <A href="http://www.arb-home.de/">http://www.arb-home.de/</A> followed by text.
151        </LI><LI>
152          arb help also supports mail-links (like <A href="mailto:devel@arb-home.de?subject=Concerning%20helppage%20unittest.xml">devel@arb-home.de</A>). All 3 sorts of links should be clickable in the html version.
153        </LI></UL><BR></DIV>
154  </TD></TR><TR><TD> </TD></TR></TABLE></TD></TR></TABLE><H2 class="section" id="NESTED_LISTS"><A class="section" href="#NESTED_LISTS">NESTED LISTS</A></H2><TABLE width="100%" border="0"><TR><TD align="right"><TABLE width="97%" border="0"><TR><TD>
155    <DIV><H3>text before enum</H3></DIV>
156    <OL><LI>
157        first enum
158        <DIV>
159          text below first enum
160        </DIV>
161        <UL><LI>
162            first item below first enum
163          </LI><LI>
164            second item below first enum
165            <OL><LI>
166                first subenum below second item
167                <UL><LI>
168                    first item below first subenum
169                  </LI><LI>
170                    second item below first subenum
171                  </LI></UL><BR>
172              </LI><LI>
173                second subenum below second item
174                <DIV>
175                  text before subsubenum
176                </DIV>
177                <OL><LI>
178                    first subsubenum below second subenum
179                  </LI><LI>
180                    second subsubenum below second subenum
181                  </LI></OL><BR>
182                <DIV>
183                  text behind subsubenum
184                </DIV>
185              </LI><LI>
186                third subenum below second item
187              </LI></OL><BR>
188          </LI><LI>
189            third item below first enum
190          </LI></UL><BR>
191      </LI><LI>
192        second enum
193        <DIV>
194          This text is not indented more than the second enum, but is nevertheless interpreted as sub-elements which belongs to the enum.
195        </DIV>
196      </LI><LI>
197        third enum
198        <DIV>
199          behind the last enum, text only becomes a son of the enum-entry if it is indented.
200        </DIV>
201      </LI></OL><BR>
202    <DIV><H3>text behind enum</H3></DIV>
203  </TD></TR><TR><TD> </TD></TR></TABLE></TD></TR></TABLE><H2 class="section" id="NOTES"><A class="section" href="#NOTES">NOTES</A></H2><TABLE width="100%" border="0"><TR><TD align="right"><TABLE width="97%" border="0"><TR><TD>
204    <DIV><H3>Note that this test may help me.</H3></DIV>
205  </TD></TR><TR><TD> </TD></TR></TABLE></TD></TR></TABLE><H2 class="section" id="EXAMPLES"><A class="section" href="#EXAMPLES">EXAMPLES</A></H2><TABLE width="100%" border="0"><TR><TD align="right"><TABLE width="97%" border="0"><TR><TD>
206    <DIV><H3>The whole file is just an example.</H3></DIV>
207  </TD></TR><TR><TD> </TD></TR></TABLE></TD></TR></TABLE><H2 class="section" id="WARNINGS"><A class="section" href="#WARNINGS">WARNINGS</A></H2><TABLE width="100%" border="0"><TR><TD align="right"><TABLE width="97%" border="0"><TR><TD>
208    <DIV><H3>This text wont help you.</H3></DIV>
209    <DIV><H3>Even if i add more paragraphs here, it will not get more useful.</H3></DIV>
210  </TD></TR><TR><TD> </TD></TR></TABLE></TD></TR></TABLE><H2 class="section" id="BUGS"><A class="section" href="#BUGS">BUGS</A></H2><TABLE width="100%" border="0"><TR><TD align="right"><TABLE width="97%" border="0"><TR><TD>
211    <DIV><H3>will be detected by the unit test checking the files into which this file gets converted.</H3></DIV>
212  </TD></TR><TR><TD> </TD></TR></TABLE></TD></TR></TABLE></TD></TR></TABLE></BODY></HTML>
Note: See TracBrowser for help on using the repository browser.