Reference

All Reference

acceptable_password

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

acceptance

Check if an input value evaluates to true.

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

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

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

Admin

admin_tasks redirect_incat

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_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:

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.

backup

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

backup

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

Backup

backup_start

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:

Binaries

first last length to_binary

block

See also

brlinebreaks

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

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.

category

This model can retrieve information about the resource category hierarchy in different ways.

catinclude

See also

center

Centers the value in a field of a certain width using spaces.

Character escaping

brlinebreaks escape escape_check escape_ical escape_link escapejs escapejson escapexml fix_ampersands force_escape…

chart_pie

Show a pie chart.

chart_pie3d

Show a pie chart with 3D effect.

chunk

This filter splits a list in shorter lists. It splits an array in sub-arrays of at most a given length. This is useful…

client_local_storage

Model to access the localStorage on the client (browser).

client_session_storage

Model to access the sessionStorage on the client (browser).

Command-line

The zotonic command runs a number of utility commands which all operate on a Zotonic instance.

comment

Model for comments attached to resources. It provides listing, moderation checks, counting, and retrieval of individual…

comment

Ignore part of a template.

config

Zotonic has two places where a site's configuration is kept:

Config

config_delete config_toggle dialog_config_delete dialog_config_edit dialog_config_new

config_delete

Trigger the deletion of a configuration value. Used in the admin.

config_toggle

Toggle a configuration value. Used in the admin, for instance when displaying a “live” checkbox the state of which…

Configuration

Global configuration Site configuration Port configurations

confirm

Show a JavaScript confirm message and on confirmation triggers one or more actions and/or sends a postback to the…

confirmation

Check if two inputs are the same.

content_group

Model for content-group checks, currently exposing whether a content group is in use.

controller_admin

The admin controller is the main controller behind which admin pages are served. Its main purpose is that it does an…

controller_admin_backup

Shows the admin backup screen where you can download nightly backups that were made by mod_backup.

controller_admin_backup_revision

Shows the admin backup revisions screen where you can see older version for a resource.

controller_admin_category_sorter

Shows the admin category screen where you can edit the category tree, rearranging the categories, adding new categories

controller_admin_comments

Shows an admin screen with an overview of most recently created comments. The screen offers the option to moderate the…

controller_admin_comments_settings

Shows an admin settings screen where you can edit settings related to mod_comment.

controller_admin_config

Shows the admin config editor. Here you can edit the key/value pairs of m_config.

controller_admin_edit

The main admin edit controller. This controller serves the edit page where resources can be edited.

controller_admin_mailinglist

This controller shows the mailing lists that are available in the system.

controller_admin_mailinglist_recipients

Shows the recipients of the current mailing list. The recipients are listed in three columns, and have a checkbox next…

controller_admin_mailing_preview

This controller shows a preview of what a resource that is being mailed would look like, in a popup window.

controller_admin_mailing_status

This controller shows the mailing status of a resource. It lists each mailing list available in the system, and shows…

controller_admin_media_preview

A controller for rendering preview thumbnails of any media embedded in a richtext-editor component of a resource on the…

controller_admin_module_manager

Shows the list of Zotonic modules currently known to the system.

controller_admin_referrers

Shows the list of pages ( resources) which refer to this resource through an edge.

controller_admin_seo

Shows a form with settings related to Search Engine Optimization.

controller_api

controler_api processes authorized REST API requests: It provides an easy way to create API calls to allow computer…

controller_authentication

This controller manages all authentication cookies. It is called by the auth model in the browser.

controller_file

Serve an uploaded-, resized- or library file.

controller_file_id

Redirect to the controller controller_file.