ML-Module: doc_text

Package: mldoc

Description

This is the ASCII-Text backend module used to convert MlDoC documents in generic Text format. This text_of_tree function is used to convert the structure_block graph to text output.

Programming Interface

[  unit  ]  =  text_of_tree ~ds : structure_block -> ~options : text_options list -> ~sections : section_names list

The text_of_tree function needs three arguments:

Arguments

ds

This is the structure block tree previously generated with the atoms_of_ function family.

options

Several options can control the converting behaviour and the output. Available options:

TEXT_doc_name of string	The output file name if any. Without this option, the output is printied to the current standard out channel.
TEXT_terminal	Enhanced text ouput with special terminal control command (underlined...). Default is no special commands.
TEXT_notoc	Don't print a table of content.

sections

To convert only a part of a manual, for example a module like this, some informations are needed about sections above this section.

Module dependencies:

• Terminfo (OCaML)
• Doc_core

UP Package: mldoc