{ HLPSTRUC.INC: Include file bij de Ramon unit voor het help systeem }

{==========================================================================}
{ (c) Copyright Waterline Software Developent V.O.F. 1990-1994             }
{                                                                          }
{    Waterline Software Development V.O.F.                                 }
{    Wouter Sluislaan 12                                                   }
{    1461 AC  Zuidoostbeemster                                             }
{    The Netherlands                                                       }
{                                                                          }
{ It not allowed to use this user interface in any program not owned by    }
{ the Waterline Software Development V.O.F.                                }
{ Special conditions apply to programs distributed by the Waterline        }
{ Software Development V.O.F. If the source code of any of these programs  }
{ is distributed as well, it is NOT allowed to use the user interface in   }
{ your own programs. Violators may be prosecuted!                          }
{                                                                          }
{ Please contact the Waterline Software Development V.O.F. at the above    }
{ address for your licence to use the "Ramon" user interface. You will get }
{ the most recent copy of the "Ramon" user interface and the "Ramon" user  }
{ interface expert for free. This program helps you design your user       }
{ interfaces at an instance.                                               }
{                                                                          }
{ This copyright notice should remain in this file and all files that are  }
{ part of the user interface "Ramon".                                      }
{==========================================================================}

{ structure of a .HLP file::

  +0..16 - Helpfile header text: "Online Help File"#26

  +17,18 - identification header: RH
  +19    - version number: 2
  +20-23 - CRC value (4 bytes)
  +24,n  - index voor alle define topics and subtopics:
           2 bytes: topic number (0=end of list, 1..65535)
           4 bytes: file-pos where topic starts

  +m,n   - help tekst, index via header
           4 bytes: length of the topic in bytes
           n bytes: topic text
               #13 = end of paragraph
               #255 = special code, followed by:
                 ccNormal   : back to normal text (is default from start)
                 ccTitle    : title text
                              ex: ...#255#2+'Title text'+#255#1...
                 ccHighLight: show highlighted
                              ex: ...#255#3+'Highlight this'+#255#1...
                 ccLink     : link field, followed by:
                              - topic reference (4 bytes)
                              - text
                              ex: ...#255#4#0#1#0#1+'link option'+#255#1...
}

CONST ccNormal       = #1;
      ccTitle        = #2;
      ccHighlight    = #3;
      ccLink         = #4;
      ccSearchResult = #5;
      ccSubTopic     = #6;  { start of a sub-topic }
      ccPrevious     = #7;  { used to terminated ccSearchResult only }

TYPE HelpHandleType = LONGINT;

     HelpIndexRecord = RECORD
                             TopicNr : HelpHandleType;
                             Offset  : LONGINT; { position in file }
                       END;

CONST HelpFilename : STRING[79] = '';  { ev. inclusief path }

VAR HlpFile : FILE;
    HlpCRC  : LONGINT; { expected CRC }

{ end of file hlpstruc.inc }
