Reference

All Reference

mod_email_status

This module tracks for all outgoing email addresses:

mod_export

Provides a generic framework to export resources.

mod_facebook

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

mod_filestore

Support for storing uploaded and generated images and documents on external services.

mod_fileuploader

Upload files using a parallel web worker.

mod_geoip

Used to map IP addresses to geographical locations.

mod_image_edit

Non destructive edits of images.

mod_import_csv

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

mod_import_wordpress

Import WordPress .wxr files in your site.

mod_l10n

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

mod_linkedin

The mod_linkedin module plugs into the authentication systen to enable LinkedIn login on your site.

mod_logging

Logs messages to the database and adds log views to 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…

mod_media_exif

When uploading a file, this module extracts properties from the uploaded media and sets them in the resource.

mod_menu

Create nested navigation menus for your site.

mod_microsoft

Adds logon using the Microsoft identity platform.

mod_mqtt

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

mod_oembed

Makes media resources from embeddable URLs through the OEmbed protocol.

mod_ratelimit

Implements rate limiting for various resources.

mod_search

mod_search implements various ways of searching through the main resource table using m_search.

mod_seo

Adds basic search engine optimization to the base templates and provides an admin interface for configuring SEO options…

mod_seo_sitemap

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

mod_server_storage

Server side storage for the client (aka browser) and server.

mod_signup

This module presents an interface for letting users register themselves.

mod_site_update

This module pulls updates of a site‘s code from a remote version control system. The supported version control systems…

mod_ssl_ca

The mod_ssl_ca module adds support for using SSL certificates bought from a Certificate Authority.

mod_ssl_letsencrypt

Request certificates from Let’s Encrypt.

mod_survey

Adds the concept of survey resources: user-definable forms which can be created in the admin interface and filled out…

mod_tkvstore

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

mod_translation

This module provides support for dealing with multiple languages.

module_activate

A module has been activated and started.

module_deactivate

A module has been stopped and deactivated.

module_rescan

Rescans all modules, to find all templates, lib files, dispatch rules, etc. again.

Modules (Admin)

module_rescan module_toggle

module_toggle

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

mod_video

Adds support for viewing and handling video medium items.

mod_video_embed

This module, if activated, checks the pasted URLs in the create media / page dialog of the admin. It will show an embed…

mod_wires

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

moreresults

Show more results of the current search query inline on the page.

move

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

m_predicate

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

m_ratelimit

Not yet documented.

m_req

This model gives access to the request variables from within a template.

m_rsc

The main resource model, which is the central part of the Zotonic data model. This model provides an interface to all…

m_rsc_gone

This model tracks deleted resources (see m_rsc). Its primary goal is to be able to determine if a resource never…

m_search

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

m_search_status

Not yet documented.

m_seo

Not yet documented.

m_seo_sitemap

Not yet documented.

m_server_storage

Model to access the server side storage of data.

m_signup

Exported APIs:

m_site

Retrieve information that is stored in the site configuration. If you want to query values from the config table…

m_site_update

Model for checking if a site has version control enabled.

m_ssl_letsencrypt

Not yet documented.

m_survey

Not yet documented.

m_sysconfig

Gives access to the Zotonic system configuration from the zotonic.config file(s).

m_tkvstore

Simple read-only interface to the typed key-value store of mod_tkvstore. To get a value from the store: use m.tkvstore.

m_translation

The m_translation model gives easy access to language and translation related information.

multiupload

Handle an uploaded file which is part of a multiple file upload from a user-agent. The upload is a #upload record or a…

name_unique

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

ne_day

Tests if two dates are not equal.

normalize_email

Normalize an email address, used in the identity management.

Notifications

alert confirm growl

now

Show the current date and time.

nthtail

Fetch the nth tail of a list.

Numbers

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

numericality

Numerical input and range check.

Other notifications

action_event_type activity activity_send admin_edit_blocks admin_menu admin_rscform category_hierarchy_save…

output_html

Fold for mapping non-iolist output to iolist values. Used when outputting a rendered HTML tree. Folded accumulator is:…

overlay_close

Closes the currently open overlay. When there is no overlay open then nothing happens.

overlay_open

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

overrules

Inherit markup from like named template in another module.

Page handling

redirect reload

pager

Show a pager for search results.

page_url

Fetch the url of a resource’s html representation

parse_url

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

pickle

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

pivot_fields

Foldr to change or add pivot fields for the main pivot table. The rsc contains all rsc properties for this resource

Pivot notifications

pivot_fields pivot_rsc_data pivot_update custom_pivot

pivot_rsc_data

Fold over the resource props map to extend/remove data to be pivoted

pivot_update

Pivot just before a m_rsc_update update. Used to pivot fields before the pivot itself.

poll

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

Port configurations

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

postback

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

postback

Performs a custom server side validation of an input value. This allows you to add your own validation logic to HTML…

postback_event

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

postback_notify

Handle a javascript notification from the postback handler. The message is the the request, trigger the id of the…

pprint

Pretty print a zotonic value in a template.

Predicates and Connections

dialog_predicate_new link unlink

presence

Check if an input has been filled in or checked.

print

Show the contents of a value expression.

publish

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

rand

Generates a random number. The number is from, and including, 1 up to, and including, the input value.

random

Returns a random value from a list of values. When the input is an empty list or not a list then the result is…

randomize

Shuffle a list of values.