Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/niamtokik/erml
An HTML (and template) engine made in Erlang
https://github.com/niamtokik/erml
Last synced: about 5 hours ago
JSON representation
An HTML (and template) engine made in Erlang
- Host: GitHub
- URL: https://github.com/niamtokik/erml
- Owner: niamtokik
- License: mit
- Created: 2024-04-27T14:35:04.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-04-27T14:36:35.000Z (7 months ago)
- Last Synced: 2024-04-27T15:36:19.989Z (7 months ago)
- Language: Erlang
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# erml
An html library for Erlang, and an sandbox for Erlang, Cowboy, Htmx
Spectre, Mnesia (ECHSM).
Main goals:
- simplicity
- flexibility
- extensibility
- portability
Secondary goals:
- htmx compatible
- spectre css compatible
- templating libraries for common usage
- optimized compilation
## Build
```erlang
rebar3 compile
```
## Usage
```erlang
{html, [
{head, [
{title, <<"my website">>},
{meta, #{ name => "twitter:card", content => "summary"}}
]},
{body, [
]}
]}.
```
## Documentation
| **Stability** | **Elements** | **Notes** |
|---------------|--------------|-----------|
| |
| | **Standard Elements**
|s| `{Tag, Content}` | Create an html element without attributes
|s| `{Tag, Attributes, Content}` | Create an html element with attributes
|s| `{{empty, Tag}, Attributes}` | Create an empty element
|s| `{content, Content}` | Add raw content
| |
| | **Variables**
|s| `{Variable}` | Insert a variable
| |
| | **Inclusion**
|u| `{include, Path}` | include an erml file
|u| `{include, Path, Opts}` | include an erml file with custom options
|u| `{include_raw, Path}` | include a raw file
|u| `{include_raw, Path, Opts}` | include a raw file with custom options
|u| `{template, Type, Data, Param}` | insert a template
|u| `{template_file, Type, Filename, Param}` | insert a template file
| |
| | **Functions/Modules call**
|s| `{apply, Module, Function, Arguments}` | call a module/function
|s| `{apply, Function, Arguments}` | call a function
|s| `{apply, Function}` | call a function
| |
| | **Process Call**
|u| `{call, Pid, Message}` | call a gen_server process
|u| `{call, Pid, Message, Timeout}` | call a gen_server process
|u| `{gen_server, call, Pid, Message}` | call a gen_server process
|u| `{gen_server, call, Pid, Message, Timeout}` | call a gen_server process
|u| `{gen_statem, call, Pid, Message}` | call a gen_statem process
|u| `{gen_statem, call, Pid, Message, Timeout}` | call a gen_statem process
Where `u`: unstable; `s`: stable
### Creating Standard Elements
Standard elements are creating using tuples with 2 or 3 elements. A
simple element can be created with an empty list.
```erlang
{html, []}.
```
```html
```
Attributes can be added.
```erlang
{html, #{id => "page"}, []}.
```
```html
```
Other elements can be added as contents.
```erlang
{html, #{},
{body, []}
}.
```
```html
```
```erlang
{html, #{}, [
{head, []},
{body, []}
]}.
```
```html
```
It supports also empty elements.
```erlang
{{empty, image}, #{}}.
```
```html
```
```erlang
{{empty, image}, #{id => test}}
```
```html
```
```erlang
{{empty, image}, [selected]}.
```
```html
```
Few elements are empty by default, and the content will be
automatically converted as attributes or ignored.
```erlang
{meta, #{name => "twitter:card", content => "summary"}}.
```
```html
```
### Using Variables
Variables are created using tuples with one element and defined in
`variables` parameters key.
```erlang
% define variables
Options = #{
variables => #{
test => <<"hello world!">>
}
}.
% create erml template
Erml = {body, [
{p, {test}}
]}.
% compile it.
erml:compile(Erml, Option).
```
```html
hello world!
```
Variables can also includes erml data structure.
```erlang
% define variables
Options = #{
variables => #{
test => {span, #{class => "bold"}, <<"hello world!">>}
}
}.
% create erml template
Erml = {body, [
{p, {test}}
]}.
% compile it.
erml:compile(Erml, Option).
```
```html
hello world!
```
### Including Templates and Files
Files and templates can be added from a specific path. By default,
`priv` directory is used as root.
```erlang
{body, [
{include_raw, "examples/erlang-punch/lorem_ipsum.txt"}
]}.
```
```html
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
```
`erml` files can also be added.
```erlang
{body, [
{include, "examples/erlang-punch/hero_01.erml"}
]}.
```
```html
...
```
One can also use a templating system to insert different kind of
content.
```erlang
{body, [
{template, bbmustache, <<"{{test}}">>, #{"test" => "hello world!"}}
]}.
```
```html
hello world!
```
### Calling Functions and Modules
Functions and modules can be called.
```erlang
{body, {apply, fun() -> {ok, <<"hello world!">>} end}}.
```
```html
hello world!
```
### Calling Running Processes
Active processes using `gen_server` or `gen_statem` can be called.