ML-Module: doc_latex

Package: mldoc

Description

This is the Tex backend module used to convert MlDoC documents in Plain-TeX/Latex format. This tex_of_tree function is used to convert the structure_block graph to TeX output.

Programming Interface

[  unit  ]  =  tex_of_tree ~ds : structure_block -> ~options : tex_options list -> ~sections : section_names list

The tex_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:

TEX_doc_name of string	The name of the output file. The default setting is manual.tex .
TEX_head_inline	Don't perform a page break on section boundaries.
TEX_color	Ouput colored manual pages. Special color commands for dvips are created. Default is color off.
TEX_no_toc	Don't print a table of content. Default is print a TOC.
TEX_link_ref	Generate links in the manual (page references). Default is no links.

sections

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

LaTeX package dependencies

The following packages are used by the Doc_latex module:

• newcent
• pifont
• color[dvips]

Most common LaTeX/TeX distributions are shipped with these packages.

Module dependencies:

• Doc_core

UP Package: mldoc