Personal Computer World 1995 June/pcw-0695.iso/share/utils/edithelp/edithelp.edh

Text File | 1995-03-10 | 112.6 KB | 6,847 lines

Version 0121
Edit Help
true

205
0
9
0
30
0
0
20
0
1
0
0
MyWindow="My Window",(0,0,500,500,0),,(255,255,0),,1

EditHelp is copyright ⌐ Peter Balch 1994
sample.ico
2241
File|Open HLP
File|Open HLP
Open HLP
HLP files


1

0


Topic Text -----------------------------
The File|Open HLP command reads an existing HLP file and converts it into
the source format used by EditHelp.

The Open HLP command does not neccessarily create an EditHelp source which
can be {link=111,re-compiled} to give exactly the same HLP file - but it should be
close.

If you have already developed Help files using other tools, you can
use the Open HLP command to convert them into EditHelp format.

If the source file name is

      program.hlp

then the new source file will be

      program.edh

The topics are numbered sequentially from 1.

See also\
   {link=200,File|New}\
   {link=201,File|Open}\
   {link=202,File|Save}\
   {link=203,File|Save As}\
   {link=258,File|Project|New}\
   {link=2237,File|Project|Open}\
   {link=259,File|Project|Save}\
   {link=260,File|Project|SaveAs}\
   {link=2238,File|Project|Files}\
   {link=2239,File|Project|Move Topic}\
   {link=210,File|Save As TXT}\
   {link=246,File|Save As RTF}\
   {link=2229,File|Save As WWW}\
   {link=401,File|WWW Mode}\
   {link=2217,File|Open EXE}\
   {link=204,File|Exit}




\end

2240
Topic|Entry Command
Topic|Entry Command
Entry Command


0

0

PopupId(qchPath,"PG117")
Topic Text -----------------------------
If the Entry Command string is set to a Help Macro command, then the command
will be exectuted when the topic is displayed in the main or {link=2230,secondary} Help window.

Entry Commands are not run if the topic is displayed in a {link=116,Popup}.

Multiple commands can be separated by semicolons '{bold};{bold}'.

The command may be any {link=2225,Help Macro}. You can call a DLL by
executing the RegisterRoutine macro then calling the routine, for instance:

    {bold}{{}link=!RegisterRoutine("sample.dll","FUNC1","i"); FUNC1(1234)!,Call a DLL}

This topic has its Entry Command string set to:

    {bold}PopupId(qchPath,"PG117")

which displays topic 117 as a {link=116,popup} whenever the topic is displayed.
The {bold}qchPath{bold} {link=252,Predefined Variable} passes the name of the current {link=107,help file}
to the {link=2225,Help Macro}.

See also\
   {link=214,Topic|Next topic}\
   {link=215,Topic|Prev topic}\
   {link=227,Topic|Back}\
   {link=216,Topic|New topic}\
   {link=2202,Topic|Goto}\
   {link=228,Topic|Goto Unfinished}\
   {link=218,Topic|Delete}\
   {link=2201,Topic|Caption}\
   {link=220,Topic|Contents}\
   {link=2228,Topic|Browse}\
   {link=221,Topic|Status}\
   {link=253,Topic|Preview}\










\end

262
Internal Compiler
Internal Compiler
Compile


2

0


Topic Text -----------------------------
The Internal Help Compiler converts the current {link=107,source} into a {link=107,Help file.}

It is recommended that you use the {link=222,HelpFile|Make} command
which call an external {link=111,Help Compiler} such as Microsoft's
HC31. You may already have HC31.EXE on your computer.

The internal Help Compiler is quicker and more convenient than HC31.EXE
but the it is still under development.
Microsoft do not publish the specification of HLP files so the internal compiler is
"experimental". (Please report any bugs to Analogue Information Systems.)

Whether the External or Internal Compiler is used can be selected via the {link=2204,HelpFile|Directories}
dialog.

The internal Compiler does not support the following features:

    {link=251,Literal}\



\end

261
ALIAS.EPJ
ALIAS.EPJ
EPJ


0

0


Topic Text -----------------------------
Each topic must have a unique {link=105,Topic number.}
The number is used when the host program
calls the help system to display a help topic.

If you have written a program which must use context strings rather than context
numbers, you can use the ALIAS.EPJ file to add an [ALIAS]
section to the {link=243,Help Project File.}

The [ALIAS] section assigns one or more context strings to the same topic.
Normally, the [ALIAS] section of the {link=243,Help Project File} is empty.
If the file

    alias.epj

exists in the same directory as the EditHelp {link=107,source file}, then the text
of ALIAS.EPJ will be copied to the [ALIAS] section of the Help Project file.

The ALIAS.EPJ file should contain one or more lines with the format:

    {bold}context_string = alias

Where:

    {list=15}{bold}context_string    {bold}Specifies the context string that identifies a particular
within the HLP file topic.

    {bold}alias    {bold}Specifies the alternative string or alias name.

{list=0}An alias string is not case-sensitive and may
contain the alphabetic characters A through Z, the numeric characters 0
through 9, and the period and underscore characters.

The context string used within the HLP file is the {link=105,Topic number}
preceded by 'PG'. For instance, if the topic number is 261 then
the context string is

    {bold}PG261

So if your program displays topic 261 with the context string 'Shortcuts'
then ALIAS.EPJ should contain the line

    {bold}PG261 = Shortcuts


See also\
    {link=106,topics}\
    {link=105,Topic number}\
    {link=243,Help Project File}\














\end

260
File|Save Project As
File|Save Project As
Save Project As
Project


0

0


Topic Text -----------------------------
The File|Save Project As command saves the current {link=257,Project} to a new file.
The Save Project As dialog allows you to choose the name of the file.

{link=107,Project files} have the extension '.EHP'.

If any on the {link=107,source files} in the {link=257,Project} have been changed, you will be given the
opportunity to save them.

See also\
   {link=200,File|New}\
   {link=201,File|Open}\
   {link=202,File|Save}\
   {link=203,File|Save As}\
   {link=258,File|Project|New}\
   {link=2237,File|Project|Open}\
   {link=259,File|Project|Save}\
   {link=2238,File|Project|Files}\
   {link=2239,File|Project|Move Topic}\
   {link=210,File|Save As TXT}\
   {link=246,File|Save As RTF}\
   {link=2229,File|Save As WWW}\
   {link=2217,File|Open EXE}\
   {link=401,File|WWW Mode}\
   {link=204,File|Exit}

























\end

259
File|Save Project
File|Save Project
Save Project
Project


0

0


Topic Text -----------------------------
The File|Save Project command saves the current {link=257,Project.}
If the current {link=257,Project} is unnamed, you will be asked to choose the name of the file.

{link=107,Project files} have the extension '.EHP'.

All of the {link=107,source files} in the {link=257,Project} will also be saved.

See also\
   {link=200,File|New}\
   {link=201,File|Open}\
   {link=202,File|Save}\
   {link=203,File|Save As}\
   {link=258,File|Project|New}\
   {link=2237,File|Project|Open}\
   {link=260,File|Project|SaveAs}\
   {link=2238,File|Project|Files}\
   {link=2239,File|Project|Move Topic}\
   {link=210,File|Save As TXT}\
   {link=246,File|Save As RTF}\
   {link=2229,File|Save As WWW}\
   {link=2217,File|Open EXE}\
   {link=401,File|WWW Mode}\
   {link=204,File|Exit}














\end

258
File|New Project
File|New Project
New Project
Project


0

0


Topic Text -----------------------------
The File|New Project command starts a new {link=257,Project.}

A "Project" consists of a {link=107,Project file} and a set of {link=107,source files.}

To create a new project, open a {link=107,source file}, then select the {link=258,File|New Project}
command. The {link=107,source file} will be the first file in the new project.

You can then use the {link=2238,File|Project Files} command to add or remove other source files.

See also\
   {link=200,File|New}\
   {link=201,File|Open}\
   {link=202,File|Save}\
   {link=203,File|Save As}\
   {link=2237,File|Project|Open}\
   {link=259,File|Project|Save}\
   {link=260,File|Project|SaveAs}\
   {link=2238,File|Project|Files}\
   {link=2239,File|Project|Move Topic}\
   {link=210,File|Save As TXT}\
   {link=246,File|Save As RTF}\
   {link=2229,File|Save As WWW}\
   {link=2217,File|Open EXE}\
   {link=401,File|WWW Mode}\
   {link=204,File|Exit}














\end

257
Projects
Project


0

0


Topic Text -----------------------------
A "Project" consists of a {link=107,Project file} and a set of {link=107,source files.}

When the {link=222,HelpFile|Make} command is executed, all of the {link=107,source files} are
linked together to form a single {link=107,Help file.}

For small Help files, you will not need to use Projects. Use a Project when you want several
source files to be shared by several Help files: perhaps when you have different versions of
a program with different combinations of features.

To create a new project, open a {link=107,source file}, then select the {link=258,File|New Project}
command. The {link=107,source file} will be the first file in the new project.

You can then use the {link=2238,File|Project Files} command to add or remove other source files.
You may not have a Project which contains no {link=107,source files} nor include the same
{link=107,source file} twice.

The {link=107,source file} which the current {link=106,Topic} belongs to is shown at the bottom
of the main window.

You can move {link=106,Topics} from one Project source file to another with the
{link=2239,File|Move Topic} command. You may not move all the topics out of a source
file; it is illegal to have a source file with no {link=106,Topics.}

Save your project with the {link=259,File|Save Project} or {link=260,File|Save Project As}
command. You may open it again later with the {link=2237,File|Open Project} command.

Some of EditHelp options refer to individual {link=106,Topics} while some refer to the whole
{link=107,Help file.} When you open a {link=107,Project file}, the {link=107,Help file} options are read
from that file. If you add other {link=107,source files} to the project, the {link=107,Help file} options
in them are ignored.

If you are working with a Project, then when you save a {link=107,source file}, the
{link=107,Help file} options of the Project are saved with it.

The options which refer to the whole {link=107,Help file} include:

    {link=2203,Title}\
    {link=226,Compress flag}\
    {link=2204,Directories}\
    {link=2218,Font list}\
    {link=2235,Default fonts, sizes, etc.}\
    {link=2230,Secondary Window list}\
    {link=2226,Copyright notice}\
    {link=2227,Icon}\

The options which refer to an individual {link=106,Topic} include:

    {link=2201,Caption}\
    {link=2201,Topic number}\
    {link=2201,Keywords}\
    {link=220,Contents flag}\
    {link=221,Status}\
    {link=2228,Browse number}\














\end

2239
File|Move Topic
File|Move Topic
Move Topic
Project


0

0


Topic Text -----------------------------
The File|Move Topic command moves the current {link=106,Topic} to a
different {link=107,source file} within the {link=257,Project.}

The {link=107,source file} which the current {link=106,Topic} belongs to is shown at the bottom
of the main window.

You may not move all the topics out of a source
file; it is illegal to have a source file with no {link=106,Topics.}

See also\
   {link=200,File|New}\
   {link=201,File|Open}\
   {link=202,File|Save}\
   {link=203,File|Save As}\
   {link=258,File|Project|New}\
   {link=2237,File|Project|Open}\
   {link=259,File|Project|Save}\
   {link=260,File|Project|SaveAs}\
   {link=2238,File|Project|Files}\
   {link=210,File|Save As TXT}\
   {link=246,File|Save As RTF}\
   {link=2229,File|Save As WWW}\
   {link=2217,File|Open EXE}\
   {link=401,File|WWW Mode}\
   {link=204,File|Exit}














\end

2238
File|Project Files
File|Project Files
Project Files
Project


0

0


Topic Text -----------------------------
The Project Files command allows the user to add or remove {link=107,help source files}
from the current Project file.

The Add button opens an existing {link=107,help source file} that was created
using EditHelp and adds it to the list of files in the current Project.

The added file may contain {link=106,topics} with {link=105,numbers} which duplicate
topic numbers in the current files. If so,you are given the opportunity to renumber
the new topics either by hand or automatically (to arbitrary unique values).

See also\
   {link=200,File|New}\
   {link=201,File|Open}\
   {link=202,File|Save}\
   {link=203,File|Save As}\
   {link=258,File|Project|New}\
   {link=2237,File|Project|Open}\
   {link=259,File|Project|Save}\
   {link=260,File|Project|SaveAs}\
   {link=2239,File|Project|Move Topic}\
   {link=210,File|Save As TXT}\
   {link=246,File|Save As RTF}\
   {link=2229,File|Save As WWW}\
   {link=2217,File|Open EXE}\
   {link=401,File|WWW Mode}\
   {link=204,File|Exit}




















\end

2237
File|Open Project
File|Open Project
Open Project
Project


0

0


Topic Text -----------------------------
The Open Project command opens an existing Project file that was created
using EditHelp. Project files
have the extension '.EHP'.

The {link=107,help source files} specified by the Project file will also be opened.

See also\
   {link=200,File|New}\
   {link=201,File|Open}\
   {link=202,File|Save}\
   {link=203,File|Save As}\
   {link=258,File|Project|New}\
   {link=259,File|Project|Save}\
   {link=260,File|Project|SaveAs}\
   {link=2238,File|Project|Files}\
   {link=2239,File|Project|Move Topic}\
   {link=210,File|Save As TXT}\
   {link=246,File|Save As RTF}\
   {link=2229,File|Save As WWW}\
   {link=2217,File|Open EXE}\
   {link=401,File|WWW Mode}\
   {link=204,File|Exit}

























\end

255
Bulleted List
Bulleted List
List


0

0


Topic Text -----------------------------
A List {link=115,command} specifies that the following text should be shown
as a bulleted list:

    {{}list}

The following paragraphs are indented and each is preceded by a
'-' character. The List is terminated by:

    {{}list=0}

For instance:

    {{}list}a Bulleted List command specifies that the following text \
    should be shown in list format

    each paragraph is preceded by a bullet

    in a Definition List, each paragraph is divided into two columns separated by \
    'n' character widths.
    The first column shows the list item name, while the second \
    shows the item text

    {{}list=0}

is displayed as:

    {list}a Bulleted List command specifies that the following text
    should be shown in list format

    each paragraph is preceded by a bullet

    in a Definition List, each paragraph is divided into two columns separated by
    'n' character widths.
    The first column shows the list item name, while the second
    shows the item text

{list=0}The List command may only appear at the start of a {link=114,paragraph};
it may be {link=114,indented.}

See also\
    {link=254,Definition List}\














\end

254
Definition List
Definition List
List


0

0


Topic Text -----------------------------
A List=... {link=115,command} specifies that the following text should be shown
as a Definition list:

    {{}list=n}

where n is a non-zero number.

Each of the following paragraphs is divided into two columns separated by 'n'
character widths. The first column shows
the list item name, while the second shows the item text. The columns are separated by
a {link=2236,Tab} character.

The List is terminated by:

    {{}list=0}

For instance:

    {{}list=13}{{}bold}Key<tab>Function

    F1<tab>Calls the help system

    Alt<tab>Selects the menu

    {{}list=0}

{list=0}
(where <tab> is a Tab character). This is displayed as:

    {list=13}{bold}Key    Function

    F1    Calls the help system

    Alt    Selects the menu

{list=0}The List command may only appear at the start of a {link=114,paragraph};
it may be {link=114,indented.} If the item text is forced to
wrap, it will be aligned under the item text column.

{list=0}See also\
    {link=255,Bulleted List}\
    {link=240,Line command}\














\end

2235
Text|Defaults
Text|Defaults
Defaults


0

0


Topic Text -----------------------------
The Default Text command sets the default {link=2218,Font},
{link=2221,Size} and {link=2222,Colour} of the
{link=108,Caption} and text of the {link=106,Topic.}

If no default is specified, the text will be displayed as follows:

    {list=12}{line}{bold}Property    Default\
    Text font    0 (Arial}\
    Text colour    0 (black}\
    Text size    20 points\
    Caption font    0 (Arial}\
    Caption colour    0 (black}\
    Caption size    40 points\

See also\
    {link=2218,Text|Font Command}\
    {link=2221,Text|Size Command}\
    {link=231,Text|Bold Command}\
    {link=232,Text|Italic Command}\
    {link=2222,Text|Colour Command}\














\end

253
Topic|Preview
Topic|Preview
Preview


0

0


Topic Text -----------------------------
The Preview command shows the {link=106,Topic} as it will be displayed by Windows Help.

Certain features cannnot be displayed, such as {link=2233,Embedded Panes},
{link=251,Literal} text and {link=244,Segmented Graphics Files.}

The layout of the text and graphics may be a few pixels different from that displayed by
Windows Help. The {link=109,HelpFile|Make This Topic} and
{link=223,HelpFile|Test} commands will use Windows Help to display the topic.

See also\
   {link=214,Topic|Next topic}\
   {link=215,Topic|Prev topic}\
   {link=227,Topic|Back}\
   {link=216,Topic|New topic}\
   {link=2202,Topic|Goto}\
   {link=228,Topic|Goto Unfinished}\
   {link=218,Topic|Delete}\
   {link=2201,Topic|Caption}\
   {link=220,Topic|Contents}\
   {link=2228,Topic|Browse}\
   {link=221,Topic|Status}\
   {link=2240,Topic|Entry Command}\










\end

2234
Edit|DLL Call
Edit|DLL
DLL


0

0


Topic Text -----------------------------
A hotspot which calls a DLL
is specified in the source text by the DLL {link=115,command}:

    {{}dll=<dllname>,<funccall>,<text>)

where <dllname> is the name of the DLL file,
<funccall> is a call to a function exported by the DLL and
<text> is the hotspot text to be displayed.

The <funccall> string has the following format:

    <funcname>(<parameter>,<parameter>, ... )

<funcname> is the name of the function and each parameter has the format:

    <kind>:<value>

<kind> is a single character which represents the following <value> types:

      {list=10}{line}{bold}Character    Description\
      u    unsigned short (WORD,word) \
      U    unsigned long  (DWORD,longint) \
      i    int (INT,integer)\
      I    long (LONG,longint)\
      s    near char * (PSTR) \
      S    far char * (LPSTR,^string) \
      v    void \

{list=0}Windows Help makes sure the <value> part of the parameter
matches the <kind>.

For instance,

    {{}dll=sample.dll,FUNC1(i:1234),Call a DLL}

specifies that the function FUNC1 is exported by the DLL sample.dll.
It has a single Integer parameter which should be passed the value 1234.
The command is displayed as:

    {dll=sample.dll,FUNC1(i:1234),Call a DLL}

A DLL can also be specified in a {link=2219,Bitmap Link.} For instance:

    {{}dll=sample.dll,FUNC1(i:5678),bmp=sample1.bmp}

which is displayed as:

    {dll=sample.dll,FUNC1(i:5678),bmp=sample1.bmp}

The DLL filename should not contain any path information. The DLL file should be in
the same directory as the EDH {link=107,source file.}

Windows Help allows certain {link=252,Predefined Variables} as parameter values.

See also\
   {link=205,Edit|Undo}\
   {link=206,Edit|Cut}\
   {link=207,Edit|Copy}\
   {link=208,Edit|Paste}\
   {link=209,Edit|Delete}\
   {link=2207,Edit|Link}\
   {link=2215,Edit|Popup}\
   {link=2214,Edit|Bitmap}\
   {link=2233,Edit|Embedded Pane}\














\end

2233
Edit|Embedded Pane
Edit|Embedded Pane
Embedded Pane


2

0


Topic Text -----------------------------
An Embedded Pane
is specified in the source text by the Embed {link=115,command}:

    {{}embed=<dllname>,<windowClass>,<text>)

where <dllname> is the name of the DLL file,
<windowClass> is the name of a Window Class registered by the DLL and
<text> is the "author data" passed to the DLL during window creation.

For instance,

    {{}embed=test.dll,TestWnd,2)

specifies that the code for an embedded pane will be found in the DLL test.dll.
Windows Help should display a window of class "TestWnd" and pass it the string
"2".

The DLL filename should not contain any path information. The DLL file should be in
the same directory as the EDH {link=107,source file.}

Embedded panes can display custom information controlled by a DLL. For instance,
an embedded pane can show animation or play sound files.
The code for embedded panes is described in

    Microsoft Multimedia Viewer: Technical Reference\
    MM39685-0393

The embed command can take two other forms:

    {{}embed=left,test.dll,TestWnd,2)\
    {{}embed=right,test.dll,TestWnd,2)

An {{}embed=left,...} command means the paragraph text is wrapped to the right of the embedded pane.
An {{}embed=right,...} command means the text is wrapped to the left of the pane.

See also\
   {link=205,Edit|Undo}\
   {link=206,Edit|Cut}\
   {link=207,Edit|Copy}\
   {link=208,Edit|Paste}\
   {link=209,Edit|Delete}\
   {link=2207,Edit|Link}\
   {link=2215,Edit|Popup}\
   {link=2214,Edit|Bitmap}\
   {link=2234,Edit|DLL Call}\






\end

2232
Shareware
shareware
registration
unregistered


0

0


Topic Text -----------------------------
If this is an unregistered version of EditHelp then certain features will have been disabled.

EditHelp is Shareware, please copy and distribute it freely. Details of how to register it
can be found under the Help|Shareware command.

When you register, you will receive the latest version of EditHelp plus examples of
and DLLs for embedded-pane animation.
If other multimedia DLLs have been developed available they will be included as well.
Multimedia authoring tools are under development but they will cost extra.

You can optionally purchase a printed
manual which contains the same information as this Help file.

Please send your registration fee and any reports of bugs or suggestions for
improvements to:

          Analogue Information Systems Ltd.\
          1 Warrender Park Crescent\
          Edinburgh EH9 1DX\
          Scotland, UK\

Send a formatted floppy and a stamped-addressed-envelope
(whether you are registered or not) for
other Analogue shareware and freeware games, utilities and screensavers
which you may find of interest.


















\end

2230
Secondary Window
Secondary Window
Window


0

0


Topic Text -----------------------------
If the format of a {link=2207,Link} command is

    {{}link=num>winName,text}

where 'winName' is the specification of a Secondary Window, then the destination
{link=106,Topic} will be displayed in a separate window.
('num' is the {link=105,Topic number} of the destination and 'text'
is the link-text to be displayed.)

The specification of a Secondary Window has the format:

    winName = "caption", (x,y,w,h,flag), state, (cR,cG,cB), (nR,nG,nB), fTop

This defines the size, location, and colors for the secondary window:

      {list=12}{line}{bold}Parameter    Description\
      winName    the name of the window type; it may be any unique name of up to 8 characters\
      caption    the title for a secondary window\
      x,y,w,h    position and size of the window\
      flag    0:    x,y,w,h are in 'help units' (Windows Help assumes the screen is always 1024x1024 'help units')\
          1:    x,y,w,h are in pixels\
      state    0:    set the window to the size specified by x,y,w,h\
          1:    maximize the window\
          2:    minimize the window\
      cR,cG,cB    the background color of the window\
      nR,nG,nB    the background color of the non-scrolling region\
      fTop    0:    the secondary window behaves normally\
          1:    the secondary window is displayed on top of all other windows\

{list=0}Only the 'name', 'caption' and '(x,y,w,h,flag)' fields are mandatory.

For instance

      MyWindow="My Window",(0,0,500,500,0),,(255,255,0),,1

      {{}link=249>MyWindow,Secondary Window}

specifies that if the 'Secondary Window' link is selected,
the Secondary Window should appear in the top left corner of the
screen, have a yellow background and remain on top. Try it:

      {link=249>MyWindow,Secondary Window}

All of the specifications of Secondary Windows in the Secondary Window dialog
listbox will be copied to the [WINDOWS] section
of the {link=243,Help Project File.}

A {link=2219,Bitmap Link} can include a Secondary Window clause.
A {link=116,Popup Link} command should not include a Secondary Window clause.

If a Link command specifies both a Secondary Window and a {link=2231,New File},
the clauses should be in the order:

    {{}link=num@newFile>winName,text}














\end

2229
File|Save As WWW
File|Save As WWW
Save As WWW
WWW
HTML


0

0


Topic Text -----------------------------
The File|Save As WWW command saves the current source as
a HyperText Markup Language (HTML) file.
HTML can be used to represent Hypertext news, mail, online documentation, etc.
on the World Wide Web using a standard Internet protocol.

Each {link=106,topic} will be stored in a separate file. The topic with the {link=220,Contents}
flag set (if any) will be stored in the file

    <filename>.htm

where <filename> is the name of the current {link=107,help source file.}

The remaining topics will be stored the files with the name

    <fil><nnnnn>.htm

where <fil> is the first three characters of the {link=107,source file} name
and <nnnnn> is the {link=105,topic number} padded with '0' to 5 digits.
For instance, Topic 117 of the source 'edithelp.edh' will be written as:

    edi00117.htm

HTML does not support several features available in Windows Help files:

    {list=13}{link=2218,Fonts}    the command is ignored\
    {link=2221,Text size}    the command is ignored\
    {link=2222,Text colour}    the command is ignored\
    {link=2225,Help Macros}    treated as a {link=2207,Link}\
    {link=116,Popup Links}    treated as a {link=2207,Link}\
    {link=241,Boxed text}    a {link=240,Line} is drawn\
    {link=242,Centred text}    the command is ignored\
    {link=247,Keep}    the command is ignored\
    {link=2236,Tab=...}    the command is ignored\

{list=0}If your source file uses any of these features, a warning message
will be displayed but the HTML file will be written anyway.

A {link=2236,Tab} character will be translated into a single blank.

All {link=2224,Lists} will be displayed as simple bulleted lists.

If a {link=2214,Bitmap} or {link=2219,Bitmap Link} specifies a BMP (or {link=244,SHG}) file then
the 'bmp' (or 'shg') extension will be translated into 'gif'. So, for instance, the command:

    {{}bitmap=sample.bmp}

would be translated into an inline graphics element specifying

    sample.gif

You should make the GIF file available in the same directory as the HTML
files.
Some HTML browsers will not be able to display inline graphics. If the
graphic is essential, it may be wiser to make a link to it (by editing the
HTML file) rather than to put it inline.

See also\
   {link=200,File|New}\
   {link=201,File|Open}\
   {link=202,File|Save}\
   {link=203,File|Save As}\
   {link=258,File|Project|New}\
   {link=2237,File|Project|Open}\
   {link=259,File|Project|Save}\
   {link=260,File|Project|SaveAs}\
   {link=2238,File|Project|Files}\
   {link=2239,File|Project|Move Topic}\
   {link=210,File|Save As TXT}\
   {link=246,File|Save As RTF}\
   {link=2217,File|Open EXE}\
   {link=401,File|WWW Mode}\
   {link=204,File|Exit}














\end

244
Segmented Graphics Files
Segmented Graphics Files
SHG
hypergraphics
links


0

0


Topic Text -----------------------------
A {link=118,Bitmap} command may specify
a Segmented Graphics File (SHG) instead of a BMP file:

    {{}bitmap=<SHG filename>}

A Segmented Graphics File contains a bitmap that includes
one or more hotspots. For instance,

    {{}bitmap=sample.shg}

will be displayed as

    {bitmap=sample.shg}

The hotspots can be {link=2207,links} to other topics or {link=2225,Help Macro} commands.
In the example above, each icon is a hotspot. The Write, FileManager, Pbrush and
MS-DOS icons specify a {link=116,popup link} while the Notepad icon specifies a
{link=2225,Help Macro} which executes the Notepad program.

The SHG file should be in the same directory as
the {link=107,help source file.}  The <SHG filename> should not contain
any DOS path information.

You can create SHG files with the Microsoft Hotspot Editor

    SHED.EXE

SHED may have been supplied with your copy of Windows, or with your
Microsoft or Borland programming tools.

If you use SHED to create links, the topic context string for topic number 'nnn'
is 'PGnnn'. For instance, this is topic number 244, so the SHED context
string for a link to this topic is:

    PG244














\end

2228
Topic|Browse
Topic|Browse
Browse


0

2
TopicMenu

Topic Text -----------------------------
The Topic|Browse command sets the browse group name and number of the current topic.

A browse sequence typically consists of two or more related topics
that are intended to be read sequentially.
Each group has a browse Group Name and each topic in the
group has a different Sequence Number.

Windows Help adds topics with the same Group Name to the same browse group and
determines the order of topics in the group by sorting the Sequence Numbers.
If two topics in a group have the same number, Windows Help assumes
that the topic that was compiled first is to be displayed first.

If any topic belongs to a browse group, EditHelp will add browse buttons
to the button bar of Windows Help.

If the Group Name of a topic is empty then the topic does not belong to any browse group.

The browse name and number of the current topic are shown in the top right
corner of the main window.

For instance, the Group Name of this topic and all the other topics describing the
'Topic' popup menu have been set to

      TopicMenu

and the Sequence Numbers have been set to 1,2,3...

See also\
   {link=214,Topic|Next topic}\
   {link=215,Topic|Prev topic}\
   {link=227,Topic|Back}\
   {link=216,Topic|New topic}\
   {link=2202,Topic|Goto}\
   {link=228,Topic|Goto Unfinished}\
   {link=218,Topic|Delete}\
   {link=2201,Topic|Caption}\
   {link=220,Topic|Contents}\
   {link=221,Topic|Status}\
   {link=2240,Topic|Entry Command}\
   {link=253,Topic|Preview}\










\end

2227
HelpFile|Icon
HelpFile|Icon
Icon


0

0


Topic Text -----------------------------
The HelpFile|Icon command allows you to specify the name of an icon (.ICO) file.

The icon will be displayed when the {link=107,Help file} is minimised.

The filename should not contain any path information. The icon file should be in
the same directory as the EDH {link=107,source file.}

For instance, if the Icon filename is set to 'sample.ico' then the following icon
will be displayed when the Help file is minimised:

    {bitmap=sample3.bmp}

If the Icon filename is set blank then the default Windows Help icon will be displayed.

See also\
   {link=222,HelpFile|Make}\
   {link=223,HelpFile|Test}\
   {link=109,HelpFile|Make This Topic}\
   {link=2204,HelpFile|Directories}\
   {link=2203,HelpFile|Title}\
   {link=226,HelpFile|Compress}\
   {link=2226,HelpFile|Copyright}\
   {link=2205,HelpFile|Status}\
   {link=2211,HelpFile|Keywords}














\end

2226
HelpFile|Copyright
HelpFile|Copyright
Copyright


0

0


Topic Text -----------------------------
The HelpFile|Copyright command allows you to specify an additional copyright notice
which will appear in the Windows Help {link='About()',About} box.

See also\
   {link=222,HelpFile|Make}\
   {link=223,HelpFile|Test}\
   {link=109,HelpFile|Make This Topic}\
   {link=2204,HelpFile|Directories}\
   {link=2203,HelpFile|Title}\
   {link=226,HelpFile|Compress}\
   {link=2227,HelpFile|Icon}\
   {link=2205,HelpFile|Status}\
   {link=2211,HelpFile|Keywords}




































































\end

2225
Help Macros
Help Macros
macros


0

0


Topic Text -----------------------------
Help Macros are commands sent to to the Windows Help system. For instance:

  {{}link='About()',Display About Box}

calls the About macro when the hotspot is selected:

  {link='About()',Display About Box}

A {{}link=...} may contain several macros separated by semi-colons.

You may add new commands contained in your own DLLs by calling the
RegisterRoutine macro. For instance, this command contains two macros, the first registers
the FUNC1 routine in the sample.dll DLL and the second calls it and passes the integer
value 1234:

  {{}link=!RegisterRoutine("sample.dll","FUNC1","i");FUNC1(1234)!,Call a DLL}

Selecting  the hotspot calls the DLL:

  {link=!RegisterRoutine("sample.dll","FUNC1","i");FUNC1(1234)!,Call a DLL}

A macro can also be specified in a {link=2219,Bitmap Link.} For instance:

    {{}link='ExecProgram("calc.exe",0)',bmp=sample2.bmp}

selecting this bitmap will execute the Calculator program supplied with Windows:

    {link='ExecProgram("calc.exe",0)',bmp=sample2.bmp}

The Windows Help system supports the following macros:

    {line}{list=20}{bold}Macro    Function\
    About    Displays the About dialog box\
    AddAccelerator    Assigns a macro to an accelerator key\
    Annotate    Displays Annotation dialog box\
    AppendItem    Appends a menu item\
    Back    Displays previous topic in the history list\
    BookmarkDefine    Displays the Define dialog box\
    BookmarkMore    Displays the More dialog box\
    BrowseButtons    Adds browse buttons\
    ChangeButtonBinding    Assigns a macro to a button\

    ChangeItemBinding    Assigns a macro to a menu item\
    CheckItem    Checks a menu item\
    CloseWindow    Closes a window\
    Contents    Displays the Contents topic\
    CopyDialog    Displays the Copy dialog box\
    CopyTopic    Copies current topic to the clipboard\
    CreateButton    Adds a new button to the button bar\
    DeleteItem    Removes a menu item\
    DeleteMark    Deletes a text marker\

    DestroyButton    Removes a button from the button bar\
    DisableButton    Disables a button\
    DisableItem    Disables a menu item\
    EnableButton    Enables a button\
    EnableItem    Enables a menu item\
    ExecProgram    Executes a program\
    Exit    Exits WinHelp\
    FileOpen    Displays the Open dialog box\
    FocusWindow    Changes the focus window\
    GoToMark    Jumps to a marker\

    HelpOn    Displays the Help on Using topic\
    HelpOnTop    Toggles on-top state of help\
    History    Displays the history list\
    IfThen    Executes macro if marker exists\
    IfThenElse    Executes one of two macros if marker exists\
    InsertItem    Inserts a menu item\
    InsertMenu    Inserts a new menu\
    IsMark    Tests if a marker is set\
    JumpContents    Jumps to the Contents topic\

    JumpContext    Jumps to the specified context\
    JumpHelpOn    Jumps to Using Help file\
    JumpId    Jumps to the specified topic\
    JumpKeyword    Jumps to the topic containing the keyword\
    Next    Displays the next topic in the browse sequence\
    Not    Reverses the IsMark macro\
    PopupContext    Displays a topic in a popup window\
    PopupId    Displays topic in a popup window\
    PositionWindow    Sets the size and position of a window\

    Prev    Displays previous topic in browse sequence\
    Print    Prints the current topic\
    PrinterSetup    Displays the Printer Setup dialog box\
    RegisterRoutine    Registers a DLL function\
    RemoveAccelerator    Assigns a macro to an accelerator key\
    SaveMark    Saves a marker\
    Search    Displays the Search dialog box\
    SetContents    Sets the Contents topic\
    SetHelpOnFile    Sets the Using Help help file\

    UncheckItem    Unchecks a menu item\














\end

2222
Text|Colour
Text|Colour
colour


0

0


Topic Text -----------------------------
The Colour {link=115,command} specifies that subsequent text is shown
in the specified colour:

    {{}colour=n}

where 'n' is the colour number.

The following colours are available on a 16-colour display:

    {colour=1}{{}colour=1}  blue\
    {colour=2}{{}colour=2}  cyan\
    {colour=3}{{}colour=3}  green\
    {colour=4}{{}colour=4}  magenta\
    {colour=5}{{}colour=5}  red\
    {colour=6}{{}colour=6}  yellow\
    {colour=7}{{}colour=7}  white\
    {colour=8}{{}colour=8}  dark blue\
    {colour=9}{{}colour=9}  dark cyan\
    {colour=10}{{}colour=10}  dark green\
    {colour=11}{{}colour=11}  dark magenta\
    {colour=12}{{}colour=12}  dark red\
    {colour=13}{{}colour=13}  dark yellow\
    {colour=14}{{}colour=14}  dark grey\
    {colour=15}{{}colour=15}  grey{colour=0}\

See also\
    {link=2218,Text|Font Command}\
    {link=2221,Text|Size Command}\
    {link=232,Text|Italic Command}\
    {link=231,Text|Bold Command}\
    {link=2235,Text|Defaults}\










































\end

242
Layout|Centre
Layout|Centre
centre


0

0


Topic Text -----------------------------
A Centre {link=115,command} specifies that the remaining text of the paragraph
should be centered in the screen. For instance:

    {{}centre}This text is centred

is shown as:

    {centre}This text is centred

The Centre command must appear before any of the text of a paragraph.

The Centre command may be combined with the {link=241,Box} command:

{{}centre}{{}box}This is boxed and centred

is displayed as

{centre}{box}This is boxed and centred

See also\
    {link=2220,Layout|Heading}\
    {link=2224,Layout|List}\
    {link=240,Layout|Line}\
    {link=241,Layout|Box}\
    {link=2236,Layout|Tab}\
    {link=247,Layout|Keep}\

































\end

241
Layout|Box
Layout|Box
box


0

0


Topic Text -----------------------------
A Box {link=115,command} specifies that a box should be drawn
around the remaining text of the paragraph. For instance:

    {{}box}This text is in a box

is shown as:

    {box}This text is in a box

The box command must appear before any of the text of a paragraph.
It may be indented, as in the above example.

See also\
    {link=2220,Layout|Heading}\
    {link=2224,Layout|List}\
    {link=240,Layout|Line}\
    {link=242,Layout|Centre}\
    {link=2236,Layout|Tab}\
    {link=247,Layout|Keep}\

































\end

240
Layout|Line
Layout|Line
line


0

0


Topic Text -----------------------------
A Line {link=115,command} specifies that a line should be drawn across the screen. For
instance:

    {{}line}

is shown as:

    {line}

If the Line command is followed by text, the text is displayed immediately above
the line:

    {{}line}This is text

is shown as:

    {line}This is text

The Line command may only appear before the text of a {link=114,paragraph.}
The Line command  may be {link=114,indented.}

Both Line and List commands can be used together. For instance:

    {{}list=15}{{}line}{{}bold}Key<tab>Function{{}bold}

    F1<tab>Calls the help system

    Alt<tab>Selects the menu

{list=0}(where <tab> is a {link=2236,Tab} character). This is displayed as:

    {list=10}{line}{bold}Key    Function{bold}

    F1    Calls the help system

    Alt    Selects the menu

{list=0}See also\
    {link=2220,Layout|Heading}\
    {link=2224,Layout|List}\
    {link=241,Layout|Box}\
    {link=242,Layout|Centre}\
    {link=2236,Layout|Tab}\
    {link=247,Layout|Keep}\














\end

2224
Layout|List
Layout|List
list


0

0


Topic Text -----------------------------
A List {link=115,command} specifies that the following text should be shown in list format.

There are three formats for the list command:

    {list=13}{line}{bold}Command    Description

    {{}list}    start a {link=255,Bulleted List}

    {{}list=n}    start a {link=254,Definition List}

    {{}list=0}    end a list

{list=0}See also\
    {link=2220,Layout|Heading}\
    {link=240,Layout|Line}\
    {link=241,Layout|Box}\
    {link=242,Layout|Centre}\
    {link=2236,Layout|Tab}\
    {link=247,Layout|Keep}\

































\end

2220
Layout|Heading
Layout|Heading
heading


0

0


Topic Text -----------------------------
A sub-heading is specified by the Heading {link=115,command}:

    {{}heading=<text>}

where <text> is the text of the heading.

For instance, the following command:

{{}heading=Sub-heading}

will be displayed as

{heading=Sub-heading}

The Layout|Heading command inserts a Heading into the text of the current topic
at the current insertion point.

You can also type in a Heading {link=115,command} "by hand".

See also\
    {link=115,Text commands}\
    {link=2224,Layout|List}\
    {link=240,Layout|Line}\
    {link=241,Layout|Box}\
    {link=242,Layout|Centre}\
    {link=2236,Layout|Tab}\
    {link=247,Layout|Keep}\

































\end

2219
Edit|Bitmap Link
Edit|Bitmap Link
bitmap
links


0

0


Topic Text -----------------------------
A bitmap link is specified in the source text by the Link {link=115,command}:

    {{}link=<num>,bmp=<filename>}

where <num> is the {link=105,Topic number} of the destination and <filename>
is a file containing the bitmap to be displayed.

For instance, the Edit|Link topic is 2207 so a bitmap-link to that topic could be
specified as

    {{}link=2207,bmp=sample1.bmp}

which would display as

    {link=2207,bmp=sample1.bmp}

When the user selects the bitmap, the destination topic is displayed.

As in this example: {link=2207,bmp=sample1.bmp} a bitmap-link can also
appear in the middle of text.

A bitmap-link can specify that the destination topic is to be displayed as a popup.
For instance

    {{}popup=117,bmp=sample1.bmp}

would be displayed as

    {popup=117,bmp=sample1.bmp}

The bitmap filename should not contain any path information. The bitmap file should be in
the same directory as the EDH {link=107,source file.}

A link can specify that the destination topic should be displayed in a
{link=2230,Secondary Window} or that a {link=2231,New File} should be loaded.


See also\
   {link=205,Edit|Undo}\
   {link=206,Edit|Cut}\
   {link=207,Edit|Copy}\
   {link=208,Edit|Paste}\
   {link=209,Edit|Delete}\
   {link=2207,Edit|Link}\
   {link=2215,Edit|Popup}\
   {link=2214,Edit|Bitmap}\
   {link=2234,Edit|DLL Call}\
   {link=2233,Edit|Embedded Pane}\














\end

2217
File|Open EXE
Open EXE


0

0


Topic Text -----------------------------
The File|Open EXE command reads an exe file and examines the menu
and dialog resources of the file. From these, it creates a corresponding
skeleton {link=107,EDH source file} with one topic for each menu item and
dialog box.

If the source file name is

      program.exe

then the new source file will be

      program.edh

The topics corresponding with menu items are numbered

      10000 + id

where 'id' is the id-number of the menu item.

The topics corresponding with dialogs are numbered sequentially from 1 except
that if the dialog has a button labelled 'Help' then the topic is given the same
topic number as the button id-number.

See also\
   {link=200,File|New}\
   {link=201,File|Open}\
   {link=202,File|Save}\
   {link=203,File|Save As}\
   {link=258,File|Project|New}\
   {link=2237,File|Project|Open}\
   {link=259,File|Project|Save}\
   {link=260,File|Project|SaveAs}\
   {link=2238,File|Project|Files}\
   {link=2239,File|Project|Move Topic}\
   {link=210,File|Save As TXT}\
   {link=246,File|Save As RTF}\
   {link=2229,File|Save As WWW}\
   {link=401,File|WWW Mode}\
   {link=204,File|Exit}




























\end

232
Text|Italic
Text|Italic
fonts
italic


0

0


Topic Text -----------------------------
The Text|Italic command sets whether subsequent text will be displayed italic or normal.

    {{}italic}

The {{}italic} {link=115,command} toggles between italic and normal characters.
For instance:

    Ordinary text and {{}italic}italic text and back to {{}italic}ordinary text

is displayed as:

    Ordinary text and {italic}italic text and back to {italic}ordinary text

Every paragraph starts with the text normal (not italic).

See also\
    {link=2218,Text|Font Command}\
    {link=2221,Text|Size Command}\
    {link=231,Text|Bold Command}\
    {link=2222,Text|Colour Command}\
    {link=2235,Text|Defaults}\













































\end

231
Text|Bold
Text|Bold
fonts
bold


0

0


Topic Text -----------------------------
The Text|Bold command sets whether subsequent text will be displayed bold or normal width.

    {{}bold}

The {{}bold} {link=115,command} toggles between bold and normal width characters.
For instance:

    Ordinary text and {{}bold}bold text and back to {{}bold}ordinary text

is displayed as:

    Ordinary text and {bold}bold text and back to {bold}ordinary text

Every paragraph starts with the text normal width.

See also\
    {link=2218,Text|Font Command}\
    {link=2221,Text|Size Command}\
    {link=232,Text|Italic Command}\
    {link=2222,Text|Colour Command}\
    {link=2235,Text|Defaults}\













































\end

2221
Text|Size
Text|Size
fonts
size


0

0


Topic Text -----------------------------
The Text|Size {link=115,command} sets the size of the font to be used for subsequent text.

    {{}fontsize=n}

where 'n' is the character size; the default characted size is 20. For instance:

    This is {{}fontsize=50}very large{{}fontsize=20} text

is displayed as:

    This is {fontsize=50}very large{fontsize=20} text

Not all character sizes are displayed well with all fonts

See also\
    {link=2218,Text|Font Command}\
    {link=231,Text|Bold Command}\
    {link=232,Text|Italic Command}\
    {link=2222,Text|Colour Command}\
    {link=2235,Text|Defaults}\













































\end

2218
Text|Font
Text|Font
fonts


0

0


Topic Text -----------------------------
The Text|Font {link=115,command} sets the font to be used for subsequent text.

    {{}font=n}

where 'n' is the font number. For instance:

    {{}font=6}}This is script font{{}font=0}

is displayed as:

    {font=6}This is script font{font=0}

The Text|Font command provides the following font options as standard:

    {list=10}{font=0}{{}font=0}    {font=0}Arial: modern\
    {font=0}{{}font=1}    {font=1}Courier New: modern\
    {font=0}{{}font=2}    {font=2}Modern: modern\
    {font=0}{{}font=3}    {font=3}MS Sans Serif: swiss\
    {font=0}{{}font=4}    {font=4}MS Serif: swiss\
    {font=0}{{}font=5}    {font=5}Roman: roman\
    {font=0}{{}font=6}    {font=6}Brush Script: script\
    {font=0}{{}font=7}    {font=7}{fontsize=12}Small Fonts: decor{fontsize=20}\
    {font=0}{{}font=8}    {font=8}Symbol: roman  {font=0}(Symbol)\
    {font=0}{{}font=9}    {font=9}Times New Roman: roman\

{font=0}Not all these fonts may be present on your computer.

You may add other font options by typing into the font Combo-box. The format of the
font string should be:

      <font name>:<font family>

If the specified font is not present, Windows Help will select another font from the
same family.

There may not be more than 100 fonts.

See also\
    {link=2221,Text|Size Command}\
    {link=231,Text|Bold Command}\
    {link=232,Text|Italic Command}\
    {link=2222,Text|Colour Command}
    {link=2235,Text|Defaults}\



















\end

2208
Search|Replace with Link
Search|Replace with Link
Replace with Link
Links


0

0


Topic Text -----------------------------
The Search|Replace with Link command searches for and changes text in
into a {link=2207,Link.}

The Replace with Link command will not replace text which is
inside a {{}link=...} or any other {link=115,command.}
Nor will it replace text which is in the same {link=106,topic} as the
destination of the link.

During the search, you can match uppercase and lowercase letters or
ignore case.

If the 'all occurrences' box is checked then all the occurrences of the
search string will be replaced in the current topic.

If you select the 'All Topics' button then the search will start with the first topic
in the topic list and will be extended to all the topics in the list.
If the 'all occurrences' box is checked then all the occurrences of the
search string will be replaced in all topics.
If the 'all occurrences' box is not checked then only the first occurrence
to be found will be replaced.

See also\
   {link=2210,Search|Find}\
   {link=2209,Search|Replace}\
   {link=213,Search|Next}\
   {link=2213,Search|Find Error}














\end

227
Topic|Back
Topic|Back
Back


0

1
TopicMenu

Topic Text -----------------------------
The Topic|Back command re-displays the last {link=106,topic} to be shown.

The Topic|Back command can be called with the Ctrl-B key.

See also\
   {link=214,Topic|Next topic}\
   {link=215,Topic|Prev topic}\
   {link=216,Topic|New topic}\
   {link=2202,Topic|Goto}\
   {link=228,Topic|Goto Unfinished}\
   {link=218,Topic|Delete}\
   {link=2201,Topic|Caption}\
   {link=220,Topic|Contents}\
   {link=2228,Topic|Browse}\
   {link=221,Topic|Status}\
   {link=2240,Topic|Entry Command}\
   {link=253,Topic|Preview}\










\end

118
Bitmaps
bitmaps


2

0


Topic Text -----------------------------
A {link=118,Bitmap} is specified by the Bitmap {link=115,command}:

    {{}bitmap=<filename>}

where <filename> is the name of a BMP file to be displayed.

The bitmap should be a standard windows .BMP file in the same directory as
the {link=107,help source file.}  The <filename> should not contain
any DOS path information.

For instance, the following command:

    {{}bitmap=sample.bmp}

will be displayed as

    {bitmap=sample.bmp}

The help system will display coloured bitmaps but you may find it best to
use monochrome bitmaps. They are smaller and can be displayed on any hardware.

You may also specify a {link=244,Segmented Graphics File} (SHG) instead of a BMP bitmap.
A Segmented Graphics File contains a bitmap that includes
one or more hotspots.
The hotspots can be {link=2207,links} to other topics or {link=2225,Help Macro} commands.

A small {link=256,selection of bitmaps} are supplied with EditHelp.

Bitmaps can be used in a variety of ways:

{list=4}    A bitmap can be embedded in the text {bitmap=arrow.bmp} as with
            this arrow\
{bitmap=point1.bmp}    You can use bitmaps to highlight paragraphs of text

    Or you can simulate a Browse sequence with the
                       'Previous' and 'Next' buttons:

{list=0}{link=118,bmp=btnprev.bmp}{link=2219,bmp=btnnext.bmp}

The bitmap command can take two other forms:

    {{}bitmap=left,sample3.bmp} \
    {{}bitmap=right,sample3.bmp}

{bitmap=left,sample3.bmp}A {{}bitmap=left,...} command means
the paragraph text is wrapped to the right of the bitmap.

{bitmap=right,sample3.bmp}A {{}bitmap=right,...} command means
the paragraph text is wrapped to the left of the bitmap.

See also\
    {link=115,Text Commands}\
    {link=2214,Edit|Bitmap}






\end

117




0

0


Topic Text -----------------------------
This is a popup topic. It will remain on the screen until you click the mouse
or press a key.

The {link=108,caption} of a popup can be left blank.




































































\end

116
Popup Link
popup link
links


0

0


Topic Text -----------------------------
A popup link is specified in the source text by the Popup {link=115,command}:

    {{}popup=<num>,<text>}

where <num> is the {link=105,Topic number} of the destination and <text>
is the link-text to be displayed.

For instance, the popup topic is 117 so a link to the popup topic would be
specified as

    {{}popup=117,Popup Topic}

which would display as

    {popup=117,Popup Topic}

When the user selects the popup link, the destination topic is displayed in
a separate window.

A {link=2219,bitmap} can be used as a button which displays the new popup topic.

See also\
    {link=2207,Links}\
    {link=2215,Edit|Popup}




































































\end

110
Menu Commands
menu commands
commands
toolbar


2

0


Topic Text -----------------------------
The following menu commands are available:

   {list=7}{fontsize=25}{bold}File{fontsize=20}{bold}\
       {link=200,New}\
   {link=201,bmp=tool1.bmp}    {link=201,Open}\
       {link=202,Save}\
       {link=203,Save As}\
       Project\
           {link=258,New}\
           {link=2237,Open}\
           {link=259,Save}\
           {link=260,SaveAs}\
           {link=2238,Files}\
           {link=2239,Move Topic}\
       {link=210,Save As TXT}\
       {link=246,Save As RTF}\
       {link=2229,Save As WWW}\
       {link=2217,Open EXE}\
       {link=2241,Open HLP}\
       {link=401,WWW Mode}\
       {link=204,Exit}

   {fontsize=25}{bold}Edit{fontsize=20}\
       {link=205,Undo}\
       {link=206,Cut}\
       {link=207,Copy}\
       {link=208,Paste}\
       {link=209,Delete}\
   {link=2207,bmp=tool2.bmp}    {link=2207,Link}\
   {link=2215,bmp=tool3.bmp}    {link=2215,Popup Link}\
   {link=2214,bmp=tool4.bmp}    {link=2214,Bitmap}\
       {link=2219,Bitmap Link}\
       {link=2234,DLL Call}\
       {link=2233,Embedded Pane}\

   {fontsize=25}{bold}Search{fontsize=20}\
       {link=2210,Find}\
       {link=2209,Replace}\
       {link=2208,Replace with Link}\
       {link=213,Next}\
       {link=2213,Find Error}\

   {fontsize=25}{bold}Layout{fontsize=20}\
   {link=2220,bmp=tool5.bmp}    {link=2220,Heading}\
       {link=2224,List}\
       {link=240,Line}\
       {link=241,Box}\
       {link=242,Centre}\
       {link=2236,Tab}\
       {link=247,Keep}\

   {fontsize=25}{bold}Text{fontsize=20}\
       {link=2218,Font}\
       {link=2221,Size}\
       {link=231,Bold}\
       {link=232,Italic}\
       {link=2222,Colour}\

   {fontsize=25}{bold}Topic{fontsize=20}\
       {link=214,Next topic}\
       {link=215,Prev topic}\
       {link=227,Back}\
   {link=216,bmp=tool10.bmp}    {link=216,New topic}\
   {link=2202,bmp=tool6.bmp}    {link=2202,Goto}\
       {link=228,Goto Unfinished}\
       {link=218,Delete}\
       {link=2201,Caption}\
       {link=220,Contents}\
       {link=2228,Browse}\
       {link=221,Status}\
       {link=2240,Entry Command}\
   {link=253,bmp=tool7.bmp}    {link=253,Preview}\

   {fontsize=25}{bold}HelpFile{fontsize=20}\
   {link=222,bmp=tool8.bmp}    {link=222,Make}\
   {link=223,bmp=tool9.bmp}    {link=223,Test}\
       {link=109,Make This Topic}\
       {link=2204,Directories}\
       {link=2203,Title}\
       {link=226,Compress}\
       {link=2226,Copyright}\
       {link=2227,Icon}\
       {link=2205,Status}\
       {link=2211,Keywords}




\end

2205
HelpFile|Status
HelpFile|Status
Status


0

0


Topic Text -----------------------------
The HelpFile|Status command displays the Project Status dialog. This shows the
{link=105,Topic number}, {link=108,Caption}, {link=103,Keywords} and
{link=221,Status} of each topic.

The Project Status dialog helps you keep track of how far you've got in developing
your Help File.

You may add a short note to each topic to remind you what to do next.

See also\
   {link=228,Topic|Goto Unfinished}\
   {link=221,Topic|Status}

   {link=222,HelpFile|Make}\
   {link=223,HelpFile|Test}\
   {link=109,HelpFile|Make This Topic}\
   {link=2204,HelpFile|Directories}\
   {link=2203,HelpFile|Title}\
   {link=226,HelpFile|Compress}\
   {link=2226,HelpFile|Copyright}\
   {link=2227,HelpFile|Icon}\
   {link=2211,HelpFile|Keywords}\
   {link=253,Topic|Preview}\













































\end

226
HelpFile|Compress
HelpFile|Compress
Compress


2

0


Topic Text -----------------------------
The HelpFile|Compress command toggles whether the {link=111,Help Compiler}
should compress your {link=107,Help File.}

The Help Compiler takes longer to compile your file if compression is switched
on but the resulting Help File is smaller.

The {link=262,Internal Compiler} does not produce a compressed file. (Certain of the
compression techniques have been patented by Microsoft.)

See also\
   {link=222,HelpFile|Make}\
   {link=223,HelpFile|Test}\
   {link=109,HelpFile|Make This Topic}\
   {link=2204,HelpFile|Directories}\
   {link=2203,HelpFile|Title}\
   {link=2205,HelpFile|Status}\
   {link=2226,HelpFile|Copyright}\
   {link=2227,HelpFile|Icon}\
   {link=2211,HelpFile|Keywords}




\end

2203
HelpFile|Title
HelpFile|Title
Title


0

0


Topic Text -----------------------------
The HelpFile|Title command allows you to specify the title of the {link=107,Help File.}

The title is shown on the caption bar of the main window when
the Help System displays your help file.

See also\
   {link=222,HelpFile|Make}\
   {link=223,HelpFile|Test}\
   {link=109,HelpFile|Make This Topic}\
   {link=2204,HelpFile|Directories}\
   {link=226,HelpFile|Compress}\
   {link=2226,HelpFile|Copyright}\
   {link=2227,HelpFile|Icon}\
   {link=2205,HelpFile|Status}\
   {link=2211,HelpFile|Keywords}














\end

2204
HelpFile|Directories
HelpFile|Directories
Directories


2

0


Topic Text -----------------------------
The HelpFile|Directories command allows you to specify the directory into which the
Help (.HLP) File will be copied and to specify whether the {link=262,Internal Compiler} or an
External {link=111,Help Compiler} should be used.

The {link=107,help source file} is always in the current directory but the {link=107,Help File} may be placed in
any directory. Usually, the help source file will be in same directory as the source
of the program you are writing while the Help File will be in same directory as your
EXE file.

The External Compiler text box should contain the full path name and program EXE name of
your help compiler.

See also\
   {link=222,HelpFile|Make}\
   {link=223,HelpFile|Test}\
   {link=109,HelpFile|Make This Topic}\
   {link=2203,HelpFile|Title}\
   {link=226,HelpFile|Compress}\
   {link=2226,HelpFile|Copyright}\
   {link=2227,HelpFile|Icon}\
   {link=2205,HelpFile|Status}\
   {link=2211,HelpFile|Keywords}




\end

223
HelpFile|Test
HelpFile|Test
Test


0

0


Topic Text -----------------------------
The HelpFile|Test command calls the Help System to display the current topic of the
current {link=107,Help File.}

You should have compiled the current {link=107,source} by calling the {link=222,HelpFile|Make}
command before calling the Test command.

The Test command can be called with the Ctrl-F1 key.

See also\
   {link=222,HelpFile|Make}\
   {link=109,HelpFile|Make This Topic}\
   {link=2204,HelpFile|Directories}\
   {link=2203,HelpFile|Title}\
   {link=226,HelpFile|Compress}\
   {link=2226,HelpFile|Copyright}\
   {link=2227,HelpFile|Icon}\
   {link=2205,HelpFile|Status}\
   {link=2211,HelpFile|Keywords}














\end

109
HelpFile|Make This Topic
HelpFile|Make This Topic
Make This Topic
Make


2

0


Topic Text -----------------------------
The HelpFile|Make command compiles the current topic (not the whole source)
into a {link=107,Help File.}

If the "Internal Compiler " button has been selected in the {link=2204,HelpFile|Directories}
dialog EditHelp uses the {link=262,Internal Compiler.}

Otherwise, EditHelp saves the current topic
as a Rich Text Format file and a Help Project file.

It then executes the {link=111,Help Compiler} which compiles these into
the {link=107,Help File}:

    <directory><filename>.hlp

where <filename> is the name of the current {link=107,help source file} and <directory>
is the 'Help File Directory' specified by the {link=2204,HelpFile|Directories} command.

You can then test the current topic by calling the {link=223,HelpFile|Test} command.

The {link=222,HelpFile|Make} command creates a Help File for all the topics. However,
the Help Compiler is very slow when compiling large projects. So if you want to test
a single topic, you should use the HelpFile|Make This Topic command.

See also\
   {link=222,HelpFile|Make}\
   {link=223,HelpFile|Test}\
   {link=2204,HelpFile|Directories}\
   {link=2203,HelpFile|Title}\
   {link=226,HelpFile|Compress}\
   {link=2226,HelpFile|Copyright}\
   {link=2227,HelpFile|Icon}\
   {link=2205,HelpFile|Status}\
   {link=2211,HelpFile|Keywords}




\end

222
HelpFile|Make
HelpFile|Make
Make


2

0


Topic Text -----------------------------
The HelpFile|Make command compiles the {link=107,help source} into a {link=107,Help File.}

If the "Internal Compiler " button has been selected in the {link=2204,HelpFile|Directories}
dialog EditHelp uses the {link=262,Internal Compiler.}

Otherwise, EditHelp saves the {link=107,help source} as the Rich Text Format file

    ~out.rtf

and creates a Help Project file:

    ~out.hpj

EditHelp then executes the {link=111,Help Compiler} which compiles ~out.rtf into
the help file

    ~out.hlp

This {link=107,Help File} is copied to

    <directory><filename>.hlp

where <filename> is the name of the current {link=107,help source file} and <directory>
is the 'Help File Directory' specified by the {link=2204,HelpFile|Directories} command.

All the ~out files are then deleted.

The external Help Compiler is a DOS program so EditHelp creates a DOS batch file. The batch
file pauses after the Help Compiler has executed so you can see whether the compiler
generated any error messages. Press any (printable) key to continue execution.

The Make command can be called with the F9 key.

See also\
   {link=223,HelpFile|Test}\
   {link=109,HelpFile|Make This Topic}\
   {link=2204,HelpFile|Directories}\
   {link=2203,HelpFile|Title}\
   {link=226,HelpFile|Compress}\
   {link=2226,HelpFile|Copyright}\
   {link=2227,HelpFile|Icon}\
   {link=2205,HelpFile|Status}\
   {link=2211,HelpFile|Keywords}



\end

221
Topic|Status
Topic|Status
Status


0

11
TopicMenu

Topic Text -----------------------------
The Topic|Status command cycles through the status values for the current
{link=106,topic.} The status value can be one of:

    Incomplete\
    Test\
    Finished

The Status value has no effect on the operation of EditHelp but allows you
to keep track of which parts of the help source have been completed.

You can also call the Topic|Status command by clicking on the status area of the
main window.

See also\
   {link=2205,HelpFile|Status}

   {link=214,Topic|Next topic}\
   {link=215,Topic|Prev topic}\
   {link=227,Topic|Back}\
   {link=216,Topic|New topic}\
   {link=2202,Topic|Goto}\
   {link=228,Topic|Goto Unfinished}\
   {link=218,Topic|Delete}\
   {link=2201,Topic|Caption}\
   {link=220,Topic|Contents}\
   {link=2228,Topic|Browse}\
   {link=2240,Topic|Entry Command}\
   {link=253,Topic|Preview}\










\end

220
Topic|Contents
Topic|Contents
Contents


0

4
TopicMenu

Topic Text -----------------------------
The Topic|Contents command toggles whether the current {link=106,topic} is the
Contents topic. The Help System displays the Contents topic when the user
selects the Contents command.

Only one topic can have the Contents switch set to True. If you toggle the
Contents command, all the other topics will have their Contents switch set to False.

See also\
   {link=214,Topic|Next topic}\
   {link=215,Topic|Prev topic}\
   {link=227,Topic|Back}\
   {link=216,Topic|New topic}\
   {link=2202,Topic|Goto}\
   {link=228,Topic|Goto Unfinished}\
   {link=218,Topic|Delete}\
   {link=2201,Topic|Caption}\
   {link=2228,Topic|Browse}\
   {link=221,Topic|Status}\
   {link=2240,Topic|Entry Command}\
   {link=253,Topic|Preview}\










\end

2201
Topic|Caption
Topic|Caption
Caption


0

3
TopicMenu

Topic Text -----------------------------
The Topic|Caption command changes the
{link=105,topic number}, {link=108,caption} and {link=103,keywords} of the current
{link=106,topic.}

You can also call the Topic|Caption command by clicking on the caption area of the
main window.

See also\
   {link=214,Topic|Next topic}\
   {link=215,Topic|Prev topic}\
   {link=227,Topic|Back}\
   {link=216,Topic|New topic}\
   {link=2202,Topic|Goto}\
   {link=228,Topic|Goto Unfinished}\
   {link=218,Topic|Delete}\
   {link=220,Topic|Contents}\
   {link=2228,Topic|Browse}\
   {link=221,Topic|Status}\
   {link=2240,Topic|Entry Command}\
   {link=253,Topic|Preview}\










\end

218
Topic|Delete
Topic|Delete
Delete


0

5
TopicMenu

Topic Text -----------------------------
The Topic|Delete command deletes the current {link=106,topic} from the help source.

See also\
   {link=214,Topic|Next topic}\
   {link=215,Topic|Prev topic}\
   {link=227,Topic|Back}\
   {link=216,Topic|New topic}\
   {link=2202,Topic|Goto}\
   {link=228,Topic|Goto Unfinished}\
   {link=2201,Topic|Caption}\
   {link=220,Topic|Contents}\
   {link=2228,Topic|Browse}\
   {link=221,Topic|Status}\
   {link=2240,Topic|Entry Command}\
   {link=253,Topic|Preview}\










\end

2202
Topic|Goto
Topic|Goto
Goto


0

6
TopicMenu

Topic Text -----------------------------
The Topic|Goto command allows you to select a new {link=106,topic} from the topic list
and load it into the Edit window.

You may select the topic by {link=105,topic number}, {link=108,caption}
or {link=103,Keywords.}

See also\
   {link=214,Topic|Next topic}\
   {link=215,Topic|Prev topic}\
   {link=227,Topic|Back}\
   {link=216,Topic|New topic}\
   {link=228,Topic|Goto Unfinished}\
   {link=218,Topic|Delete}\
   {link=2201,Topic|Caption}\
   {link=220,Topic|Contents}\
   {link=2228,Topic|Browse}\
   {link=221,Topic|Status}\
   {link=2240,Topic|Entry Command}\
   {link=253,Topic|Preview}\










\end

216
Topic|New topic
Topic|New topic


0

8
TopicMenu

Topic Text -----------------------------
The Topic|New Topic command creates a new {link=106,topic.}
Each topic should have a unique {link=105,topic number.}

See also\
   {link=214,Topic|Next topic}\
   {link=215,Topic|Prev topic}\
   {link=227,Topic|Back}\
   {link=2202,Topic|Goto}\
   {link=228,Topic|Goto Unfinished}\
   {link=218,Topic|Delete}\
   {link=2201,Topic|Caption}\
   {link=220,Topic|Contents}\
   {link=2228,Topic|Browse}\
   {link=221,Topic|Status}\
   {link=2240,Topic|Entry Command}\
   {link=253,Topic|Preview}\










\end

215
Topic|Prev topic
Topic|Prev topic


0

10
TopicMenu

Topic Text -----------------------------
The Topic|Prev Topic command displays the previous {link=106,topic} in the topic list
in the Edit window.

The Prev topic command can be called with the Shift-F6 key.

See also\
   {link=214,Topic|Next topic}\
   {link=227,Topic|Back}\
   {link=216,Topic|New topic}\
   {link=2202,Topic|Goto}\
   {link=228,Topic|Goto Unfinished}\
   {link=218,Topic|Delete}\
   {link=2201,Topic|Caption}\
   {link=220,Topic|Contents}\
   {link=2228,Topic|Browse}\
   {link=221,Topic|Status}\
   {link=2240,Topic|Entry Command}\
   {link=253,Topic|Preview}\










\end

214
Topic|Next topic
Topic|Next topic


0

9
TopicMenu

Topic Text -----------------------------
The Topic|Next Topic command displays the next {link=106,topic} in the topic list
in the Edit window.

The Next topic command can be called with the F6 key.

See also\
   {link=215,Topic|Prev topic}\
   {link=227,Topic|Back}\
   {link=216,Topic|New topic}\
   {link=2202,Topic|Goto}\
   {link=228,Topic|Goto Unfinished}\
   {link=218,Topic|Delete}\
   {link=2201,Topic|Caption}\
   {link=220,Topic|Contents}\
   {link=2228,Topic|Browse}\
   {link=221,Topic|Status}\
   {link=2240,Topic|Entry Command}\
   {link=253,Topic|Preview}\










\end

213
Search|Next
Search|Next
Next


0

0


Topic Text -----------------------------
The Search|Next command
repeats the last search or replace operation without opening the Find dialog box.

The Next command can be called with the F3 key.

See also\
   {link=2210,Search|Find}\
   {link=2209,Search|Replace}\
   {link=2208,Search|Replace with Link}\
   {link=2213,Search|Find Error}




































































\end

2209
Search|Replace
Search|Replace
Replace


0

0


Topic Text -----------------------------
The Search|Replace command searches for and changes text in the current
{link=106,topic.}
During the search, you can match uppercase and lowercase letters or
ignore case.

If the 'all occurrences' box is checked then all the occurrences of the
search string will be replaced in the current topic.

If you select the 'All Topics' button then the search will start with the first topic
in the topic list and will be extended to all the topics in the list.
If the 'all occurrences' box is checked then all the occurrences of the
search string will be replaced in all topics.
If the 'all occurrences' box is not checked then only the first occurrence
to be found will be replaced.

See also\
   {link=2210,Search|Find}\
   {link=2208,Search|Replace with Link}\
   {link=213,Search|Next}\
   {link=2213,Search|Find Error}














\end

2210
Search|Find
Search|Find
Find


0

0


Topic Text -----------------------------
The Search|Find command
searches for characters or words in the text of the
current {link=106,topic.}
You can match uppercase and lowercase letters or ignore case.

If you select the 'All Topics' button then the search will start with the first topic
in the topic list and will be extended to all the topics in the list.

See also\
   {link=2209,Search|Replace}\
   {link=2208,Search|Replace with Link}\
   {link=213,Search|Next}\
   {link=2213,Search|Find Error}














\end

209
Edit|Delete
Edit|Delete
Delete


0

0


Topic Text -----------------------------
The Edit|Delete command
deletes the selected text from the current {link=106,topic},
but does not place the text onto the Clipboard.

Use Delete when you want to delete text from the current
topic but you have
text on the Clipboard that you want to keep.

The Delete command can be called with the Del key.

See also\
   {link=205,Edit|Undo}\
   {link=206,Edit|Cut}\
   {link=207,Edit|Copy}\
   {link=208,Edit|Paste}\
   {link=2207,Edit|Link}\
   {link=2215,Edit|Popup}\
   {link=2214,Edit|Bitmap}\
   {link=2234,Edit|DLL Call}\
   {link=2233,Edit|Embedded Pane}\
















































\end

208
Edit|Paste
Edit|Paste
Paste


0

0


Topic Text -----------------------------
The Edit|Paste command
pastes a copy of the Clipboard contents at the insertion point or replaces
selected text in the current {link=106,topic.}

The Paste command can be called with the Shift+Ins key.

See also\
   {link=205,Edit|Undo}\
   {link=206,Edit|Cut}\
   {link=207,Edit|Copy}\
   {link=209,Edit|Delete}\
   {link=2207,Edit|Link}\
   {link=2215,Edit|Popup}\
   {link=2214,Edit|Bitmap}\
   {link=2234,Edit|DLL Call}\
   {link=2233,Edit|Embedded Pane}\














\end

207
Edit|Copy
Edit|Copy
Copy


0

0


Topic Text -----------------------------
The Edit|Copy command
copies
the selected
text from the current {link=106,topic} onto the Clipboard, leaving the original intact
and replacing
the previous Clipboard contents.

The Copy command can be called with the Ctrl+Ins key.

See also\
   {link=205,Edit|Undo}\
   {link=206,Edit|Cut}\
   {link=208,Edit|Paste}\
   {link=209,Edit|Delete}\
   {link=2207,Edit|Link}\
   {link=2215,Edit|Popup}\
   {link=2214,Edit|Bitmap}\
   {link=2234,Edit|DLL Call}\
   {link=2233,Edit|Embedded Pane}\
















































\end

206
Edit|Cut
Edit|Cut
Cut


0

0


Topic Text -----------------------------
The Edit|Cut command
deletes the selected text from the current {link=106,topic} and places it onto the Clipboard,
replacing the previous Clipboard contents.

The Cut command can be called with the Shift+Del key.

See also\
   {link=205,Edit|Undo}\
   {link=207,Edit|Copy}\
   {link=208,Edit|Paste}\
   {link=209,Edit|Delete}\
   {link=2207,Edit|Link}\
   {link=2215,Edit|Popup}\
   {link=2214,Edit|Bitmap}\
   {link=2234,Edit|DLL Call}\
   {link=2233,Edit|Embedded Pane}\
















































\end

205
Edit|Undo
Edit|Undo
Undo


0

0


Topic Text -----------------------------
The Edit|Undo command
undoes your last editing action, including cut and paste actions.

Undo only works with actions performed on the help source text in the Edit window.

The Undo command can be called with the Alt+BkSp key.

See also\
   {link=206,Edit|Cut}\
   {link=207,Edit|Copy}\
   {link=208,Edit|Paste}\
   {link=209,Edit|Delete}\
   {link=2207,Edit|Link}\
   {link=2215,Edit|Popup}\
   {link=2214,Edit|Bitmap}\
   {link=2234,Edit|DLL Call}\
   {link=2233,Edit|Embedded Pane}\
















































\end

204
File|Exit
File|Exit
Exit


0

0


Topic Text -----------------------------
The File|Exit command exits from the EditHelp program. If you've
made changes to the {link=107,help source}, you will be asked if you want to save
them.

See also\
   {link=200,File|New}\
   {link=201,File|Open}\
   {link=202,File|Save}\
   {link=203,File|Save As}\
   {link=258,File|Project|New}\
   {link=2237,File|Project|Open}\
   {link=259,File|Project|Save}\
   {link=260,File|Project|SaveAs}\
   {link=2238,File|Project|Files}\
   {link=2239,File|Project|Move Topic}\
   {link=210,File|Save As TXT}\
   {link=246,File|Save As RTF}\
   {link=2229,File|Save As WWW}\
   {link=2217,File|Open EXE}\
   {link=401,File|WWW Mode}\




























\end

203
File|Save As
File|Save As
Save As


0

0


Topic Text -----------------------------
The File|Save As command saves the current help source to a file.
The Save As dialog allows you to choose the name of the file.

{link=107,Help source files} have the extension '.EDH'.

See also\
   {link=200,File|New}\
   {link=201,File|Open}\
   {link=202,File|Save}\
   {link=258,File|Project|New}\
   {link=2237,File|Project|Open}\
   {link=259,File|Project|Save}\
   {link=260,File|Project|SaveAs}\
   {link=2238,File|Project|Files}\
   {link=2239,File|Project|Move Topic}\
   {link=210,File|Save As TXT}\
   {link=246,File|Save As RTF}\
   {link=2229,File|Save As WWW}\
   {link=2217,File|Open EXE}\
   {link=401,File|WWW Mode}\
   {link=204,File|Exit}




























\end

202
File|Save
File|Save
Save


0

0


Topic Text -----------------------------
The File|Save command saves the current help source to a file.
{link=107,Help source files} have the extension '.EDH'.

If the current help source hasn't been named yet, EditHelp displays the
{link=203,Save File As} dialog box.

See also\
   {link=200,File|New}\
   {link=201,File|Open}\
   {link=203,File|Save As}\
   {link=258,File|Project|New}\
   {link=2237,File|Project|Open}\
   {link=259,File|Project|Save}\
   {link=260,File|Project|SaveAs}\
   {link=2238,File|Project|Files}\
   {link=2239,File|Project|Move Topic}\
   {link=210,File|Save As TXT}\
   {link=246,File|Save As RTF}\
   {link=2229,File|Save As WWW}\
   {link=2217,File|Open EXE}\
   {link=401,File|WWW Mode}\
   {link=204,File|Exit}




























\end

201
File|Open
File|Open
Open


0

0


Topic Text -----------------------------
The File|Open command opens an existing {link=107,help source file} that was created
using EditHelp. Help source files
have the extension '.EDH'.

The File|Open command displays the File Open dialog box.

See also\
   {link=200,File|New}\
   {link=202,File|Save}\
   {link=203,File|Save As}\
   {link=258,File|Project|New}\
   {link=2237,File|Project|Open}\
   {link=259,File|Project|Save}\
   {link=260,File|Project|SaveAs}\
   {link=2238,File|Project|Files}\
   {link=2239,File|Project|Move Topic}\
   {link=210,File|Save As TXT}\
   {link=246,File|Save As RTF}\
   {link=2229,File|Save As WWW}\
   {link=2217,File|Open EXE}\
   {link=401,File|WWW Mode}\
   {link=204,File|Exit}




























\end

200
File|New
File|New
New


0

0


Topic Text -----------------------------
The File|New command creates a new help source with one empty {link=106,topic.}

See also\
   {link=201,File|Open}\
   {link=202,File|Save}\
   {link=203,File|Save As}\
   {link=258,File|Project|New}\
   {link=2237,File|Project|Open}\
   {link=259,File|Project|Save}\
   {link=260,File|Project|SaveAs}\
   {link=2238,File|Project|Files}\
   {link=2239,File|Project|Move Topic}\
   {link=210,File|Save As TXT}\
   {link=246,File|Save As RTF}\
   {link=2229,File|Save As WWW}\
   {link=2217,File|Open EXE}\
   {link=401,File|WWW Mode}\
   {link=204,File|Exit}














\end

108
Caption
caption


0

0


Topic Text -----------------------------
Every {link=106,topic} may optionally have a Caption. The Windows
help system will display the caption in
larger bold text at the head of the topic screen.

{link=116,Popup} topic captions are usually blank.

You can change the caption by selecting the {link=2201,Topic|Caption} command.













































\end

107
Files
files
help file
source file


0

0


Topic Text -----------------------------
EditHelp can read or write several different file formats:


{heading=Source file: EDH}

The input to the EditHelp program is a 'source file'. A source file has
the extension '.EDH'.

You may examine the source file using any plain ASCII text editor but be careful
not to disturb its format.


{heading=Help file: HLP}

When you select the {link=222,HelpFile|Make} command, EditHelp
writes the contents of the source file as a Rich Text Format file and a {link=243,Help Project File.}
It then executes the {link=111,Help Compiler} which compiles these into a Help File.

The Help File file is created as:

    <directory><filename>.hlp

where <filename> is the name of the current help source file (or {link=257,Project file}) and <directory>
is the 'Help File Directory' specified by the {link=2204,HelpFile|Directories} command.


{heading=Help Project file: HPJ}

The {link=111,Help Compiler} requires a Help Project file to direct the compilation of the
Rich Text Format file to a Help File.

You can specify {link=243,extra text} to be inserted into the Help Project file.

(Do not confuse the {link=243,Help Project File} - HPJ - with a {link=257,Project file} - EHP.)


{heading=Help Project Extra files: EPJ}

A Help Project file consists of various sections: e.g. [OPTIONS], [FILES], [CONFIG], etc.
You can specify {link=243,extra text} to be inserted into each of these sections. For instance, if the
file

      options.epj

exists in the same directory as the EditHelp source file, then the
text of the EPJ file will be copied to the [OPTIONS] section of the Help Project file.


{heading=Rich Text Format file: RTF}

EditHelp creates a temporary Rich Text Format file (~out.rtf) which the {link=111,Help Compiler} compiles
to a Help File.

Normally, you will not need to examine the Rich Text Format file.

Rich Text Format files can be read and edited by the Microsoft Word word processor.
You can use the {link=246,File|Save As RTF} command to write the current source as a
Rich Text Format file.


{heading=Project file: EHP}

A {link=257,Project} consists of a Project file and a set of EDH source files.

When the {link=222,HelpFile|Make} command is executed, all of the source files are
linked together to form a single HLP Help file. Use a Project when you want several
source files to be shared by several Help files.


{heading=World Wide Web: WWW}

The {link=2229,File|Save As WWW} command saves the current source as
a HyperText Markup Language (HTML) file.
HTML can be used to represent Hypertext news, mail, online documentation, etc.
on the World Wide Web using a standard Internet protocol.

Each {link=106,topic} will be stored in a separate file:

    <filename>.htm


{heading=ASCII Text file: TXT}

The {link=210,File|Save As TXT} command saves the current source to a file as
plain ASCII text. The text file will have the name:

    <filename>.TXT

Each topic appears on a separate page. You can use the text file as the basis of your user manual.


{heading=Executable file: EXE}

The {link=2217,File|Open EXE} command reads an exe file and examines the menu
and dialog resources of the file. From these, it creates a corresponding
skeleton EDH source file.

If the source file name is

      program.exe

then the new source file will be

      program.edh














\end

106
Topics
topics


0

0


Topic Text -----------------------------
A {link=107,Help File} is divided into 'Topics'. Each topic is a "page" full of information
describing a particular subject.

Each topic must have a unique {link=105,number.} The number is used when the host program
calls the help system to display a help topic.

The user selects a topic by following {link=2207,Links} or by selecting a {link=103,Keyword}
from the Search dialog.














\end

105
Topic number
topic number


0

0


Topic Text -----------------------------
Each topic must have a unique number. The number is used when the host program
calls the help system to display a help topic.

For instance, this topic is topic number 105, so the host program would display this
topic by calling:

    WinHelp(hWindow, HelpFileName, Help_Context, 105)

You can change the topic number by selecting the {link=2201,Topic|Caption} command.

If you have written a program which must use context strings rather than context
numbers, you can use the file {link=261,ALIAS.EPJ} to assign strings to topics.

See also\
    {link=106,topics}\
    {link=107,file names}









\end

103
Keywords
keywords
search
topic name


0

0


Topic Text -----------------------------
Keywords appear in the Windows Help Search dialog box when the user selects the Search
command.

The Keywords section may contain several keywords separated by semicolons or newlines.
For instance, the keywords for this topic are:

    keywords;search;topic name

If, in Windows Help,  you select the Search command, you will find this {link=106,topic} indexed
by each of these keywords.

Several topics may share the same keyword. In which case, when the user selects
the keyword, the 'topic names' will appear in the GoTo box of the Search dialog. The
'topic name' is the first keyword in the keyword list.

You can change the keyword list by selecting the {link=2201,Topic|Caption} command.












\end

101
Comments
comments


0

0


Topic Text -----------------------------
If first two characters on a line are '//', the line will be ignored. For example

    // this is a comment




































































\end

2200
The EditHelp program
contents

INDEX
2

0


Topic Text -----------------------------
The EditHelp program creates Help Files for use with the Windows
help system. It can also create files in
HyperText Markup Language (HTML)  format.

The Help File may contain links, popup-links, bitmaps and keywords.
As you develop your Help File, EditHelp helps you keep track of
the {link=2205,status} of each topic.

EditHelp can operate in two {link=401,modes}: 'Windows Help' and 'WWW'.
This Help file describes how EditHelp behaves in the 'Windows Help' mode.
To change mode, select the {link=401,File|WWW Mode} command.

The {link=245,Examples} topic shows many of the features available
from EditHelp.

It is recommended that you use EditHelp with a {link=111,Help Compiler} such as Microsoft's
HC31. You may already have HC31.EXE (or HC30) on your computer.
EditHelp also has an {link=262,internal Help Compiler.}

To find out more about using EditHelp to create Help Files, see the following topics:

    {link=107,Files}\
    {link=106,Topics}\
    {link=114,Text Layout}\
    {link=115,Text Commands}\
    {link=222,Make HelpFile}\
    {link=2211,Keywords}\
    {link=257,Projects}\

If you have already developed Help files using other tools, you can
use the {link=2241,File|Open HLP} command to convert them into EditHelp format.

The source file for this help is supplied with this program as

    edithelp.edh

See also\
    {link=110,Menu Commands}




\end

111
Help Compiler
help compiler
compiler


2

0


Topic Text -----------------------------
The Help Compiler converts a Rich Text Format file into a {link=107,Help File.}

EditHelp was written for use with the Microsoft HC31 help compiler
(copyright (c) Microsoft Corp 1990 - 1992). This reports the version number:

    Version 3.10.445

It may also work with older versions of HC31 or even with the Windows 3.0
version - HC30.

You may already have HC31.EXE on your computer; it is supplied with
many program development systems.

EditHelp also has an {link=262,internal Help Compiler.}

Whether the External or Internal Compiler is used can be selected via the {link=2204,HelpFile|Directories}
dialog.



\end

2207
Edit|Link
Edit|Link
links


0

0


Topic Text -----------------------------
A link is specified in the source text by the Link {link=115,command}:

    {{}link=<num>,<text>}

where <num> is the {link=105,Topic number} of the destination and <text>
is the link-text to be displayed.

For instance, the Text Layout topic number is 114 so a link to the Text Layout topic would be
specified as

    {{}link=114,Text Layout}

which would display as

    {link=114,Text Layout}

When the user selects the link, the destination topic is displayed.

A {link=2219,bitmap} can be used as a button which displays the new topic.

A link command can also specify that a {link=2225,Help Macro} should be executed.
Select the 'Macro' button of the Edit|Link dialog.

The Edit|Link command inserts a Link into the text of the current topic
at the current insertion point. You can choose the link topic from a list of all topics.

You can also type in a link "by hand".

A link can specify that the destination topic should be displayed in a
{link=2230,Secondary Window} or that a {link=2231,New File} should be loaded.

See also\
   {link=205,Edit|Undo}\
   {link=206,Edit|Cut}\
   {link=207,Edit|Copy}\
   {link=208,Edit|Paste}\
   {link=209,Edit|Delete}\
   {link=2215,Edit|Popup}\
   {link=2214,Edit|Bitmap}\
   {link=2219,Edit|Bitmap Link}\
   {link=2234,Edit|DLL Call}\
   {link=2233,Edit|Embedded Pane}\
















































\end

114
Text Layout
text layout
layout


0

0


Topic Text -----------------------------
The Edit window of the EditHelp program shows the text of the current topic.

The layout of the text affects the layout of the {link=107,Help File.}

Single newlines are ignored in the text so that the source:

    Single newlines are\
    ignored in\
    the text

is displayed by the Help system as:

    Single newlines are
    ignored in
    the text

Two or more newlines start a new paragraph, so that:

    Single newlines\
    are ignored.

    But two newlines\
    start a new paragraph.

is displayed as:

    Single newlines are ignored.

    But two newlines start a new paragraph.

A '\' character at the end of a line is displayed as a newline, so:

    Single newlines\\
    are ignored.

is displayed as:

    Single newlines\
    are ignored.

If the first line of a paragraph has leading blanks then the whole paragraph is
indented.
Leading blanks on subsequent lines are ignored.

Trailing blanks on a line are deleted; a single trailing blank is then added.
This is usually what is required in normal text - if you want a specific number of trailing blanks, use the
{link=251,Literal} command.

Lines must have fewer than 255 characters.

Text can be displayed {link=231,bold} or {link=232,italic} and in different
{link=2218,fonts} and {link=2221,sizes.}

See also\
    {link=115,Text Commands}

Advanced layout includes\
    {link=2220,Heading command}\
    {link=240,Line command}\
    {link=2224,List Command}\
    {link=241,Box command}\
    {link=242,Centre command}\
    {link=247,Keep command}\









\end

115
Text Commands
text commands
commands


0

0


Topic Text -----------------------------
The source text can contain Commands specifying links, sub-headings and bitmaps to be
included in the {link=107,Help File.}

A {link=2207,Link} is specified by the Link Command:

    {{}link=<num>,<text>}

where <num> is the {link=105,Topic number} of the destination and <text>
is the link-text to be displayed.

A {link=116,Popup Link} is specified by the Popup Command:

    {{}popup=<num>,<text>}

where <num> is the {link=105,Topic number} of the destination and <text>
is the popup link-text to be displayed.

A {link=118,Bitmap} is specified by the Bitmap Command:

    {{}bitmap=<filename>}

where <filename> is the name of a BMP file to be displayed.

A {link=2220,sub-heading} is specified by the Heading Command:

    {{}heading=<text>}

where <text> is the text of the sub-heading.

The command name for every text command must appear in lower case.
For instance, use 'link' not 'Link'.

Every text command starts with a '{{}' character.
The '{{}' character may be inserted into the text as

    {{}{{}}

See also\
    {link=114,Text Layout}\
    {link=2220,Heading command}\
    {link=240,Line command}\
    {link=2224,List command}\
    {link=241,Box command}\
    {link=242,Centre command}\
    {link=247,Keep command}\














\end

210
File|Save As TXT
File|Save As TXT
Save As TXT
TXT


0

0


Topic Text -----------------------------
The File|Save As TXT command saves the current source to a file as
plain ASCII text. The text file will have the name:

    <filename>.TXT

where <filename> is the name of the current {link=107,help source file.}

Each topic appears on a separate page; pages are separated by FF (#12)
characters.

If you select 'Remove all formatting' then all formatting and link commands are removed.
Otherwise, link commands will be replaced with the text of the hotspot but other
formatting commands will be written to the TXT file; for instance

    {{}font=6}

will be written as

    <<font=6>>

You can use the text file as the basis of your user manual.

See also\
   {link=200,File|New}\
   {link=201,File|Open}\
   {link=202,File|Save}\
   {link=203,File|Save As}\
   {link=258,File|Project|New}\
   {link=2237,File|Project|Open}\
   {link=259,File|Project|Save}\
   {link=260,File|Project|SaveAs}\
   {link=2238,File|Project|Files}\
   {link=2239,File|Project|Move Topic}\
   {link=246,File|Save As RTF}\
   {link=2229,File|Save As WWW}\
   {link=2217,File|Open EXE}\
   {link=401,File|WWW Mode}\
   {link=204,File|Exit}














\end

2211
HelpFile|Keywords
HelpFile|Keywords
Keywords


0

0


Topic Text -----------------------------
The HelpFile|Keywords command displays the
{link=103,Keywords}, {link=105,Topic number} and {link=108,Caption} of each topic.
The display is sorted by all of the keywords of each topic.

The Keywords command helps you keep track of which keywords are common to
several topics.

See also\
   {link=222,HelpFile|Make}\
   {link=223,HelpFile|Test}\
   {link=109,HelpFile|Make This Topic}\
   {link=2204,HelpFile|Directories}\
   {link=2203,HelpFile|Title}\
   {link=226,HelpFile|Compress}\
   {link=2226,HelpFile|Copyright}\
   {link=2227,HelpFile|Icon}\




































































\end

228
Topic|Goto Unfinished
Topic|Goto Unfinished
Goto Unfinished


0

7
TopicMenu

Topic Text -----------------------------
The Topic|Goto Unfinished command selects the next unfinished {link=106,topic} from the
topic list and load it
into the Edit window. An unfinished topic is one whose {link=221,status} is
'Incomplete' or Test'.

The Goto Unfinished command can be called with the Ctrl-F6 key.

See also\
   {link=221,Topic|Status}\
   {link=2205,HelpFile|Status}

   {link=214,Topic|Next topic}\
   {link=215,Topic|Prev topic}\
   {link=227,Topic|Back}\
   {link=216,Topic|New topic}\
   {link=218,Topic|Delete}\
   {link=2201,Topic|Caption}\
   {link=220,Topic|Contents}\
   {link=2228,Topic|Browse}\
   {link=2240,Topic|Entry Command}\
   {link=253,Topic|Preview}\










\end

2213
Search|Find Error
Search|Find Error
Find Error


0

0


Topic Text -----------------------------
The Search|Find Error command
searches for an error reported by the {link=111,Help Compiler.}

If the {link=111,Help Compiler} reports an error such as

    Error 4639: Error in file '~out.rtf' at byte offset 0x1BC9.

enter the error address (e.g. 1BC9) into the Find Error dialog box.
The cursor will move to a position near the error in the source.

Warning: The {link=111,Help Compiler} seems to report the wrong address for errors
if you have linked {link=243,Baggage} into the {link=107,Help File}

See also\
   {link=2210,Search|Find}\
   {link=2209,Search|Replace}\
   {link=2208,Search|Replace with Link}\
   {link=213,Search|Next}














\end

2215
Edit|Popup
Edit|Popup
Popup Link


0

0


Topic Text -----------------------------
The Edit|Popup command inserts a {link=116,Popup Link} into the text of the current topic
at the current insertion point. You can choose the popup topic from a list of all topics.

You can also type in a popup link "by hand".

See also\
   {link=205,Edit|Undo}\
   {link=206,Edit|Cut}\
   {link=207,Edit|Copy}\
   {link=208,Edit|Paste}\
   {link=209,Edit|Delete}\
   {link=2214,Edit|Bitmap}\
   {link=2207,Edit|Link}\
   {link=2234,Edit|DLL Call}\
   {link=2233,Edit|Embedded Pane}\
















































\end

2214
Edit|Bitmap
Edit|Bitmap
Bitmap


2

0


Topic Text -----------------------------
The Edit|Bitmap command inserts a {link=118,Bitmap} into the text of the current topic
at the current insertion point.
You can choose the Bitmap from a list of BMP files.

You can also type in a Bitmap {link=115,command} "by hand".

The bitmap filename should not contain any path information. The bitmap file should be in
the same directory as the EDH {link=107,source file.}

See also\
   {link=205,Edit|Undo}\
   {link=206,Edit|Cut}\
   {link=207,Edit|Copy}\
   {link=208,Edit|Paste}\
   {link=209,Edit|Delete}\
   {link=2215,Edit|Popup}\
   {link=2234,Edit|DLL Call}\
   {link=2233,Edit|Embedded Pane}\






\end

2216
Make command
Make command


0

0


Topic Text -----------------------------
Before the {link=222,HelpFile|Make} or {link=109,HelpFile|Make This Topic} command is run, you have the
opportunity to save the current {link=107,help source.}

You may select:

    {list=9}Yes:    the source file is saved then the {link=107,Help File} is made

    No:    the source file is not saved before the Help File is made

    Always:    the source file is always saved before the Help File is made

    Never:    the source file is never saved before the Help File is made

{list=0}If you choose Always or Never, this dialog will not be presented again
for this help source file.

If you choose No or Never, you can save the help source file later with the
{link=202,File|Save} or {link=203,File|Save As} command.

See also\
    {link=222,HelpFile|Make}\
    {link=109,HelpFile|Make This Topic}\
    {link=111,Help Compiler}\
    {link=107,Files}














\end

243
Help Project File
Help Project File
Project File


0

0


Topic Text -----------------------------
When you select the {link=222,HelpFile|Make} command, EditHelp
writes the contents of the {link=107,source file} as a Rich Text Format file and a Help Project file.
These are called:

      ~out.rtf    Rich Text Format file \
      ~out.hpj    Help Project file

It then executes the {link=111,Help Compiler} which compiles these into a {link=107,Help File}
called

      ~out.hlp    Help file

The Help File is then copied to

    <directory><filename>.hlp

where <filename> is the name of the current help source file and <directory>
is the 'Help File Directory' specified by the {link=2204,HelpFile|Directories} command.

A Help Project file consists of the following sections:

    {list=15}[OPTIONS]    Specifies options that control the build process. This section is optional. If
                                this section is used, it should be the first section listed in the project file, so
                                that the options will apply during the entire build process.\
    [FILES]    Specifies topic files to be included in the build. This section is required.\
    [BUILDTAGS]    Specifies valid build tags. This section is optional.\
    [CONFIG]    Specifies Help macros that define nonstandard menus, buttons, and
                                macros used in the help file. This section is required if the help file uses
                                any of these features. This section is new for Windows 3.1.\
    [BITMAPS]    Specifies bitmap files to be included in the build. This section is not
                                required if the project file lists a path for bitmap files by using the
                                BMROOT or ROOT option.\
    [MAP]    Associates context strings with context numbers. This section is optional.\
    {link=261,[ALIAS]}    Assigns one or more context strings to the same topic. This section is
                                optional.\
    [WINDOWS]    Defines the characteristics of the primary Help window and the
                                secondary-window types used in the help file. This section is required if the
                                help file uses {link=2230,Secondary Windows.}\
    [BAGGAGE]    Lists files that are to be placed within the help file (which contains its own
                                file system). This section is optional.

{list=0}
You can specify extra text to be inserted into each of these sections. For instance, if the
file

      options.epj

exists in the same directory as the EditHelp {link=107,source file}, then the text
of the EPJ file will be copied to the [OPTIONS] section of the Help Project file.

For instance, if the file

      config.epj

contains the line:

      CreateButton("btn_clk", "&Clock", "ExecProgram(`clock.exe',0)")

Then the Windows Help viewer will have an extra button labelled "Clock".
If the user selects this button, the Windows Clock program
will be run.

If you have written a program which must use context strings rather than context
numbers, you can use the file {link=261,ALIAS.EPJ} to assign strings to topics.














\end

303
MS-DOS
MS-DOS


0

0


Topic Text -----------------------------
This is the MS-DOS program.




































































\end

302
Paintbrush
Paintbrush


0

0


Topic Text -----------------------------
This is the Paintbrush program.




































































\end

301
File Manager
File Manager


0

0


Topic Text -----------------------------
This is the File Manager program.




































































\end

300
Microsoft Write
Write


0

0


Topic Text -----------------------------
This is the Microsoft Write program.




































































\end

245
Examples
Examples


0

0


Topic Text -----------------------------
This text will be kept while the rest of the page can be scrolled.
{keep}

This Topic shows many of the features of Help files produced by EditHelp.

Text can be shown in many styles, colours, fonts and sizes:

    {font=0}{fontsize=50}{colour=1}AbCdEf
    {font=1}{fontsize=20}{colour=10}AbCdEf
    {font=9}{fontsize=30}{colour=5}{italic}AbCdEf{italic}
    {font=6}{fontsize=40}{colour=13}AbCdEf
    {font=7}{fontsize=12}{colour=14}AbCdEf
    {font=8}{fontsize=30}{colour=11}{bold}AbCdEf{bold}
    {font=0}{fontsize=20}{colour=0}

{heading=Layout}

Here is an example of an indented list:

     {line}{list=12}{bold}Feature    Description

     Icon    The Icon command allows you to specify the name of an icon (.ICO) file.
                The icon will be displayed when the Help file is minimised.

     Copyright    The Copyright command allows you to specify an additional copyright notice
                which will appear in the Windows Help {link='About()',About} box.

     Browse    The Browse command sets the browse group name and number of the current topic.
                  A browse sequence typically consists of two or more related topics
                  that are intended to be read sequentially.

{box}{centre}This text is centred in a box.


{list=0}{heading=Pictures}

A Help file can display bitmaps:

    {bitmap=sample.bmp}

If you press this {popup=117,bmp=sample1.bmp} it will display a popup topic.

A Segmented Graphics File contains a bitmap that includes
one or more hotspots. For instance:

    {bitmap=sample.shg}

The Write, FileManager, Pbrush and
MS-DOS icons specify a {popup=117,popup link} while selecting the Notepad icon
will execute the Notepad program.

Text can also be displayed in a {link=249>MyWindow,Secondary Window.}














\end

246
File|Save As RTF
File|Save As RTF
Save As RTF
RTF


0

0


Topic Text -----------------------------
The File|Save As RTF command saves the current source to a file in
Rich Text Format. The file will have the name:

    <filename>.RTF

where <filename> is the name of the current {link=107,help source file.}

You can edit the RTF file using Microsoft Word.
Microsoft Word is the traditional editor for producing Windows Help files. It is
a powerful word processor but, unlike EditHelp, lacks many features specific to
the creation and maintainance of Windows Help files.

See also\
   {link=200,File|New}\
   {link=201,File|Open}\
   {link=202,File|Save}\
   {link=203,File|Save As}\
   {link=258,File|Project|New}\
   {link=2237,File|Project|Open}\
   {link=259,File|Project|Save}\
   {link=260,File|Project|SaveAs}\
   {link=2238,File|Project|Files}\
   {link=2239,File|Project|Move Topic}\
   {link=210,File|Save As TXT}\
   {link=2229,File|Save As WWW}\
   {link=2217,File|Open EXE}\
   {link=401,File|WWW Mode}\
   {link=204,File|Exit}














\end

247
Layout|Keep
Layout|Keep
keep


0

0


Topic Text -----------------------------
This text will be kept while the rest of the page can be scrolled.{keep}

The Keep {link=115,command} specifies that the text of the paragraph
containing the command and all the preceding text
(including the {link=108,Caption}) should remain at the top of the window.

    {{}keep}

The user can scroll all the text following the Keep command.

A line will be drawn below the non-scrolling region.

If you want just the {link=108,Caption} to appear in the non-scrolling region,
insert a line contining nothing but

    {{}keep}

as the first line of your topic text.

If the window is smaller than the non-scrolling region, the user will be unable
to view the rest of the topic.

See also\
    {link=2220,Layout|Heading}\
    {link=2224,Layout|List}\
    {link=240,Layout|Line}\
    {link=241,Layout|Box}\
    {link=242,Layout|Centre}\
    {link=2236,Layout|Tab}\

































\end

249
Secondary Window Example
Secondary Window
Window


0

0


Topic Text -----------------------------
The following definition:

      MyWindow="My Window",(0,0,500,500,0),,(255,255,0),,1

specifies that the Secondary Window should appear in the top left corner of the
screen, have a yellow background and remain on top.



























































\end

2231
New File
New File
File
Topic


0

0


Topic Text -----------------------------
If the format of a {link=2207,Link} command is

    {{}link=<num>@<newFile>,<text>}

where '<newFile>' is the name of a Help file, then the new file is opened and the destination
{link=106,Topic} is loaded from that file.
('<num>' is the {link=105,Topic number} of the destination and '<text>'
is the link-text to be displayed.)

The '<newFile>' string should not contain any DOS path information.

For instance:

    {{}link=[e-mail],Other File}

will load the Help file

    myhelp.hlp

If a Link command specifies both a {link=2230,Secondary Window} and a New File,
the clauses should be in the order:

    {{}link=num@newFile>winName,text}























































\end

251
Literal
Literal


0

0


Topic Text -----------------------------
If a source line contains the Literal command:

    {{}literal}

The the remaining text on the line is copied verbatim to the RTF file.

You can use this feature to insert RTF commands which are not otherwise available
from EditHelp.

For instance

    {{}literal} }{{}\par}\pard\{{}bml sample.bmp\}{{}\fs20 A\
    {{}{{}}bml ...} command before the start of a paragraph means\
    the paragraph text is wrapped to right of the bitmap.\

is displayed as:

{literal} }{\par}\pard\{bml sample.bmp\}{\fs20 A
{{}bml ...} command before the start of a paragraph means
the paragraph text is wrapped to the right of the bitmap.

To understand why this example works, you will need an RTF viewer manual such as

    Microsoft Multimedia Viewer: Technical Reference\
    MM39685-0393

and you will need to examine the {link=107,RTF file} written by EditHelp.

Normally, trailing blanks on a source line are deleted and a single trailing blank is then added.
If you want a specific number of trailing blanks, use the
Literal command towards the end of the line, followed by as many blanks as you
need. For instance:

     {{}bitmap=sample1.bmp}{{}literal}\
     {{}bitmap=sample1.bmp}

is displayed as:

     {bitmap=sample1.bmp}{literal}
     {bitmap=sample1.bmp}

without the {{}literal}, a blank would have been inserted:

     {bitmap=sample1.bmp}
     {bitmap=sample1.bmp}









































\end

252
Predefined Variables
Predefined Variables
Variables


0

0


Topic Text -----------------------------
Windows Help allows allows the following Predefined Variables as parameter values for
{link=2234,DLL Calls}:

      {list=17}{line}{bold}Variable    Description\
      hwndApp    the handle of the main Help window (U, DWORD,longint)\
      hwndContext    the handle of the current Help window (U, DWORD,longint)\
      qchPath    the the path of the Help file (S, LPSTR,^string) \
      lTopicNo    the current topic number (U, DWORD,longint)\
      coForeground    the foreground colour (U, DWORD,longint)\
      coBackground    the Background colour (U, DWORD,longint)\

N.B. the "current topic number" is an internal number used by WinHelp. It is not
the same as the {link=105,Topic number} used by EditHelp.











\end

256
Sample Bitmaps
Sample Bitmaps
Bitmaps


0

0


Topic Text -----------------------------
The following selection of bitmaps are supplied with EditHelp:

    {list=10}{bitmap=btnpress.bmp}    btnpress.bmp\
    {bitmap=btnok.bmp}    btnok.bmp\
    {bitmap=btncancl.bmp}    btncancl.bmp\
    {bitmap=btnhelp.bmp}    btnhelp.bmp\
    {bitmap=btnhelp1.bmp}    btnhelp1.bmp\

    {bitmap=disk1.bmp}    disk1.bmp\

    {bitmap=disk2.bmp}    disk2.bmp\

    {bitmap=exclamat.bmp}    exclamat.bmp\

    {bitmap=informat.bmp}    informat.bmp\

    {bitmap=btnprev.bmp}    prev.bmp\
    {bitmap=btnnext.bmp}    next.bmp\

    {bitmap=arrow.bmp}    arrow.bmp\

    {bitmap=point1.bmp}    point1.bmp\

    {bitmap=point2.bmp}    point2.bmp\


































\end

401
File|WWW Mode
File|WWW Mode
WWW Mode


0

0


Topic Text -----------------------------
The EditHelp program creates hypertext files for use with either the Windows
Help system or the World-Wide-Web.

EditHelp can create files in HyperText Markup Language (HTML)  format.
HTML can be used to represent
Hypertext news, mail, online documentation, etc.
on the World Wide Web using a standard Internet protocol.
To view an HTML file created by EditHelp, you will need an HTML Browser
such as 'Mosaic'.

EditHelp can operate in two modes: 'Windows Help' and 'WWW'.

In WWW mode, EditHelp disables several features which are available in Windows Help
but not in HTML files.

This Help file describes how EditHelp behaves in the 'Windows Help' mode.
To change mode, select the File|WWW Mode command.

A file created in WWW mode can also be compiled as a Windows Help file.

See also\
   {link=200,File|New}\
   {link=201,File|Open}\
   {link=202,File|Save}\
   {link=203,File|Save As}\
   {link=258,File|Project|New}\
   {link=2237,File|Project|Open}\
   {link=259,File|Project|Save}\
   {link=260,File|Project|SaveAs}\
   {link=2238,File|Project|Files}\
   {link=2239,File|Project|Move Topic}\
   {link=210,File|Save As TXT}\
   {link=246,File|Save As RTF}\
   {link=2229,File|Save As WWW}\
   {link=2217,File|Open EXE}\
   {link=204,File|Exit}




























\end

2236
Layout|Tab
Layout|Tab
Tab


0

0


Topic Text -----------------------------
Tab characters in the {link=107,help source file} (.EDH) will be translated into tabs
in the {link=107,Help File} (.HLP).

Similarly, a tab command:

    {{}tab}

will be translated into a tab in the {link=107,Help File.}

Alternatively, a tab command can specify the tab position:

    {{}tab=<pos>}

The tab position, <pos>, is measured from the left edge of the window. The default is 6.

For instance:

1{{}tab}2{{}tab}3{{}tab}4\\
1{{}tab=18}2<tab>3<tab>4\\
1<tab>2{{}tab=18}3<tab>4\\
1<tab>2<tab>3<tab>4\\

where <tab> is a tab character, is displayed as:

1{tab}2{tab}3{tab}4\
1{tab=18}2    3    4\
1    2{tab=18}3    4\
1    2    3    4\

See also\
    {link=114,Text Layout}\
    {link=2220,Layout|Heading}\
    {link=2224,Layout|List}\
    {link=240,Layout|Line}\
    {link=241,Layout|Box}\
    {link=242,Layout|Centre}\
    {link=247,Layout|Keep}\














\end