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

Text File | 1995-03-10 | 38.4 KB | 1,981 lines

Version 010B
Edit Help
false

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

EditHelp is copyright ⌐ Analogue Ltd. 1994
sample.ico
401
File|WWW Mode
File|WWW Mode;WWW Mode

0

0

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

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 'WWW' mode.
To change mode, select the 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=210,File|Save As TXT}\
   {link=401,File|WWW Mode}\
   {link=204,File|Exit}



\end

2232
Shareware
shareware;registration;unregistered

0

0

This is an unregistered version of EditHelp and certain features 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.

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 shareware and freeware you may find of interest.



















\end

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

2

0

The File|Save As WWW command saves the current source as
a HyperText Markup Language (HTML) file.

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,EditHelp 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=106,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=15}Fonts    the command is ignored\
    Text size    the command is ignored\
    Text colour    the command is ignored\
    Help Macros    treated as a {link=2207,Link}\
    Popup Links    treated as a {link=2207,Link}\
    Boxed text    a {link=240,Line} is drawn\
    Keep    the command is ignored\
    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 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 file then
the 'bmp' 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
{link=107,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
(with a {link=2231,New File Link}, link=0 command) 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=210,File|Save As TXT}\
   {link=401,File|WWW Mode}\
   {link=204,File|Exit}

\end

242
Layout|Centre
Layout|Centre;centre

0

0

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.

Older HTML browsers may ignore this command.

See also\
      {link=2220,Heading command}\
      {link=2224,List command}\
      {link=240,Line command}\





\end

240
Layout|Line
Layout|Line;line

0

0

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}.

See also\
    {link=115,Text Commands}\
    {link=2224,List Command}\
    {link=2220,Heading command}\
    {link=242,Centre command}\







\end

2224
Layout|List
Layout|List;list

0

0

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=15}{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=115,Text Commands}\
    {link=240,Line command}\
    {link=2220,Heading command}\
    {link=2224,List command}\
    {link=242,Centre command}\






\end

2220
Layout|Heading
Layout|Heading;heading

0

0

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.

See also\
    {link=115,Text commands}\
    {link=2224,List command}\
    {link=240,Line command}\
    {link=242,Centre command}\









\end

2219
Edit|Bitmap Link
Edit|Bitmap Link;bitmap;links

0

0

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

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

where <num> is the {link=106,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.gif}

which would display as

    {link=2207,bmp=sample1.gif}

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

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

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

If you want to be able to compile and display the source as a Windows Help file,
then the EDH {link=107,source file directory}should also contain a corresponding
.BMP file. When EditHelp compiles the file as a Windows Help file,
it will change the '.GIF' extension to '.BMP'.

A link can specify 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=2214,Edit|Bitmap}\








\end

232
Text|Italic
Text|Italic;fonts;italic

0

0

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=231,Text|Bold Command}\









\end

231
Text|Bold
Text|Bold;fonts;bold

0

0

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=232,Text|Italic Command}\









\end

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

0

0

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}\









\end

227
Topic|Back
Topic|Back;Back

0

1
TopicMenu
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=221,Topic|Status}\
   {link=253,Topic|Preview}\




\end

118
Bitmaps
bitmaps

0

0

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

    {{}bitmap=<filename>}

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

The bitmap should be a .GIF file in the same directory as
the {link=107,HTML file}.  The <filename> should not contain
any DOS path information.

For instance, the following command:

    {{}bitmap=sample.gif}

will be displayed as

    {bitmap=sample.gif}

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

If you want to be able to compile and display the source as a Windows Help file,
then the {link=107,Help source file directory} should also contain a corresponding .BMP file.
When EditHelp compiles the file as a Windows Help file, it will change the
'.GIF' extension to '.BMP'.

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








\end

110
Menu Commands
menu commands;commands

2

0

The following menu commands are available:

   {list=8}{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}\
       {link=210,Save As TXT}\
       {link=2229,Save As WWW}\
       {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=2214,bmp=tool4.bmp}    {link=2214,Bitmap}\
       {link=2219,Bitmap Link}\

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

   {fontsize=25}{bold}Layout{fontsize=20}\
   {link=2220,bmp=tool5.bmp}    {link=2220,Heading}\
       {link=2224,List}\
       {link=240,Line}\
       {link=242,Centre}\

   {fontsize=25}{bold}Text{fontsize=20}\
       {link=231,Bold}\
       {link=232,Italic}\

   {fontsize=25}{bold}Topic{fontsize=20}\
       {link=214,Next topic}\
       {link=215,Prev topic}\
       {link=227,Back}\
       {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=221,Status}\
   {link=253,bmp=tool7.bmp}    {link=253,Preview}\

   {fontsize=25}{bold}HelpFile{fontsize=20}\
       {link=2204,Directories}\
       {link=2205,Status}\


\end

2205
HelpFile|Status
HelpFile|Status;Status

0

0

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

The Project Status dialog helps you keep track of how far you've got in developing
your HTML 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=2204,HelpFile|Directories}\









\end

2204
HelpFile|Directories
HelpFile|Directories;Directories

0

0

The HelpFile|Directories command allows you to specify the directory into which the
HTML (.HTM) File will be copied.

The {link=107,EditHelp source file} is always in the current directory but the
{link=107,HTML File} may be placed in any directory.

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









\end

221
Topic|Status
Topic|Status;Status

0

11
TopicMenu
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 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=253,Topic|Preview}\




\end

220
Topic|Contents
Topic|Contents;Contents

0

4
TopicMenu
The Topic|Contents command toggles whether the current {link=106,topic} is the
Contents topic.

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=221,Topic|Status}\
   {link=253,Topic|Preview}\




\end

2201
Topic|Caption
Topic|Caption;Caption

0

3
TopicMenu
The Topic|Caption command changes the
{link=106,topic number} and {link=108,caption} 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=221,Topic|Status}\
   {link=253,Topic|Preview}\




\end

218
Topic|Delete
Topic|Delete;Delete

0

5
TopicMenu
The Topic|Delete command deletes the current {link=106,topic} from the EditHelp source file.

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=221,Topic|Status}\
   {link=253,Topic|Preview}\




\end

2202
Topic|Goto
Topic|Goto;Goto

0

6
TopicMenu
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=106,topic number} or {link=108,caption}.

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=221,Topic|Status}\
   {link=253,Topic|Preview}\




\end

216
Topic|New topic
Topic|New topic

0

8
TopicMenu
The Topic|New Topic command creates a new {link=106,topic}.
Each topic should have a unique {link=106,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=221,Topic|Status}\
   {link=253,Topic|Preview}\




\end

215
Topic|Prev topic
Topic|Prev topic

0

10
TopicMenu
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=221,Topic|Status}\
   {link=253,Topic|Preview}\




\end

214
Topic|Next topic
Topic|Next topic

0

9
TopicMenu
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=221,Topic|Status}\
   {link=253,Topic|Preview}\




\end

213
Search|Next
Search|Next;Next

0

0

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}\









\end

2209
Search|Replace
Search|Replace;Replace

0

0

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}\









\end

2210
Search|Find
Search|Find;Find

0

0

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}\









\end

209
Edit|Delete
Edit|Delete;Delete

0

0

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=2214,Edit|Bitmap}\









\end

208
Edit|Paste
Edit|Paste;Paste

0

0

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=2214,Edit|Bitmap}\









\end

207
Edit|Copy
Edit|Copy;Copy

0

0

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=2214,Edit|Bitmap}\









\end

206
Edit|Cut
Edit|Cut;Cut

0

0

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=2214,Edit|Bitmap}\









\end

205
Edit|Undo
Edit|Undo;Undo

0

0

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

Undo only works with actions performed on the EditHelp source file 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=2214,Edit|Bitmap}\









\end

204
File|Exit
File|Exit;Exit

0

0

The File|Exit command exits from the EditHelp program. If you've
made changes to the {link=107,EditHelp source file}, 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=210,File|Save As TXT}\
   {link=2229,File|Save As WWW}\
   {link=401,File|WWW Mode}\



\end

203
File|Save As
File|Save As;Save As

0

0

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

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

See also\
   {link=200,File|New}\
   {link=201,File|Open}\
   {link=202,File|Save}\
   {link=210,File|Save As TXT}\
   {link=2229,File|Save As WWW}\
   {link=401,File|WWW Mode}\
   {link=204,File|Exit}



\end

202
File|Save
File|Save;Save

0

0

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

If the current EditHelp source file 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=210,File|Save As TXT}\
   {link=2229,File|Save As WWW}\
   {link=401,File|WWW Mode}\
   {link=204,File|Exit}



\end

201
File|Open
File|Open;Open

0

0

The File|Open command opens an existing {link=107,EditHelp source file} that was created
using EditHelp. EditHelp 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=210,File|Save As TXT}\
   {link=2229,File|Save As WWW}\
   {link=401,File|WWW Mode}\
   {link=204,File|Exit}



\end

200
File|New
File|New;New

0

0

The File|New command creates a new EditHelp source file with one empty {link=106,topic}.

See also\
   {link=201,File|Open}\
   {link=202,File|Save}\
   {link=203,File|Save As}\
   {link=210,File|Save As TXT}\
   {link=2229,File|Save As WWW}\
   {link=401,File|WWW Mode}\
   {link=204,File|Exit}



\end

108
Caption
caption

0

0

Every {link=106,topic} may optionally have a Caption. The HTML Browser
will display the caption in larger bold text at the head of the topic screen.

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









\end

107
Files
files;help file;source file

0

0

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.

The HTML file is created as:

    <directory><filename>.htm

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









\end

106
Topics
topics

0

0

A Windows Help File may contain several {link=106,Topics}.
Each topic is a "page" full of information  describing a particular subject.
Each topic must have a unique 'topic number'.

One of the Topics a designated the '{link=220,Contents}' Topic. This is usually the first page
that the user should read and will contain {link=2207,Links} which eventually lead to all the other
Topics.

EditHelp extends these concepts to {link=107,HTML Files}. An HTML file can
contain only a single topic.
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,EditHelp 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=106,topic number} padded with '0' to 5 digits.
For instance, Topic 117 of the source 'edithelp.edh' will be written as:

    edi00117.htm

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

See also\
    {link=107,file names}\
    {link=2201,Topic|Caption} \
    {link=220,Contents} \









\end

102
Tabs
tabs

0

0

A Tab character in the {link=107,EditHelp source file} (.EDH) will be translated
into a single blank in the {link=107,HTML File}.

If you compile the source into a Windows Help file then Tab characters
will be translated into tabs in the Help File.









\end

101
Comments
comments

0

0

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
0

0

The EditHelp program creates hypertext files for use with the Windows
help system. It can also 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.

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

To view an HTML file created by EditHelp, you will need an HTML Browser
such as 'Mosaic'.

An HTML File may contain links and bitmaps.
As you develop your HTML File, EditHelp helps you keep track of
the {link=2205,status} of each topic.

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

    {link=107,Files}\
    {link=106,Topics}\
    {link=114,Text Layout}\
    {link=115,Text Commands}\

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

    edithelp.edh

See also\
    {link=110,Menu Commands}








\end

2207
Edit|Link
Edit|Link;links

0

0

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

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

where <num> is the {link=106,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.

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.

A link can specify 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=2214,Edit|Bitmap}\
   {link=2219,Edit|Bitmap Link}\









\end

114
Text Layout
text layout;layout

0

0

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,HTML File}.

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

    Single newlines are\
    ignored in\
    the text

is diplayed by the HTML Browser 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 diplayed 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 diplayed as:

    Single newlines\
    are ignored.

Trailing blanks on a line are deleted; a single trailing blank is then added.

Lines must have fewer than 255 characters.

Text can be displayed {link=231,bold} or {link=232,italic}.

See also\
    {link=115,Text Commands}
    {link=2220,Heading command}\
    {link=240,Line command}\
    {link=2224,List Command}\
    {link=242,Centre command}\









\end

115
Text Commands
text commands;commands

0

0

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

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

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

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

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

    {{}bitmap=<filename>}

where <filename> is the name of a GIF 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=242,Centre command}\









\end

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

0

0

The File|Save As TXT command saves the current source to a file as
plain ASCII text. All formatting and link commands are removed.
The text file will have the name:

    <filename>.TXT

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

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

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=2229,File|Save As WWW}\
   {link=401,File|WWW Mode}\
   {link=204,File|Exit}



\end

228
Topic|Goto Unfinished
Topic|Goto Unfinished;Goto Unfinished

0

7
TopicMenu
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=253,Topic|Preview}\




\end

2214
Edit|Bitmap
Edit|Bitmap;Bitmap

0

0

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 GIF files.

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

If you want to be able to compile and display the source as a Windows Help file,
then the {link=107,source file directory} should also contain a corresponding .BMP file.
When EditHelp compiles the file as a Windows Help file, it will change the
'.GIF' extension to '.BMP'.

See also\
   {link=205,Edit|Undo}\
   {link=206,Edit|Cut}\
   {link=207,Edit|Copy}\
   {link=208,Edit|Paste}\
   {link=209,Edit|Delete}\








\end

2231
New File Link
New File;File;Topic

0

0

A {link=2207,Link} command with the format:

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

where '<newFile>' is the name of a HTML File,
specifies a link to topic number <num> of file <newFile>.
('<text>' is the link-text to be displayed.)
The name of the file containing the destination topic is

    <fil><nnnnn>.htm

where <fil> is the first three characters of <newFile>
and <nnnnn> is the {link=106,topic number}, <num>, padded with '0' to 5 digits.

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

If <num> is zero then the link will be made to the file

    <newFile>.htm

in other words, the {link=220,Contents} topic of <newFile>.

For instance:

    {{}link=[e-mail],See also}

specifies a link to

    edi00117.htm

And:

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

specifies a link to

    other.htm

If you compile a {{}link=0@<newFile>,...} to a Windows Help file, then a link
will be inserted to <newFile>.HLP with the context string set to "index" .








\end

255
Bulleted List
Bulleted List;List

0

0

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
bullet. The List is terminated by:

    {{}list=0}

For instance:

    {{}list}{{}bold}Cut: {{}bold}deletes the selected text and places it \
           onto the Clipboard.\\
    {{}bold}Copy: {{}bold}copies the selected text onto the Clipboard. \\
    {{}bold}Paste: {{}bold}pastes a copy of the Clipboard contents at the \
            insertion point or replaces selected text in the current topic.\\
    {{}list=0}

is shown as

    {list=3}{bold}*    Cut: {bold}deletes the selected text and places it
           onto the Clipboard.\
    {bold}*    Copy: {bold}copies the selected text onto the Clipboard. \
    {bold}*    Paste: {bold}pastes a copy of the Clipboard contents at the
            insertion point or replaces selected text in the current topic.\\
    {list=0}

where {bold}*{bold} is a bullet.

{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

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. (The value of 'n' is important only
if you compile the source to a Windows Help file.)

Each of the following paragraphs is divided into two columns. The first column shows
the list item name, while the second shows the item text. The columns are separated by
a Tab character.

The List is terminated by:

    {{}list=0}

For instance:

    {{}list=15}{{}bold}Cut:{{}bold}<tab>deletes the selected text and places it \
           onto the Clipboard.\\
    {{}bold}Copy{{}bold}<tab>copies the selected text onto the Clipboard. \\
    {{}bold}Paste{{}bold}<tab>pastes a copy of the Clipboard contents at the \
            insertion point or replaces selected text in the current topic.\\
    {{}list=0}

(where <tab> is a Tab character) is shown as

    {list=15}{bold}Cut:{bold}    deletes the selected text and places it
           onto the Clipboard.\
    {bold}Copy{bold}    copies the selected text onto the Clipboard. \
    {bold}Paste{bold}    pastes a copy of the Clipboard contents at the
            insertion point or replaces selected text in the current topic.\
    {list=0}


The List command may only appear at the start of a {link=114,paragraph}.
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}\






\end

253
Topic|Preview
Topic|Preview;Preview

0

0

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

To view the topic as it will appear on the World Wide Web, you should use an HTML
browser which can display local files.

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}\




\end