ML-Module: doc_help Package: mldoc

Description

This is the Help frontend. It can be used to handle MlDoc documents with various backend modules. First, a document must be loaded. Either, you use the atoms_of_file and the tree_of_atoms functions from Doc_core module, finally loaded with help_load function, or you use the help_file function to load a document.



Programming Interface
type  h_sec     =   {   mutable  h_sec_keywords: string list ;
mutable  h_sec_ds: structure_block ref ;
mutable  h_sec_env: section_names list ;
mutable h_type: string }
type  s_help     =   {   mutable  h_sections: h_sec list ;
mutable  h_subsections: h_sec list ;
mutable  h_units: h_sec list ;
mutable h_main: structure_block }
[  help : s_help  ]  =  help_of_doc
~ds : structure_block
[  unit  ]  =  help_load
~ds : structure_block
[  unit  ]  =  help_file
~fname : string
type  help_Device     =     Help_TTY |   Print to stdout
Help_ASCII |   Print to file: ASCII text
Help_HTML |   Print to file: HTML
Help_LATEX    Print to file: Latex
[  unit  ]  =  help_dev
~dev : help_device
[  unit  ]  =  help
~name : string

The help_dev function can be used to change the output device. Default is the Help_TTY device. The help function uses the keyword or name string to search the help database. The search results will be shown.

Example 
let at = atoms_of_file "mldoc.man" in 
let ds = tree_of_atoms at in 
help_load ds;

Module dependencies

  • Doc_core
  • Doc_html
  • Doc_latex
  • Doc_text




UP Package: mldoc