Documentation

chunk

This filter splits a list in shorter lists. It splits an array in sub-arrays of at most a given length. This is useful when displaying a list of items in…

clamav

Reports whether the ClamAV daemon ( clamd ) is available. The m.clamav.is_available model path sends a ping and returns true when the daemon responds with PONG…

client_local_storage

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

client_session_storage

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

CMS

Zotonic is a Content Management System (CMS).

Command-line

The zotonic command runs a number of utility commands which all operate on a Zotonic instance.

Command-line shell

The Zotonic shell gives you access to a running Zotonic instance with its code and data.

comment

Model for comments attached to resources. It provides listing, moderation checks, counting, and retrieval of individual comments.

comment

Ignore part of a template.

compose

Compose another template and override its named blocks.

config

Zotonic has two places where a site's configuration is kept:

config_delete

Trigger the deletion of a configuration value. Used in the admin.

config_toggle

Toggle a configuration value. Used in the admin, for instance when displaying a “live” checkbox the state of which should reflect a config value.

Configuration

Global configuration Site configuration Port configurations

confirm

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

confirmation

Check if two inputs are the same.

content_group

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

content_type_label

Return a translated, human-readable label for a MIME content type.

content_type_urls

Return the available content representations and URLs for a resource.

Contributing to Zotonic

We encourage contributions to Zotonic from the community! This chapter describes how you can help improve Zotonic.

controller_admin

The admin controller is the main controller behind which admin pages are served. Its main purpose is that it does an authentication check (Is current user…

controller_admin_acl_rules_export

Download the site's access-control rules as a compressed Erlang term.

controller_admin_backup

Shows the admin backup screen where you can download nightly backups that were made by module#mod_backup.

controller_admin_backup_revision

Shows the admin backup revisions screen where you can see older version for a resource.

controller_admin_category_sorter

Shows the admin category screen where you can edit the category tree, rearranging the categories, adding new categories, or removing existing ones.

controller_admin_comments

Shows an admin screen with an overview of most recently created comments. The screen offers the option to moderate the comments or delete them entirely.

controller_admin_comments_settings

Shows an admin settings screen where you can edit settings related to module#mod_comment.

controller_admin_config

Shows the admin config editor. Here you can edit the key/value pairs of model#config.

controller_admin_edit

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

controller_admin_mailinglist

This controller shows the mailing lists that are available in the system.

controller_admin_mailinglist_recipients

Shows the recipients of the current mailing list. The recipients are listed in three columns, and have a checkbox next to them to deactivate them.

controller_admin_mailing_preview

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

controller_admin_mailing_run

Display mailing history and the delivery status of an individual mailing run.

controller_admin_mailing_run_content

Serve the saved HTML copy of a mailing run for a specific language.

controller_admin_mailing_status

This controller shows the mailing status of a resource. It lists each mailing list available in the system, and shows whether or not the current resource has…

controller_admin_media_preview

A controller for rendering preview thumbnails of any media embedded in a richtext-editor component of a resource on the controller#controller_admin_edit page.

controller_admin_module_manager

Shows the list of Zotonic modules currently known to the system.

controller_admin_referrers

Shows the list of pages ( resources) which refer to this resource through an edge.

controller_admin_seo

Shows a form with settings related to Search Engine Optimization.

controller_admin_statistics

Render the administration dashboard for live Zotonic system statistics.

controller_api

controler_api processes authorized REST API requests: It provides an easy way to create API calls to allow computer programs to perform functions on your…

controller_authentication

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

controller_csp_report

Controller handling Content-Security-Policy reports.

controller_export

Stream an export that is not tied to one resource.

controller_export_resource

Stream one resource, or a resource-derived list, in a negotiated export format.

controller_file

Serve an uploaded-, resized- or library file.

controller_file_id

Redirect to the controller controller_file.

controller_fileuploader

The fileuploader controller is used to upload parts of a file.

controller_hello_world

Simple controller that always serves the string Hello, World!

controller_http_error

This controller is called for serving http error pages.

controller_id

Handle different content representations of a page.

controller_keyserver_key

Publish the site's RSA encryption public key as JavaScript.

controller_language_set

Controller which sets the language as given in the code argument, and redirects the user back to the page given in the p argument.

controller_letsencrypt_challenge

Serve an ACME HTTP-01 challenge for Let's Encrypt certificate issuance.

controller_letsencrypt_ping

Return the site's current Let's Encrypt reachability token as plain text.

controller_log_client

Controller to log UI errors and events.

controller_logoff

Controller that logs off a user, destroying the session. It also removes any “remember me” cookies the user has, so that auto-logon is disabled.

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.

controller_mailinglist_export

Controller which downloads the given mailinglist id as a CSV file.

controller_media_runner_callback

Client-side receiver for results produced by the external media runner site. This controller belongs to mod_base , so each client site has a callback endpoint…

controller_mqtt_transport

Controller for transport of MQTT data between the browser (client) and server.

controller_nocontent

Return an empty HTTP 204 No Content response.

controller_oauth2_access_token

Exchange OAuth 2.0 credentials for a bearer access token.

controller_oauth2_service_authorize

Start an OAuth login with an external identity provider.

controller_oauth2_service_redirect

Complete the browser-facing redirect step of an external OAuth login.

controller_page

Show a rsc as a HTML page.

controller_ping

Simple controller for connection tests, used on the /test/connection page.

controller_redirect

Redirect to another url.

Controllers

Controllers are the Erlang modules which decide what happens when a browser requests a page. Zotonic looks at the dispatch rules that match the requested URL

controller_signup

Controller which displays a form to sign up (rendered from signup.tpl ).

controller_signup_confirm

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

controller_static_pages

Serve a static page or pages.

controller_template

Show a template.

controller_test_helloworld

Example controller used by the Zotonic test sandbox.

controller_website_redirect

This controller does a redirect to the website property of the given resource.

controller_websub

HTTP hub and subscriber callback controller for mod_websub .

controller_websub_topic

Serve the complete JSON representation advertised as a resource's WebSub topic.

controller_zotonic_status

Serve the Zotonic status site and fallback templates.

copyright

Model for copyright and rights metadata helpers, including Creative Commons lists, rights statement lookup, and attribution/year values.

cotonic_pathname_search

Render the current dispatch path_info values as a URL query string.

Create a custom action

Create a custom controller

Zotonic comes with a large collection controllers that cover many use cases, so you’ll probably have to resort to custom controllers less often than you may be…

Create a custom filter

Create custom template filters to change the way variables are rendered in your templates. By following some simple rules, Zotonic will automatically find the…

Create a custom model

In this chapter we will look at how to implement a model around the The Open Movie Database (OMDB) API.

Create a custom tag

Custom tags, internally called scomps , are module-defined tags, which are used when the logic is too complex to be executed in templates.

Creating a custom widget on the edit page

Why For an imaginary webshop edit page, we want to add 2 more data fields: the affiliate URL and a note about free shipping.

Creating sites

Initialize your site with a proper data model and some resources through manage_schema .

CSS classes used in templates

If you are building a website then you might want to use the standard dialogs, overlays, authentication and other parts of Zotonic. To make those look like…

custom

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

Customizing the layout of the admin edit page

Why After having created a custom widget (see Creating a custom widget on the edit page), we want to hide widgets that we don’t need.

Customizing the sign up and sign in form

You want to change parts of the form, or change its appearance.

Customizing the style of an admin page

How to make style customizations to admin pages.

Custom pivots

Search can only sort and filter on resources that actually have a database column. Zotonic’s resources are stored in a serialized form. This allows you to very…

custom_redirect

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

Custom search

Implement a custom search by observing the search_query notification in your module. Imagine you want to search cookies in your database that either have…

cycle

Rotate through a list of values.

date

Formats a date or datetime according to the format specified in the argument.

date

Validate input date against a given date format.

datediff

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

date_range

Show a date range.