Prev Next

Example Using Verbatim Inclusion of a Text File

verbatim
The verbatim command enables one to include all of part of a text file. This avoids having to maintain a separate copy of the corresponding information in the documentation. (For example, the output of a program which might change over time.)

Execute The Following Steps

verbatim_example.omh
Use an editor of your choice to create the file verbatim_example.omh in the test directory with the following contents:
     
$begin
verbatim_example$$
     $spell
     	dat
     $$
     
     $section Example Inclusion of Text File Information$$
     
     $head Contents of verbatim_example.dat$$
     $verbatim%verbatim_example.dat%5%$$
     
     $head Just Program Output$$
     $fixed
     $verbatim%verbatim_example.dat%5%PROGRAM OUTPUT%$$
     $$
     
     $head Just Input Parameters$$
     $code
     $verbatim%verbatim_example.dat%5%INPUT PARAMETERS%PROGRAM OUTPUT%$$
     $$
     
     
     $end
Note that you can copy and paste the commands above to your editor window. You may just copy the file with the same name from the getting started directory .

Example In This Web Site Context
You can view the result of making verbatim_example.omh part of the OMhelp help web site by selecting verbatim_example .

Execute OMhelp
In a command window and in the htm directory execute the following command
 
     omhelp ../verbatim_example.omh -noframe

Example by Itself
Use a web browser of your choosing to view the file test/htm/verbatim_example.htm .
Input File: getstarted/start_verbatim.omh