Browse by topic

Discover Text

Explore related documentation through its most useful keyword groups.

1022 items

Grouped by Architecture

All Text

Notifications

observe_identity_verified/2

Notify that a user’s identity has been verified. Signals to modules handling identities to mark this identity as verified. Handled by mod_admin_identity to…

Notifications

observe_email_failed/2

Notify that we could NOT send an e-mail (there might be a bounce later...) The Context is the depickled z_email:send/2 context.

Filters

without

Remove the items given in the argument from the filter value.

Filters

randomize

Shuffle a list of values.

Actions

zmedia

Used for triggering the insertion of a media item in the TinyMCE editor in the admin.

Filters

is_even

Test if an integer value is even:

Modules

mod_admin

Admin backend module that wires the core admin interface, assets, and admin-specific event handling.

Scomp

lazy

Custom tag which adds a ‘loader’ image to the page and performs a one-time action when loader comes into view.

Tags

cycle

Rotate through a list of values.

Models

oauth2_service

Model for OAuth2 service flow helpers, including redirect URL generation and oauth redirect processing.

Dispatch rules

mod_oauth2 dispatch rules

URL dispatch rules defined by mod_oauth2 in apps/zotonic_mod_oauth2/priv/dispatch/dispatch.

Validators

custom

Support for custom client-side (JavaScript-based) validators.

Models

modules

Access information about which modules are installed and which ones are active.

Models

seo_sitemap

Model for sitemap generation metadata, including available urlsets and paged urlset export values.

Actions

auth_disconnect

Disconnect an external authentication identity from a resource.

Actions

postback

This action sends a message to the event handler on the server.

Tags

firstof

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

Filters

is_not_a

is_not_a mirrors filter#is_a. It is particularly useful when iterating over a category and excluding members of a sub-category (iterating over all images…

Actions

dialog

Opens a dialog with a predefined HTML content and title.

Scomp

button

Makes a button with an action attached.

Filters

center

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

Filters

nthtail

Fetch the nth tail of a list.

Dispatch rules

mod_base dispatch rules

URL dispatch rules defined by mod_base in apps/zotonic_mod_base/priv/dispatch/dispatch.

Models

admin_status

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

Controllers

controller_authentication

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

Actions

confirm

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

Notifications

observe_edge_update/2

An edge has been updated Note that the Context for this notification does not have the user who updated the edge.

Models

filestore

The filestore uses two tables for its administration.

Modules

mod_tkvstore

Simple (type,key)/value store. Stores data in the store with minimal latency and (local) serialization of get/put requests.

Models

rsc_gone

This model tracks deleted resources (see model#rsc). Its primary goal is to be able to determine if a resource never existed, has been deleted or has been…

Actions

admin_tasks

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

Actions

hide

Hide an element without any animation.

Notifications

observe_auth_logon/3

User logs on. Add user-related properties to the logon request context.

Notifications

observe_logon_submit/2

Handle a user logon. The posted query args are included. Return:: {ok, UserId} or {error, Reason}

Dispatch rules

mod_seo dispatch rules

URL dispatch rules defined by mod_seo in apps/zotonic_mod_seo/priv/dispatch/dispatch.

Controllers

controller_signup_confirm

Controller which displays the confirmation page where the user can confirm his signup.

Actions

redirect_incat

Redirect the admin editor to the next or previous resource in a category.

Filters

trim

Removes whitespace at the start and end of a string.

Filters

sub_month

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

Actions

slide_down

Show an element by animating the height.

Filters

menu_flat

Flattens the rsc menu structure for use in a template loop.

Filters

is_rtl

Check if the given language is a rtl or ltr language.

Actions

replace

Replace the target HTML element, including the target element itself, with rendered HTML.

Filters

split

Splits the filter value into a list of values.

Actions

event

Bind actions to a jQuery event or submit a form.

Dispatch rules

mod_comment dispatch rules

URL dispatch rules defined by mod_comment in apps/zotonic_mod_comment/priv/dispatch/dispatch.

Dispatch rules

mod_signup dispatch rules

URL dispatch rules defined by mod_signup in apps/zotonic_mod_signup/priv/dispatch/dispatch.

Modules

mod_auth2fa

Two-factor authentication module adding TOTP setup, verification flows, and related auth checks.

Filters

flatten_value

Flatten a list to a comma separated string.

Models

edge

Access information about page connections.

Filters

content_type_urls

Return the available content representations and URLs for a resource.

Notifications

observe_url_abs/2

Make a generated URL absolute, optionally called after url_rewrite by z_dispatcher

Models

log_ui

Model for admin UI log retrieval by index, gated by admin permissions.

Scomp

poll

Show a given survey (with the id parameter) as a “poll”. This presents a simpler interface, in which the user is directly asked to enter some information, e.g.

Notifications

observe_pivot_fields/3

Foldr to change or add pivot fields for the main pivot table. The rsc contains all rsc properties for this resource, including pivot properties. Fold with a…

Filters

url

Generates the relative URL for the given dispatch information.

Filters

urldecode

Decode a text where characters are encoded as URL-safe characters.

Modules

mod_clamav

Uses clamd to scan all uploaded files for viruses.

Controllers

controller_admin_edit

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

Filters

filesizeformat

This filter formats a numeric value as KB, MB etc. This filter can be used to display a number of bytes in a human readable format of kilo- or megabytes.

Filters

to_name

Map a string to a name . That is a lowercased string with only [a-z0-9_] characters.

Filters

unescape

Removes HTML escaping from a text.

Filters

to_binary

Convert the input to a binary value.

Filters

survey_test_max_points

Counts the total of all points that can be received for all test questions. Non test questions are not counted.

Scomp

debug

Shows which variables are assigned for use in the current template’s scope:

Dispatch rules

mod_facebook dispatch rules

URL dispatch rules defined by mod_facebook in apps/zotonic_mod_facebook/priv/dispatch/dispatch.

Models

admin_identity

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

Actions

slide_toggle

Toggle an element by sliding it up and down.

Documentation

Release Notes

Every time a Zotonic release is made, we create a document which lists the most important changes. This page contains links to the release notes for each…

Modules

mod_export

Provides a generic framework for exporting resources, query results, and application-defined data. An export consists of a data provider and an encoder:

Notifications

observe_email_sent/2

Notify that we could NOT send an e-mail (there might be a bounce later...) The Context is the depickled z_email:send/2 context.

Scomp

tabs

Make a HTML element into a tab set.

Actions

set_value

Set the value of a form field.

Tags

print

Show the contents of a value expression.

Dispatch rules

mod_l10n dispatch rules

URL dispatch rules defined by mod_l10n in apps/zotonic_mod_l10n/priv/dispatch/dispatch.

Models

site

Retrieve information that is stored in the site configuration. If you want to query values from the config table instead, you should use model#config.

Actions

script

This action executes JavaScript directly. It can be used to interface with non-Zotonic JavaScript libraries and functions.

Filters

escapejs

Escapes the value for insertion in JavaScript output.

Notifications

observe_user_is_enabled/2

Check if a user is enabled. Enabled users are allowed to log in. Return true , false or undefined . If undefined is returned, the user is considered enabled if…

Notifications

observe_media_upload_rsc_props/3

Notification that a medium file has been uploaded. This is the moment to change resource properties, modify the file etc. The folded accumulator is the map…