Text

All Text

mod_signup

This module presents an interface for letting users register themselves.

ssl_options

Request the SSL certificates for this site. The server_name property contains the hostname used by the client. (first…

move

Move an element to another place, appending it to the target. The element is given by id with the element argument, or…

module_activate

A module has been activated and started.

m_client_local_storage

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

reload

Reload the current page.

redirect

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

Page handling

redirect reload

m_log

Not yet documented.

rsc_merge

Map to signal merging two resources. Move any information from the loser to the winner. The loser will be deleted.

survey_is_submit

Check if a question is a submitting question.

survey_is_allowed_results_download

Check if the current user is allowed to download a survey.

survey_get_handlers

Fetch list of handlers for survey submits.

Survey notifications

survey_get_handlers survey_is_allowed_results_download survey_is_submit survey_submit survey_result_columns…

service_authorize

Request API logon

tkvstore_get

Get a value from the typed key/value store

activity_send

Push a list of activities via a ‘channel’ (eg ‘email’) to a recipient. The activities are a list of #activity{} records.

Using Varnish as frontend for Zotonic

Using the Varnish HTTP frontend, you can speed up your Zotonic even more as this web server caches static files…

dispatch

Dispatch rules Name Path Resource Args admin_statistics [“admin”,”statistics”] controller_admin_statistics []…

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…

replace

Replace the target HTML element by new one.

typeselect

Show possible selections whilst typing.

auth_postcheck

First for logon of user with username, called after successful password check.

m_survey

Not yet documented.

search_query

Map a custom search term to a #search_sql_term{} record.

rsc_update_done

An updated resource has just been persisted. Observe this notification to execute follow-up actions for a resource…

Variables

as_atom default if if_undefined is_defined is_undefined make_value pprint to_binary to_integer to_json

Translation

is_rtl language language_dir language_sort media_for_language set_url_language trans_languages trans_filter_filled…

Strings

append capfirst center filesizeformat format_duration format_integer format_number format_price insert is_valid_email…

Numbers

filesizeformat format_duration format_integer format_number format_price is_even is_number max min minmax rand round…

Miscellaneous

gravatar_code ip2country ip2geo is_letsencrypt_valid_hostname format_dispatch_controller_option…

Menu

menu_flat menu_ids menu_is_visible menu_expand menu_rsc menu_subtree menu_trail

Lists

after before chunk exclude filter first flatten_value group_by index_of is_list join last length make_list member…

HTML

show_media striptags truncate_html sanitize_html sanitize_url urlize embedded_media without_embedded_media…

Forms

pickle

Character escaping

brlinebreaks escape escape_check escape_ical escape_link escapejs escapejson escapexml fix_ampersands force_escape…

Encryption

md5 sha1

Binaries

first last length to_binary

to_json

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

default

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

trans_filter_filled

Filters all empty translations from a property.

language_sort

Sort a list of language codes or map with languages on their name. Return a list of {Code, LanguageProps} pairs.

language

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

is_rtl

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

truncate

Truncate a text to a maximum length.

trim

Removes whitespace at the start and end of a string.

to_name

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

insert

Prepends the argument in front of the value.

log_format_stack

Escapes and formats a Javascript string with a stack trace to readable HTML.

append

Appends the argument to the value.

to_integer

Convert the input to an integer value.

round

Round a floating point value to the nearest integer.

is_even

Test if an integer value is even:

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…

ip2geo

Maps an IP address to information about that country.

gravatar_code

Calculate the gravatar code for an e-mail address:

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…

vsplit_in

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

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…

sort

The sort filter takes a list of items to sort. Items can be an ordinary list of terms, property lists, or maps. It can…

range

Generate a list of integers, with an optional step.

member

Finds a value in a list.

make_list

Forces the value to a list.

is_list

Test if a value is a list:

index_of

Returns the index of the first occurrence of the item in the given list.

group_by

Groups items of a list by a property.

flatten_value

Flatten a list to a comma separated string.

before

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

after

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

urlize

Find urls in the given input and make them clickable.

truncate_html

Truncate a HTML text to a maximum length.

pickle

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

urlencode

Make a text safe for URLs.

unescape

Removes HTML escaping from a text.

linebreaksbr

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

fix_ampersands

Replaces ampersands in the value with “&amp;” entities.

escapexml

Escape the value for insertion in xml output.

escape_link

Convert any URLs in a plaintext into HTML links, with adding the rel="nofollow" attribute, and replaces all newlines…

brlinebreaks

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

sha1

Translate a string to a sha1 hex value.

md5

Translates a string to a md5 hex value.

length

Returns the length of the value.

admin_dispatch

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

mod_admin_predicate

Add support for editing predicates in the admin, by presenting a list of all defined predicates on http://yoursite.com…

dialog_predicate_new

Show a dialog for creating a new predicate.

dialog_user_add

Show a dialog for adding a user. This creates a person resource and adds a username / password to it.

without

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

template

Render a template. When used in a postback action, the result will be sent back with the response data for the postback.

Templates

template

media_upload_preprocess

Notification to translate or map a file after upload, before insertion into the database Used in mod_video to queue…

Best Practices

Creating sites Media Best Practices Template Best Practices and Pitfalls

media_upload_rsc_props

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

mod_facebook

The mod_facebook module plugs into the authentication systen to enable Facebook login on your site.

m_facebook

Not yet documented.

m_predicate

Retrieve information about predicates. Predicates are the labels on edges (connections between resources) that give…

embedded_media

Fetch media ids that are embedded in the body , body_extra and text blocks of your page.

without_embedded_media

Filter out media ids that are embedded in the body , body_extra and text blocks of your page.