Documentation

All Documentation

0.64.0

Welcome to Zotonic 0.64.0, released on March 4, 2022.

0.65.0

Welcome to Zotonic 0.65.0, released on March 17, 2022.

0.66.0

Welcome to Zotonic 0.66.0, released on May 24, 2022.

0.67.0

Welcome to Zotonic 0.67.0, released on July 5, 2022.

0.68.0

Welcome to Zotonic 0.68.0, released on July 21, 2022.

0.69.0

Welcome to Zotonic 0.69.0, released on August 30, 2022.

0.70.0

Welcome to Zotonic 0.70.0, released on September 16, 2022.

0.70.1

Welcome to Zotonic 0.70.1, released on September 26, 2022.

0.71.0

Welcome to Zotonic 0.71.0, released on October 18, 2022.

0.72.0

Welcome to Zotonic 0.72.0, released on November 21, 2022.

0.73.0

Welcome to Zotonic 0.73.0, released on December 8, 2022.

0.75.0

Welcome to Zotonic 0.75.0, released on March 2, 2023.

0.76.0

Welcome to Zotonic 0.76.0, released on April 4, 2023.

0.77.0

Welcome to Zotonic 0.77.0, released on May 25, 2023.

0.78.0

Welcome to Zotonic 0.78.0, released on June 29, 2023.

0.78.1

Welcome to Zotonic 0.78.1, released on July 6, 2023.

0.80.0

Welcome to Zotonic 0.80.0, released on November 21, 2023.

0.81.0

Welcome to Zotonic 0.81.0, released on January 12, 2024.

0.82.0

Welcome to Zotonic 0.82.0, released on March 25, 2024.

0.83.0

Welcome to Zotonic 0.83.0, released on June 27, 2024.

0.83.1

Welcome to Zotonic 0.83.1, released on August 6, 2024.

0.84.0

Welcome to Zotonic 0.84.0, released on August 29, 2024.

0.87.0

Welcome to Zotonic 0.87.0, released on February 4, 2025.

0.88.0

Welcome to Zotonic 0.88.0, released on March 13, 2025.

0.89.0

Welcome to Zotonic 0.89.0, released on July 1, 2025.

0.89.1

Welcome to Zotonic 0.89.1, released on July 3, 2025.

0.90.0

Welcome to Zotonic 0.90.0, released on September 4, 2025.

0.91.0

Welcome to Zotonic 0.91.0, released on February 4, 2026.

1.0.0_rc.10

Released on 2022-10-31.

1.0.0_rc.11

Released on 2022-11-11.

1.0.0_rc.12

Released on 2022-11-17.

1.0.0_rc.13

Released on 2022-12-05.

1.0.0_rc.14

Released on 2022-12-23.

1.0.0_rc.15

Released on 2023-01-30.

1.0.0_rc.16

Released on 2026-03-27.

1.0.0_rc.8

Released on 2022-09-13.

1.0.0_rc.9

Released on 2022-10-12.

acceptable_password

A validator to check whether a password conforms to the password secutiry requirements.

acceptance

Check if an input value evaluates to true.

Access control

Access control is about defining who is allowed to access certain resources. It takes two steps:

acl

The m_acl model gives access the id of the currently logged in user, and provides a mechanism to do basic access…

acl_mqtt

MQTT acl check, called via the normal acl notifications. Actions for these checks: subscribe, publish

ACL notifications

acl_context_authenticated acl_is_allowed acl_is_allowed_prop acl_is_owner acl_logoff acl_logon acl_mqtt acl_user_groups…

ACL options

Authorization checks to perform, in addition to the acl_action dispatch option, can be given in the acl dispatch option

acl_rule

Model for ACL rule inspection and helper checks in mod_acl_user_groups, including insert/move checks, upload limits

acl_user_group

Model for ACL user-group helper values in mod_acl_user_groups, including collaboration-group settings and category…

Actions

with_args

Activate/deactivate modules

Rescuing a dysfunctional site from the Zotonic shell.

add_class

Add a css class to an html element.

add_day

Adds a day to a date. The value must be of the form {{Y,M,D},{H,I,S}} .

add_hour

Adds an hour to a date. The value must be of the form {{Y,M,D},{H,I,S}} .

add_month

Adds a month to a date. The value must be of the form {{Y,M,D},{H,I,S}} .

add_week

Adds a week to a date. The value must be of the form {{Y,M,D},{H,I,S}} .

add_year

Adds a year to a date. The value must be of the form {{Y,M,D},{H,I,S}} .

Admin

admin_tasks redirect_incat

admin

This model exposes some meta-information for the use in mod_admin templates.

admin_blocks

Model for listing editable content blocks for a resource in the admin interface.

admin_config

Model for admin configuration views, including SSL certificate info, security directory info, and selected module…

Admin cookbook

Creating a custom widget on the edit page Customizing the layout of the admin edit page Customizing the style of an…

admin_dispatch

Dispatch rules Name Path Resource Args admin_user [“admin”,”users”] controller_admin [{template,”admin_users.tpl”}

admin_identity

Model for admin identity configuration values, including password policy regex and default category/content-group for…

admin_menu

This model holds the admin menu, which is built up by calling each module to add items to the menu.

admin_note

Add an editorial note to any resource.

admin_status

Model for admin status endpoints, including Zotonic version and health/status overview values.

admin_tasks

Action module which provides postback handlers for the “status” view of the admin:

Admin template specific things

Common markup in admin templates.

after

Return the first element after another element in a list. For example:

alert

Show an alert dialog.

All dispatch rules

All the dispatch rules from all modules. For a background on dispatch rules, see The URL dispatch system.

all_include

See also

animate

Add a $(..).animate jQuery call to the target element.

append

Appends the argument to the value.

as_atom

Convert a value to an Erlang atom.

auth2fa

Model for two-factor authentication state and setup, including TOTP QR/image generation, mode checks, reset checks, and…

authentication

Model for authentication state and login support checks, including password authentication flow helpers and reminder…

Authentication notifications

auth_checked auth_confirm auth_confirm_done auth_client_logon_user auth_client_switch_user auth_identity_types…

autoescape

Automatically apply HTML escaping to values.

Automatically add new users to a user group

Why When you create a person, you usually need to add it to a user group as well. You may want to automate this, in…

Automatic startup on system boot

Once you have Zotonic running, you want to make sure that it automatically starts up when the server reboots, so that…

backup

Model for backup configuration and operational status, including backup permissions, listing, directory, encryption…

Backup

backup_start

backup

Dispatch rules Name Path Resource Args admin_backup [“admin”,”backup”] controller_admin_backup [seo_noindex]…

backup_revision

Model for resource revision backup metadata, including revision list/title retrieval and revision retention settings.

backup_start

Action which starts a manual backup.

before

Return the first element before another element in a list. For example:

Best Practices

Creating sites Media Best Practices Template Best Practices and Pitfalls

Binaries

first last length to_binary

block

See also

brlinebreaks

Translate HTML <br/\> elements into ASCII newlines ( \n ).

Browser/server interaction

There are multiple ways to set up interaction between server-side Zotonic code and client-side JavaScript.

button

Makes a button with an action attached.

cache

Cache frequently used rendered template output for later reuse.

call

Call an Erlang function.

capfirst

Converts the first character of the value to uppercase.

catcompose

See also