Text

All Text

confirm

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

alert

Show an alert dialog.

Notifications

alert confirm growl

zmedia_choose

Used after a media item is selected in the media chooser for the TinyMCE editor.

Port configurations

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

Useful environment variables

The following environment variables influence how Zotonic starts up.

mod_l10n

Localization of Zotonic. Provides lookups for country, month, week names.

dispatch

Dispatch rules Name Path Resource Args admin_l10n [“admin”,”localization”] controller_admin [{template,”admin_l10n.

editor_remove

Remove any WYSIWYG editor controls from all textarea’s with the z_editor class in the target.

mod_clamav

Uses clamd to scan all uploaded files for viruses.

mod_admin_modules

Adds support in the admin for activating and deactivating modules.

module_toggle

Activate/deactivate a module in the module manager in the admin interface.

acl_user_groups

Return the groups for the current user.

acl_mqtt

MQTT acl check, called via the normal acl notifications. Actions for these checks: subscribe, publish

acl_logon

Initialize context with the access policy for the user.

acl_is_owner

Check if a user is the owner of a resource. id is the resource id.

acl_is_allowed_prop

Check if a user is authorizded to perform an action on a property. Defaults to true .

acl_is_allowed

Check if a user is authorized to perform an operation on a an object (some resource or module). Observe this…

ACL notifications

acl_context_authenticated acl_is_allowed acl_is_allowed_prop acl_is_owner acl_logoff acl_logon acl_mqtt acl_user_groups…

admin_menu

Used for fetching the menu in the admin.

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…

controller_admin_mailing_preview

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

media_upload_props

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

Release 0.6.0

Released on 2011-02-12.

escape

HTML escape a text. Escapes all reserved HTML characters in the value. Escaped strings are safe to be displayed in a…

escape_ical

Escape the value according to the RFC2445 rules.

temporary_rsc

Creates a temporary resource if its input value is not defined.

mod_development

Presents various tools for development.

m_development

Not yet documented.

Upgrade notes

These notes list the most important changes between Zotonic versions. Please read these notes carefully when upgrading…

Global configuration

This section describes the location and contents of Zotonic’s global configuration files erlang.config and zotonic.

Release 0.11.0

Welcome Zotonic 0.11.0, released on October 8, 2014. These notes list the most important changes for this new feature…

Release 0.9.2

Released on 2013-07-02 20:53 by arjan.

user_is_enabled

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

signup_url

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

signup_failed_url

Signup failed, give the error page URL. Return {ok, Url} or undefined. Reason is returned by the signup handler for the…

signup_done

Signal that a user has been signed up (map, result is ignored)

signup_confirm_redirect

Fetch the page a user is redirected to after signing up with a confirmed identity

signup_confirm

Signal that a user has been confirmed. (map, result is ignored)

signup_check

signup_check Check if the signup can be handled, a fold over all modules. Fold argument/result is {ok, Props

signup

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

session_context

Refresh the context or request process for the given request or action Called for every request that is not anonymous…

request_context

Refresh the context or request process for the given request or action Called for every request that is not anonymous…

set_user_language

Set the language of the context to a user’s prefered language

logon_submit

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

logon_ready_page

Check where to go after a user logs on.

identity_verified

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

identity_verification

Request to send a verification to the user. Return ok or an error. Handled by mod_signup to send out verification…

identity_password_match

Check if passwords are matching. Uses the password hashing algorithms.

User notifications

identity_password_match identity_verification identity_verified identity_update_done logon_options logon_ready_page…

mod_admin_identity

Provides identity management in the admin - for example the storage of usernames and passwords.

email_unique

Check if an entered e-mail address is unique, by looking in the m_identity table for the email key:

username_unique

Check if an entered username is unique, by looking in the m_identity table for the given username:

Release 0.42.0

Welcome to Zotonic 0.42.0, released on 5 November, 2018.

Customizing the style of an admin page

How to make style customizations to admin pages.

Just enough Erlang/OTP and rebar, part 1

Zotonic source code have you scratching your head? Learn Rebar first.

Just enough Erlang/OTP and rebar, part 2

Building a gen_server to front the library and generating documentation.

lower

Translates the value to lower case.

capfirst

Converts the first character of the value to uppercase.

upper

Translates the value to upper case.

animate

Add a $(..).animate jQuery call to the target element.

Debugging db (query) issues

Techniques for finding root cause when queries are involved.

postback_event

Message sent by a user-agent on a postback event. Encapsulates the encoded postback and any additional data. This is…

mailinglist_mailing

Send a page to a mailinglist (notify) Use {single_test_address, Email} when sending to a specific e-mail address.

Forms and validation

You should validate all input data entered in forms. In Zotonic you create forms by writing plain HTML. You can attach…

custom

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

growl

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

Enabling Growl Notifications

Using growl outside admin requires some magic to make it work.

remove

Remove an element from the page.

mod_import_csv

Module which adds “import CSV” button to the admin status screen.

dispatch

Dispatch rules Name Path Resource Args admin_import [“admin”,”import”] controller_admin [{template,”_admin_import.

dialog_duplicate_rsc

Open a dialog to duplicate the current resource with a new id and title.

Docker

We offer the Docker image zotonic/zotonic-dev which contains build tools and Erlang.

mod_translation

This module provides support for dealing with multiple languages.

Translation

Many sites need to support content and templates in multiple languages. Luckily, Zotonic is completely multilingual

unlink

Remove an edge between two resources. Used in the admin.

link

Add an edge between two resources. Used in the admin.

acl_logoff

Clear the associated access policy for the context.

Release 0.41.0

Welcome to Zotonic 0.41.0, released on 1 October, 2018.

wire_args

Add extra arguments to wired actions.

validate

The validator tag accepts the following arguments:

tabs

Make a HTML element into a tab set.

spinner

Add an AJAX activity indicator.

sorter

A sorter is a container for sortables.

sortable

Mark an element as sortable.

poll

Show a given survey (with the id parameter) as a “poll”. This presents a simpler interface, in which the user is…

pager

Show a pager for search results.

mailinglist_subscribe

Show the mailinglist subscription form to subscribe to a certain mailinglist id.

loremipsum

Inserts a piece of “lorem ipsum” text into the page.

lazy

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

inplace_textbox

Render a JS-aided inplace textbox.

google_chart

Make charts with Google.

droppable

Mark an element as valid drag destination.

draggable

Mark a html element as draggable.

debug

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

chart_pie3d

Show a pie chart with 3D effect.