Introduction
The begin
command starts a new section
and the $end command ends the current section.
An OMhelp section is defined
as the content between a $begin and $end command.
The argument to a
section
command specifies the title
for the current section.
Install
The first step is to
install
OMhelp on your system.
Then you can run any of the following examples:
Test Directory
Create an empty directory with a name of your choosing
that we will refer to as test below.
simple_example.omh
Use the editor of your choice to
create the file test/simple_example.omh
with the following contents:
$begin
simple_example$$
$section Simple Example$$
$end
Note that you can copy and paste the commands above
into your editor window.
You may just copy the file with the same name from the
getting started directory
.
Execute OMhelp
In a command window and in the directory test/htm,
execute the following command
omhelp ../simple_example.omh -noframe
Example by Itself
If you use a web browser of your choosing to view the file
test/htm/simple_example.htm,
Simple Example is displayed as the title of the web page
(and that is all that is displayed).
Output File
The file
simple_example.htm is created by running the omhelp
command above.
It contains the HTML version of this web page.
Input File: getstarted/start_simple.omh