Module erlydtl

Public interface for ErlyDTL.

Copyright © 2008 Roberto Saccon, Evan Miller 2014 Andreas Stenius

Introduced in: 2007-11-11 by Roberto Saccon, Evan Miller 2014 by Andreas Stenius -------------------------------------------------------------------

Authors: Roberto Saccon (rsaccon@gmail.com) [web site: http://rsaccon.com], Evan Miller (emmiller@gmail.com), Andreas Stenius (kaos@astekk.se).

Description

Public interface for ErlyDTL

Data Types

compile_option()

compile_option() = compiler_option() | auto_escape | binary | binary_strings | force_recompile | no_env | no_load | {blocktrans_fun, Trans::fun((Block::iodata(), Locale::string()) -> iodata() | default)} | {blocktrans_locales, [string()]} | {compiler_options, [compiler_options()]} | {custom_filters_modules, [Module::atom]} | {custom_tags_dirs, [filename()]} | {custom_tags_modules, [Module::atom]} | {default_libraries, [Name::atom()]} | {doc_root, filename()} | {extension_module, Module::atom()} | {libraries, [{Name::atom(), Module::atom()}]} | {locale, string()} | {out_dir, false | filename()} | {reader, {Module::atom(), Function::atom}} | {reader_options, [{Name::atom(), iodata()}]} | {record_info, [{Name::atom(), [Field::atom()]}]} | {scanner_module, Module::atom()} | {vars, [{atom(), iodata()}]}

compile_options()

compile_options() = [compile_option() | {atom(), term()}]

compiler_option()

compiler_option() = return | return_warnings | return_errors | report | report_warnings | report_errors | warnings_as_errors | debug_info | verbose

compiler_options()

compiler_options() = compiler_option() | compile:option()

err_ret()

err_ret() = error | {error, errors(), warnings()}

error_info()

error_info() = {File::list(), [{location(), Module::atom(), ErrorDesc::term()}]}

errors()

errors() = [error_info()]

filename()

filename() = file:name_all()

location()

location() = none | position() | {Line::position(), Column::position()}

ok_ret()

ok_ret() = {ok, Module::atom()} | {ok, Module::atom(), warnings()}

position()

position() = non_neg_integer()

warnings()

warnings() = [error_info()]

Function Index

compile/2
compile/3
compile_dir/2
compile_dir/3
compile_file/2
compile_file/3
compile_template/2
compile_template/3

Function Details

compile/2

compile(FileOrTemplate, Module::atom()) -> {ok, Module::atom()} | error

compile/3

compile(FileOrTemplate, Module::atom(), Options::compile_options()) -> ok_ret() | err_ret()

compile_dir/2

compile_dir(DirectoryPath::filename(), Module::atom()) -> {ok, Module::atom()} | error

compile_dir/3

compile_dir(DirectoryPath::filename(), Module::atom(), Options::compile_options()) -> ok_ret() | err_ret()

compile_file/2

compile_file(File::filename(), Module::atom()) -> {ok, Module::atom()} | error

compile_file/3

compile_file(File::filename(), Module::atom(), Options::compile_options()) -> ok_ret() | err_ret()

compile_template/2

compile_template(Template::iodata(), Module::atom()) -> {ok, Module::atom()} | error

compile_template/3

compile_template(Template::iodata(), Module::atom(), Options::compile_options()) -> ok_ret() | err_ret()


Generated by EDoc