Up

module Omd_main

: sig
#
val remove_comments : Omd_representation.tok list -> Omd_representation.tok list

remove_comments l returns l without OMD comments.

#
val remove_endline_comments : Omd_representation.tok list -> Omd_representation.tok list

remove_endline_comments l returns l without OMD endline-comments.

#
val preprocess_functions : (Omd_representation.tok list -> Omd_representation.tok list) list Pervasives.ref

preprocess_functions contains the list of preprocessing functions

#
val preprocess : Omd_representation.tok list -> Omd_representation.tok list

preprocess l returns l to which all preprocessing functions (in reference preprocess_functions) have been applied.

#
val otoc : bool Pervasives.ref

flag: output the table of contents only.

#
val toc : bool Pervasives.ref

flag: replace "*Table of contents*" by the table of contents.

#
val omarkdown : bool Pervasives.ref

flag: output Markdown instead of HTML.

#
val notags : bool Pervasives.ref

flag: output HTML but without HTML tags, so it's not really HTML anymore.

#
val toc_depth : int Pervasives.ref

flag: depth of table of contents

#
val toc_start : int list Pervasives.ref

flag: first header level for table of contents

#
val nl2br : bool Pervasives.ref

flag: convert newlines to "<br/>" when output is HTML

#
val omd_gh_uemph_or_bold_style : bool Pervasives.ref

flag: set on the command line, used for instanciating the functor Omd_parser.Make

#
val omd_blind_html : bool Pervasives.ref

flag: set on the command line, used for instanciating the functor Omd_parser.Make

#
val omd_strict_html : bool Pervasives.ref

flag: set on the command line, used for instanciating the functor Omd_parser.Make

#
val protect_html_comments : bool Pervasives.ref

flag: for multiple dashes in HTML comments, replace dashes by &#45;

#
val patch_html_comments : Omd.element list -> Omd.element list

patch_html_comments l returns the list l where all Html_comments s have been converted to Html_comments s', where s' means s with dashes replaced by &#45; except for single dashes (which are left untouched).

N.B. It seems that it's not valid to have double dashes inside HTML comments (cf. http://validator.w3.org/check). So one way to make life somewhat easier is to patch the comments and transform inner dashed to &#45;.

#
val tag_toc : Omd_representation.tok list -> Omd_representation.tok list

tag_toc l returns l where *Table of contents* has been replaced by a tag that can generate a table of contents.

#
val main : unit -> unit

main function

end