Browse by topic

Discover Text

Explore related documentation through its most useful keyword groups.

1438 items

Grouped by Architecture

All Text

Models

content_group

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

Models

facebook

Model for Facebook integration helpers, including auth-use flag, profile picture fetch, and Graph API proxy calls.

Tags

image

Show a still image using an <img\> element. The image will be automatically resized to the desired size and filters. For video, use the tag#media tag instead.

Scomp

droppable

Mark an element as valid drag destination.

Actions

overlay_open

Renders a template on the server and opens a full screen overlay with the HTML output of the template.

Models

rsc

The main resource model, which is the central part of the Zotonic data model. This model provides an interface to all resource ("page") information. It also…

Filters

round

Round a floating point value to the nearest integer.

Notifications

observe_signup/2

Request a signup of a new or existing user. Arguments are similar to #signup_url{} Returns {ok, UserId} or {error, Reason}

Filters

slugify

Converts a text into a slug.

Actions

slide_fade_in

Show an element by animating the height and opacity.

Tags

inherit

Include the markup of an extended template into the extending template.

Notifications

observe_activity/2

An activity in Zotonic. When this is handled as a notification then return a list of patterns matching this activity. These patterns are then used to find…

Actions

buttonize

Add button interaction classes to an element.

Modules

mod_admin_config

Add support for editing the site’s configuration values, as accessed through model#config.

Reference

Port configurations

Port configurations can be tricky, especially in combination with SSL. Here we explain all steps to come to a correctly configured installation with working…

Actions

delete_username

Delete the username from a user, no confirmation.

Dispatch rules

mod_linkedin dispatch rules

URL dispatch rules defined by mod_linkedin in apps/zotonic_mod_linkedin/priv/dispatch/dispatch.

Models

media

Access to data about uploaded files and other media.

Filters

parse_url

Parses an URL (URI) using uri_string:parse/1 .

Controllers

controller_logon_done

This controller is used as a jumping stone after a log on from the /logon page. The p argument is passed from the /logon page.

Notifications

observe_filewatcher/2

Broadcast some file changed, used for livereload by mod_development

Notifications

observe_security_headers/2

Check and possibly modify the http response security headers All headers are in lowercase.

Models

admin

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

Filters

slice

Perform array-slice operations on a list or string.

Filters

escapejson

Escapes the value for safe insertion into JSON strings.

Filters

to_json

Display any value as in JSON (JavaScript Object Notation).

Notifications

observe_rsc_insert/3

Foldr for a resource insert, these are the initial properties and will overrule the properties in the insert request. Use with care. The props are the…

Dispatch rules

mod_logging dispatch rules

URL dispatch rules defined by mod_logging in apps/zotonic_mod_logging/priv/dispatch/dispatch.

Actions

show

Show an element without any animation.

Filters

capfirst

Converts the first character of the value to uppercase.

Actions

dialog_config_delete

Open a dialog that asks confirmation to delete a configuration key/value pair.

Notifications

observe_media_upload_preprocess/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…

Modules

mod_mqtt

MQTT is a machine-to-machine (M2M)/“Internet of Things” connectivity protocol. It was designed as an extremely lightweight publish/subscribe messaging…

Actions

dialog_config_new

Open a dialog to create a new configuration key/value pair.

Modules

mod_cookie_consent

Wrap external content in such a way that it is only loaded if the user consented to the inclusion of the content (and subsequent cookies).

Actions

publish

Publishes a message on the topic tree of the current page.

Actions

fade_in

Show an element by animating the opacity.

Filters

url_abs

Generates an absolute URL for the given dispatch information.

Models

backup

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

Filters

survey_any_correct_answer

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

Models

custom_redirect

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

Filters

is_valid_email

Test whether a value has valid email-address syntax.

Tags

lib

Include CSS and JavaScript libraries, combining files of each type into a single request.

Notifications

observe_rsc_get/3

Resource is read, opportunity to add computed fields Used in a foldr with the read properties as accumulator.

Notifications

observe_ssl_options/2

Request the SSL certificates for this site. The server_name property contains the hostname used by the client. (first) Returns either ‘undefined’ or a list of…

Filters

pickle

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

Filters

menu_expand

Takes a menu, or a menu resource id, and adds all haspart objects connected to the menu ids.

Actions

form_reset

Resets the target form to its initial state.

Tags

ifequal

Show something if two values are equal.

Reference

Site configuration

This chapter describes the configuration options for your sites. There’s also global configuration.

Actions

reload

Reload the current page.

Modules

mod_l10n

Localization of Zotonic. Provides lookups for country, month, week names. Localization module providing locale, country, and timezone data and related helpers.

Dispatch rules

mod_contact dispatch rules

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

Filters

as_atom

Convert a value to an Erlang atom.

Reference

Reference

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

Filters

truncate_html

Truncate a HTML text to a maximum length.

Validators

format

Regular expression test.

Validators

name_unique

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

Filters

default

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

Filters

member

Finds a value in a list.

Actions

mailing_page_test

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

Models

log

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

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…

Dispatch rules

mod_auth2fa dispatch rules

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

Models

search

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

Validators

length

Check the length of a text input.

Modules

mod_seo_sitemap

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

Modules

mod_wires

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

Filters

round_significant

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

Filters

lower

Translates the value to lower case.

Filters

is_visible

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

Models

ssl_letsencrypt

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

Filters

language

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