Prev

Next

Index-> contents reference index search external

Up-> omhelp get_started

Getting Started Using OMhelp
Introduction
Contents
omh/getstarted Directory
xam Directory
example_name
example_extension
Execute OMhelp
bin/get_started.sh

Introduction
The first step is to install OMhelp on your system. Then you can run any of the getting started examples listed below.

Contents

start_simple	Getting Started: A Very Simple Section
start_head	Headings and Subheadings Example
start_pre	Preformatted Text Example
start_font	Example Using Font Commands
start_spell	Spelling Command Example
start_latex	An Example Using Latex Math Formula Commands
start_image	An Example Using Images
start_verbatim	Example Using Verbatim Inclusion of a Text File
start_src	Example Including Source Code
start_block	OMhelp in Source Code Using Block Comments
start_oneline	OMhelp in Source Code Using One Line Comments
start_multiple	Multiple Input Files and Sections
start_cref	Example Cross References And Multiple Children in One File
start_index	An Indexing Example

omh/getstarted Directory
Each of the examples above request that you create one or more files using the editor of your choice. You can instead just copy the corresponding file from the directory omh/getstarted. This and the other directories and commands mentioned in this section are relative to the distribution directory .

xam Directory
We use xam as a temporary directory to copy files and run the examples.

example_name
The name of each example is specified by the documentation for the corresponding example.

example_extension
A few examples specify example_extension in their documentation. The default value, when it is not specified, is omh.

Execute OMhelp
This requires building and installing OMhelp and making sure it is in your execution path. It also requires copying the example file to the xam directory. In the directory xam/htm execute the following command
     omhelp ../example_name.example_extension -debug -noframe
Once this command has executed, use a web browser of your choosing to view the file
     xam/htm/example_name.htm

bin/get_started.sh
If you have the bash shell on your system, the command
     bin/get_started.sh
will copy the example files and run omhelp. It will run all of the getting started examples and allow your to inspect the results.

---

Input File: build/omh/getstarted/get_started.omh