Example Using Verbatim Inclusion of a Text File

Example Using Verbatim Inclusion of a Text File
verbatim
verbatim_example.omh
verbatim_example.dat
Execute Example
Example In This Web Site

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

verbatim_example.omh
Use the editor of your choice to create the file verbatim_example.omh in the xam directory with the following contents:

 
     $begin verbatim_example$$
     $spell
     	dat
     $$
     
     $section Example Inclusion of Text File Information$$
     
     $head Contents of verbatim_example.dat$$
     $verbatim%omh/getstarted/verbatim_example.dat%5%$$
     
     $head Just Program Output$$
     $fixed
     $verbatim%omh/getstarted/verbatim_example.dat%5%PROGRAM OUTPUT%$$
     $$
     
     $head Just Input Parameters$$
     $verbatim%omh/getstarted/verbatim_example.dat%
     	5%INPUT PARAMETERS%PROGRAM OUTPUT%0
     %$$
     
     
     $end

You can also just copy verbatim_example.omh from the omh/getstarted directory .

verbatim_example.dat
Copy omh/getstarted/verbatim_example.dat from the omh/getstarted Directory to the xam directory . In the copy of verbatim_example.omh, change omh/getstarted/verbatim_example.dat to verbatim_example.dat.

Execute Example
Once you have copied the files mentioned above, you can execute omhelp with example_name equal to verbatim_example.

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

Input File: omh/getstarted/start_verbatim.omh