$ Help Text syntax
# syntax
K Help Text Syntax;Text Syntax;Syntax
@ Help Text Syntax

{\b In start of the topic (these must follow immediately the previous topic):}
 
 * build tag
          Specifies a build tag. Optional
 $ Title String
          Specifies the title used in Help History. Required
 # context
          Used when creating hyperlink/definitions to this topic. Required
 K Keyword
          Specifies a keyword for Search. Separate multiple keywords by ';' (semicolon). Optional
 + browse seq
          Specifies browse sequence. Optional
 ! Macro()
          Starts =Windows Help Macro=[help_macros]. optional

also defined by Help Text Format, if followed immediately the previous definitions:
 @ Title
          Specifies a non-scrolling title at top of the Help topic. Optional


{\b After the previous definitions starts the topic text:}

Any 8-bit ascii text is accepted, also =rtf-statements=[!JumpKeyword("tcwhelp.hlp", "RTF Tokens")] {\fs16 (link)}. If ' \_ ', ' \= ', ' \[ ' or ' \] ' -characters are used, they must be preceded by ' \\ ' (backslash). Backslash (\\) must be written \\\\. For example you should write: "Type in \\\=Command() to start the macro" if you want the \= to be displayed.

Definition:
	\_text to be defined\_\[context\]
Hyperlink:
	\=topic to jump to\=\[context\]
'context' must be defined as a context string in one of the available topics. Don't leave space between \_ (or \=) and \[ !!

You can indent a paragraph by starting it with the '>'-character.

{\b Topic text ends with three minus signs in a beginning of a new line:}
 ---

{\b See also:}
    Using =windows Help Macros=[help_macros].
    Reference for =RTF tokens=[ !JumpKeyword("tcwhelp.hlp", "RTF Tokens") ] {\fs16(a link to Borland C++ 3.1 help)}.
    =Inserting links=[ insert_link ]
    =Inserting pictures=[ pictures ] in your Help file.
    =Syntax highlighting=[ highlight ].
---
$ Inserting pictures
# pictures
K Inserting pictures;Pictures;Bitmaps
@ Inserting pictures in your Help file

You can also insert pictures in your Help file. This is done with one of the following statements:

    {\b \\\'7bbmc {\i picture}\\\'7d} 	inserts a metafile or bitmap in the text
    {\b \\\'7bbml {\i picture}\\\'7d}	inserts a metafile or bitmap at the left margin
    {\b \\\'7bbmc {\i picture}\\\'7d} 	inserts a metafile or bitmap at the right margin

{\i picture} specifies the filename of the bitmap or the metafile (with .bmp or .wmf -extension). The picture must be in the same directory as the Help project.

An easier way to insert a picture without having to remember the above syntax, is to use the menu command {\b Edit->Insert Picture}. This prompts you with a dialog showing you all the BMP-files in your project directory. You can then choose the right picture, and it's placement (text, right or left margin) with the radio buttons. Pressing OK-button inserts the picture.

Pictures can also contain a hyperlink or definition. Simply insert picture in your Help Text with one of the previous statements, select the whole statement and =insert a link=[ insert_link ]. The result looks for example like this:

   {\b  \=\\\'7bbmc {\i picture.bmp}\\\'7d\=\[ picturedefinition \]}
---
$ Syntax highlighting
# highlight
K Syntax highlighting
@ Syntax highlighting

Help Text edit windows have a special syntax highlighting, which means, that the text is coloured when it has a special meaning. This helps the user to write the Help Text correctly.

Colours used in the syntax highlighting are:

Start of the topic:		red text
Non-scrolling title:		purple text
Defined or hyperlink text:	green text
Definition/hyperlink context:	blue text

See =Help Text syntax=[ syntax ].
---
$ Creating Help files with the HelpMaker - a step by step tutorial
# creatinghelp
K creating Help;tutorial;step by step
@  Creating Help files with the HelpMaker - A STEP BY STEP TUTORIAL

>{\i To print this topic press the following button}   =\{bmc print.bmp \}=[ !Print() ]

{\b When creating Help files with the HelpMaker you should do the following:}

{\b 1.  } Design your Help as you would design a book (contents, structure and so on). You will have title for your Help, topics and perhaps a map that shows how topics are linked together.

{\b 2.  } Select from the Project-menu item {\i Open project} and type a name for a new project.

{\b 3.  } Select from the Project-menu item {\i Add item}.

{\b 4.  } Either open an existing text-file or type a name for a new text-file
>As you pressed Enter or Ok-button the file information was automatically inserted in two places: into Files in project-window and into project-window's FILES-section.

{\b 5.  } You can now select from the Window-menu item {\i Show command-help}. There are explanations for all special characters that are used when defining header information for your topics.

{\b 6.  } Start typing your first topic by entering header information according to the command-help. Once your header is ready it could look like this:
>{\i $ Editing text}
>{\i # editingtext}
>{\i K editing;text;editor}

{\b 7.  } You must insert the{\i  $}-sign and {\i  #}-sign. They define the title string and context string. Context string is a unique identifier for that specific topic and it must {\b not} include special characters and spaces. All the other signs are optional. Still most commonly used are K for _keywords_[ keyword ] and @ for _non-scrolling title_[ nonscrollingtitle ]. Note that after those special characters there has to be a space. If header information is entered correctly it is highlighted with red color.

{\b 8.  } After this header information type the text you want for this topic. You can also insert pictures by selecting from the Edit-menu item {\i Insert picture}. If needed you can format text (indentation, bold, italic...) so that is more easily read.

{\b 9.  } When finishing the topic insert {\i three minus signs ---} so that HelpMaker can regognize {\i the end of the topic}. Now your topic-text should look like something like this:

>{\i $ Editing text}
>{\i # editingtext}
>{\i K editing;text;editor}

>{\i When editing text take care that you have the right mode on (overwrite/insert) and so on...}
>{\i ---}

{\b 10.} Then write the next topic the same way and remember to start typing that header-information (Title-string, context-string and so on) {\b immediately} after those three minus signs. Like this:
>{\i ---}
>{\i $ Topic2}

{\b 11.} Once you have created more than one topic you can create {\i hyperlinks} between topics. Or you can use another topic as a {\i definition} for another. For example, select one word from the first topic by double-clicking on it or just by painting it with the mouse pointer whilst the left mouse button is pressed down.

{\b 12.} Once you have selected the word (or more) either select from Context-menu item {\i Insert link} or press the {\i right mouse button} and you will get the dialog were you can define hyperlinks, definitions, WinHelp-macros or insert pictures and assign links to them.

{\b 13.} For example if you had {\i text1} as a selected text you will see that in a Hot text-field. Then you could select option {\i hyperlink} for the type and from Help contexts-listbox you could select  for example {\i topic2} to be the other end of the link. Then pressing the Ok-button generates the needed hyperlink definition in to the Help Text. Note that the color for this definition is green as it would be in the final Help file.

{\b 14.} Now you could type all the topics you need for your Help file and generate links between them according to your plan that you created before your project with the HelpMaker started. If needed you could use several topic-files in order to improve management of the project and structure of your Help file. Change the {\i project window information} (the window on the bottom of the screen) so that it will give people the right information about your Help file.

{\b 15.} Once you have saved everything select from the Compile-menu item {\i Make} or press F9-button and HelpMaker will convert files in to the RTF-format. After this has been succesfully done HelpMaker calls the Help Compiler (e.g. HC31.EXE) and gives it the rtf-files and modified .hpj -file as parameters. If there are no errors you will get the Success-message; otherwise the error messages from the Help Compiler will be shown to you.

{\b 16.} After succesful compilation you can run your Help file by pressing ctrl-F9 or by selecting from the Compile-menu item {\i Run}.

{\b 17.} Test your Help file and check that everything works as you planned. Fix the things you want to change, compile and run again.

These were the basic steps that you will go through every time you create a new Help file. You can use the HelpMaker for much more, if you learn more depths about rtf-tokens, voice effects, colortables and so on. Other possibilities that are available in the HelpMaker are {\i Build manual} and {\i Finishing touches} from the Project-menu.


=Contents=[ contents ]
=Terminology=[ terminology ]
---
$ Keyword
# keyword
K Keyword

Keywords are words that you specify to be found from the search dialog's list.
---
$ non-scrolling title
# nonscrollingtitle
K non-scrolling title

Non-scrolling title is stays on the top of the topic even when scrolling down the topic. So this title is seen always.
---
$ context string
# contextstring
K context string

Context string is the unique identifier for that specific topic.  It must {\b not} include special characters or spaces.
---
$ Terminology
# terminology
K terminology
@ Terminology

Here are listed some some words that might need some explanation for unexperienced users:

>_Keywords_[ keyword ]
>_Non-scrolling title_[ nonscrollingtitle ]
>_Context string_[ contextstring ]
---
