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

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE PAGE SYSTEM 'arb_help.dtd' [
  <!ENTITY nbsp "&#160;">
  <!ENTITY acute "&#180;">
  <!ENTITY eacute "&#233;">
  <!ENTITY apostr "&#39;">
  <!ENTITY semi "&#59;">
]>

  <!--automatically generated from ../source/unittest.hlp -->
<PAGE name="unittest" edit_warning="devel" source="source/unittest.hlp">
  <UP dest="arb.hlp" type="hlp" source_line="2"/>
  <UP dest="glossary.hlp" type="hlp" source_line="3"/>
  <SUB dest="aci.hlp" type="hlp" source_line="6"/>
  <SUB dest="srt.hlp" type="hlp" source_line="160"/>
  <TITLE>Unittest example helpfile</TITLE>
  <SECTION name="OCCURRENCE">
    <P>
      <T reflow="1">
        nowhere</T>
    </P>
  </SECTION>
  <SECTION name="DESCRIPTION">
    <P>
      <T reflow="1">
        This is the first paragraph of the description.
        It may be continued on the next line.</T>
    </P>
    <P>
      <T reflow="1">
        Another paragraph
        also
        belonging to description. It is followed by
        an enumeration on the same indentation level:</T>
    </P>
    <ENUM>
      <ENTRY enumerated="1">
        <T reflow="1">
          first enum</T>
      </ENTRY>
      <ENTRY enumerated="2">
        <T reflow="1">
          second enum which
          is continued on the next line.
          Now this is no longer misinterpreted as monospaced paragraph.</T>
      </ENTRY>
      <ENTRY enumerated="3">
        <T reflow="1">
          third enum</T>
      </ENTRY>
    </ENUM>
    <P>
      <T reflow="1">
        Again a paragraph - a one liner followed by an item list. It is no longer misplaced now!</T>
    </P>
    <LIST>
      <ENTRY item="1">
        <T reflow="1">
          item 1</T>
      </ENTRY>
      <ENTRY item="1">
        <T reflow="1">
          item 2</T>
      </ENTRY>
      <ENTRY item="1">
        <T reflow="1">
          item 3
          contains 2 lines</T>
      </ENTRY>
    </LIST>
  </SECTION>
  <SECTION name="CUSTOM    A custom section.">
    <P>
      <T reflow="1">
        Acts like DESCRIPTION, despite the SECTION line will be part of the headline.
        In DESCRIPTION it would be part of the first paragraph.</T>
    </P>
    <P>
      <T reflow="1">
        First i need to check proper support for different
        indentation levels.</T>
      <P>
        <T reflow="1">
          This paragraph has to be indented one level deeper than
          the previous paragraph.</T>
      </P>
      <P>
        <T reflow="1">
          That paragraph should be on
          the same level.</T>
        <P>
          <T reflow="1">
            Here is another one, even deeper.</T>
        </P>
        <P>
          <T reflow="1">
            Same,
            same.</T>
        </P>
      </P>
      <P>
        <T reflow="1">
          Back one step.</T>
        <P>
          <T reflow="1">
            One step down - ignoring deeper
            indentation in source.</T>
        </P>
        <P>
          <T reflow="1">
            Consecutive paragraphs are only placed on the same
            level if their indentation matches.</T>
        </P>
        <P>
          <T reflow="1">
            Using the indentation level used 4 paragraphs above, wont help here.</T>
          <P>
            <T reflow="1">
              But the "wrong" indentation of the previous
              paragraph forces this paragraph to get indented one
              level deeper than the paragraphs before.</T>
          </P>
          <P>
            <T reflow="1">
              This does not step back.</T>
          </P>
          <P>
            <T reflow="1">
              same same.</T>
          </P>
        </P>
      </P>
    </P>
    <P>
      <T reflow="1">
        Back to top (end of indentation tests).</T>
    </P>
  </SECTION>
  <SECTION name="Wanted fixes">
    <P>
      <T reflow="1">
        Paragraphs containing multiple spaces will be
        treated as monospaced. This is done to support
        tabular information like the following:</T>
      <P>
        <T reflow="0">
                    other
        column      column
row     1           2
row2    -           3</T>
      </P>
    </P>
    <P>
      <T reflow="1">
        Problems occur if there are empty lines inside such a table, like here:</T>
      <P>
        <T reflow="0">
            other
column      column</T>
      </P>
      <P>
        <T reflow="0">
row     1           2
row2    -           3</T>
      </P>
      <P>
        <T reflow="1">
          (should better be combined)</T>
      </P>
    </P>
    <P>
      <T reflow="1">
        Here is an itemlist whose items are triggered by &apostr;*&apostr;:</T>
      <LIST>
        <ENTRY item="1">
          <T reflow="1">
            item1
            continued on next line</T>
        </ENTRY>
        <ENTRY item="1">
          <T reflow="1">
            item2</T>
        </ENTRY>
        <ENTRY item="1">
          <T reflow="1">
            item3</T>
        </ENTRY>
      </LIST>
    </P>
    <P>
      <T reflow="1">
        Itemlist containing paragraphs under some items</T>
      <LIST>
        <ENTRY item="1">
          <T reflow="1">
            item 1</T>
        </ENTRY>
        <ENTRY item="1">
          <T reflow="1">
            item 2</T>
          <P>
            <T reflow="1">
              This is a short
              description of item 2.
              This description gets indented below the corresponding item.</T>
          </P>
        </ENTRY>
        <ENTRY item="1">
          <T reflow="1">
            item 3</T>
          <P>
            <T reflow="1">
              This is a shorter description of item 3.</T>
          </P>
        </ENTRY>
      </LIST>
      <P>
        <T reflow="1">
          This is a paragraph which should
          be placed outside the itemlist.
          Currently this is misinterpreted as part of the itemlist.</T>
      </P>
    </P>
    <P>
      <T reflow="1">
        And this paragraph should be back where we were before
        the itemlist began.</T>
    </P>
    <P>
      <T reflow="1">
        Enumeration also work if using letters
        instead of digits. You can use capital letters as in
        the following enum</T>
    </P>
    <ENUM>
      <ENTRY enumerated="A">
        <T reflow="1">
          first enum</T>
      </ENTRY>
      <ENTRY enumerated="B">
        <T reflow="1">
          2nd enum</T>
      </ENTRY>
      <ENTRY enumerated="C">
        <T reflow="1">
          third enum</T>
      </ENTRY>
      <ENTRY enumerated="D">
        <T reflow="1">
          last enum</T>
      </ENTRY>
    </ENUM>
    <P>
      <T reflow="1">
        or small letters like here:</T>
      <ENUM>
        <ENTRY enumerated="a">
          <T reflow="1">
            first enum</T>
        </ENTRY>
        <ENTRY enumerated="b">
          <T reflow="1">
            2nd enum</T>
        </ENTRY>
        <ENTRY enumerated="c">
          <T reflow="1">
            third enum</T>
        </ENTRY>
        <ENTRY enumerated="d">
          <T reflow="1">
            last enum</T>
        </ENTRY>
      </ENUM>
    </P>
    <P>
      <T reflow="1">
        Check some "illegal" itemlists:</T>
      <P>
        <T reflow="1">
          ----------------------</T>
      </P>
      <P>
        <T reflow="1">
          -noitem</T>
      </P>
      <P>
        <T reflow="0">
-  eithernoitem</T>
      </P>
      <P>
        <T reflow="1">
          **********************</T>
      </P>
      <P>
        <T reflow="1">
          *noitem</T>
      </P>
      <P>
        <T reflow="0">
*  eithernoitem</T>
      </P>
    </P>
  </SECTION>
  <SECTION name="FEATURE TESTS">
    <P>
      <T reflow="1">
        Here all existing helpfile features should be tested:</T>
      <LIST>
        <ENTRY item="1">
          <T reflow="1">
            first testing an inlined
            link to another help file: <LINK dest="srt.hlp" type="hlp" source_line="160"/>
          </T>
        </ENTRY>
        <ENTRY item="1">
          <T reflow="1">
            and a link to the arb homepage
            <LINK dest="http://www.arb-home.de/" type="www" source_line="163"/>
            followed by text.
          </T>
        </ENTRY>
        <ENTRY item="1">
          <T reflow="1">
            arb help also supports mail-links (like <LINK dest="devel@arb-home.de" type="email" source_line="167"/>).
            All 3 sorts of links should be clickable in the html version.
          </T>
        </ENTRY>
      </LIST>
    </P>
  </SECTION>
  <SECTION name="NESTED LISTS">
    <P>
      <T reflow="1">
        text before enum</T>
    </P>
    <ENUM>
      <ENTRY enumerated="1">
        <T reflow="1">
          first enum</T>
        <P>
          <T reflow="1">
            text below first enum</T>
        </P>
        <LIST>
          <ENTRY item="1">
            <T reflow="1">
              first item below first enum</T>
          </ENTRY>
          <ENTRY item="1">
            <T reflow="1">
              second item below first enum</T>
            <ENUM>
              <ENTRY enumerated="1">
                <T reflow="1">
                  first subenum below second item</T>
                <LIST>
                  <ENTRY item="1">
                    <T reflow="1">
                      first item below first subenum</T>
                  </ENTRY>
                  <ENTRY item="1">
                    <T reflow="1">
                      second item below first subenum</T>
                  </ENTRY>
                </LIST>
              </ENTRY>
              <ENTRY enumerated="2">
                <T reflow="1">
                  second subenum below second item</T>
                <P>
                  <T reflow="1">
                    text before subsubenum</T>
                </P>
                <ENUM>
                  <ENTRY enumerated="1">
                    <T reflow="1">
                      first subsubenum below second subenum</T>
                  </ENTRY>
                  <ENTRY enumerated="2">
                    <T reflow="1">
                      second subsubenum below second subenum</T>
                  </ENTRY>
                </ENUM>
                <P>
                  <T reflow="1">
                    text behind subsubenum</T>
                </P>
              </ENTRY>
              <ENTRY enumerated="3">
                <T reflow="1">
                  third subenum below second item</T>
              </ENTRY>
            </ENUM>
          </ENTRY>
          <ENTRY item="1">
            <T reflow="1">
              third item below first enum</T>
          </ENTRY>
        </LIST>
      </ENTRY>
      <ENTRY enumerated="2">
        <T reflow="1">
          second enum</T>
        <P>
          <T reflow="1">
            This text is not indented more than the second enum,
            but is nevertheless interpreted as sub-elements which
            belongs to the enum.</T>
        </P>
      </ENTRY>
      <ENTRY enumerated="3">
        <T reflow="1">
          third enum</T>
        <P>
          <T reflow="1">
            behind the last enum, text only becomes a son
            of the enum-entry if it is indented.</T>
        </P>
      </ENTRY>
    </ENUM>
    <P>
      <T reflow="1">
        text behind enum</T>
    </P>
  </SECTION>
  <SECTION name="NOTES">
    <P>
      <T reflow="1">
        Note that this test may help me.</T>
    </P>
  </SECTION>
  <SECTION name="EXAMPLES">
    <P>
      <T reflow="1">
        The whole file is just an example.</T>
    </P>
  </SECTION>
  <SECTION name="WARNINGS">
    <P>
      <T reflow="1">
        This text wont help you.</T>
    </P>
    <P>
      <T reflow="1">
        Even if i add more paragraphs here,
        it will not get more useful.</T>
    </P>
  </SECTION>
  <SECTION name="BUGS">
    <P>
      <T reflow="1">
        will be detected by the unit test
        checking the files into which
        this file gets converted.</T>
    </P>
  </SECTION>
</PAGE>