4.5.1 Module anvl_texinfo

A plugin for creating and compiling GNU TexInfo files.

4.5.1.1 Types

doc_format()

-type doc_format() :: info |
                      docbook |
                      html |
                      epub3 |
                      latex |
                      plaintext.

4.5.1.2 Functions

texi_escape/1

-spec texi_escape(iodata()) -> iodata().

Escape @, { and } symbols.

gen_src_dir(Components)

-spec
     gen_src_dir([anvl_fn:component()]) -> file:filename().

Directory where generated TexInfo sources are found.

compiled(A, B, C)

-spec compiled(anvl_project:t(), file:filename(),
               doc_format()) -> anvl_condition:t().

Condition: a source file DocSrc in project Project is compiled to format Format.

compiled(A)

-spec
     compiled(anvl_project:t()) -> anvl_condition:t().

Condition: all texinfo sources listed in the project configuration are compiled to all formats requested by the project.

available()

-spec available() -> boolean().

Check if the system has texi2any executable necessary for building TexInfo.

anvl_plugin_documented(A)

Condition: documentation for the Plugin has been extracted.

This condition is specific for ANVL plugins.


JavaScript license information