Browse by topic

Discover Text

Explore related documentation through its most useful keyword groups.

1072 items

Grouped by Architecture

All Text

Models

backup

Model for backup configuration and operational status, including backup permissions, listing, directory, encryption settings, and active backup state.

Filters

pickle

Pickle an Erlang value so that it can be safely submitted with a form.

Models

custom_redirect

Model for custom redirect records, exposing redirect list and individual redirect lookup by id.

Filters

survey_any_correct_answer

Determine if any answer of a question was correct. Used for showing results of thurstone test questions.

Actions

form_reset

Resets the target form to its initial state.

Dispatch rules

mod_auth2fa dispatch rules

URL dispatch rules defined by mod_auth2fa in apps/zotonic_mod_auth2fa/priv/dispatch/dispatch.

Actions

mailing_page_test

Post a message to the test mailing list, given with the id argument.

Modules

mod_seo_sitemap

Creates a sitemap.xml file for your site, containing links to all publicly accessible pages.

Reference

Reference

All the nitty gritty details when the big picture has settled.

Validators

format

Regular expression test.

Validators

name_unique

A validator to check whether a resource’s name is unique:

Validators

length

Check the length of a text input.

Filters

as_atom

Convert a value to an Erlang atom.

Filters

split_in

This filter split a list in shorter lists. It splits an array in N sub-arrays of more or less equal length. This is useful when displaying a list of items in…

Filters

round_significant

Round a number value to a number of significant digits. The significance defaults to two digits.

Models

search

The m_search model provides access to different kinds of search queries for searching through models.

Filters

truncate_html

Truncate a HTML text to a maximum length.

Models

log

Model for runtime logging state and access to server log entries for clients allowed to read logs.

Filters

default

Provide an alternative value in case a value has a falsy value (0, false , undefined or empty string).

Modules

mod_wires

Actions, tags (also known as screen components), and javascript for user interfaces using wires .

Filters

member

Finds a value in a list.

Dispatch rules

mod_contact dispatch rules

URL dispatch rules defined by mod_contact in apps/zotonic_mod_contact/priv/dispatch/dispatch.

Filters

ip2country

Return the lowercase ISO country code associated with an IP address.

Tags

extends

Inherit markup from another template.

Actions

redirect

This action redirects the browser to another page or back to the previous page.

Scomp

pager

Show a pager for search results.

Actions

with_args

Apply actions with arguments added.

Filters

is_visible

Filter a list of resource ids so that only the visible ids remain.

Filters

translation

Lookup a specific translation in a translated text. If the text is not translated then the text is returned as-is.

Filters

language

Return the language the resource (or translated text) will be displayed in.

Actions

toggle

Toggle the visibility of an element.

Notifications

observe_email_bounced/2

Bounced e-mail notification. The recipient is the e-mail that is bouncing. When the the message_nr is unknown the it is set to ‘undefined’. This can happen if…

Models

site_update

Model for checking if a site has version control enabled.

Filters

tail

Fetch the tail of a list.

Filters

toc

Filter to derive a Table Of Contents from a HTML body.

Modules

mod_comment

Implements a basic commenting system, enabling commenting on resources.

Filters

lower

Translates the value to lower case.

Filters

in_past

Tests if a date is in the past.

Models

ssl_letsencrypt

Model for Let's Encrypt status information, available to administrators.

Modules

mod_syslog

Syslog integration module for forwarding Zotonic access logs to external syslog services.

Tags

if

Show something if the condition is true.

Actions

insert_before

Insert the result of a render action before an HTML element.

Models

email_receive_recipient

Model for received-email recipient extraction and matching used by mod_email_receive.

Models

acl_user_group

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

Tags

templatetag

Not implemented, but exists in Zotonic for forward compatibility with future ErlyDTL and Django versions.

Filters

insert

Prepends the argument in front of the value.

Modules

mod_filestore

Support for storing uploaded and generated images and documents on external services.

Actions

add_class

Add a css class to an html element.

Filters

filter

Filters a list on the value of a property, either on presence or equality.

Modules

mod_bootstrap

Adds support for the Twitter Bootstrap CSS / JavaScript framework. Integration module for Bootstrap assets and helper templates/components.

Filters

ljust

Justifies the value in a field of a certain width to the left, with spaces.

Modules

mod_admin_modules

Adds support in the admin for activating and deactivating modules.

Actions

dialog_mailing_page

Shows the dialog to mail the current page ( resource) to a mailing list. This is used in the admin “mailing status” interface. A mailing can be sent…

Notifications

observe_pivot_update/3

Pivot just before a m_rsc_update update. Used to pivot fields before the pivot itself.

Models

hierarchy

The category hierarchy tables have been replaced by m_hierarchy . This model defines named hierarchies of resources (pages).

Notifications

observe_email_status/2

Email status notification, sent when the validity of an email recipient changes

Models

image_edit

Manages the medium_edit_settings property for non destructive image editing.

Notifications

observe_user_context/3

Set #context fields depending on the user and/or the preferences of the user.

Models

authentication

Model for authentication state and login support checks, including password authentication flow helpers and reminder/verification actions.

Notifications

observe_media_viewer_consent/2

Optionally wrap HTML with external content so that it adheres to the cookie/privacy settings of the current site visitor. Typically called with a ‘first’ by…

Filters

datediff

Calculate the difference between two dates, returning a single part of that difference.

Actions

moreresults

Show more results of the current search query inline on the page.

Tags

regroup

Not implemented tag, for forward compatibility with future ErlyDTL and Django versions.

Filters

replace

Regular expression replacement of a pattern with a string.

Actions

editor_remove

Remove WYSIWYG editor controls from the textareas selected by the target. Use this before replacing or moving editor-managed markup so the editor can release…

Models

acl

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

Filters

menu_is_visible

Filters a list of menu items on visibility and existance. Only top-level menu items that are both visible and exist are kept in the list. Note that sub-menus…

Modules

mod_mailinglist

This module implements a mailing list system. You can make as many mailing lists as you like and send any page to any mailing list, including confirm mail and…

Models

identity

The m_identity model manages usernames and other user identities. module#mod_authentication uses it to store and check salted passwords, but also provides a…

Actions

delete_rsc

Delete a resource, without confirmation.

Actions

dialog_open

Renders a template on the server and opens a dialog with the HTML output of the template.

Tags

with

Assign a complex value to a variable.

Dispatch rules

mod_menu dispatch rules

URL dispatch rules defined by mod_menu in apps/zotonic_mod_menu/priv/dispatch/dispatch.

Actions

growl

Show a message in the upper right corner of the browser window. The message will automatically disappear after some time.

Notifications

observe_signup_url/2

Handle a signup of a user, return the follow on page for after the signup. Return {ok, Url} ‘props’ is a map with properties for the person resource (email

Tags

javascript

Adds javascript that will be run after jQuery has been initialized. In dynamic content it will run after the DOM has been updated with the template where the…

Notifications

observe_media_import/2

Notification to translate or map a file after upload, before insertion into the database Used in mod_video to queue movies for conversion to mp4. You can set…

Notifications

observe_media_replace_file/2

Notification that a medium file has been changed (notify) The id is the resource id, medium contains the medium’s complete property map.