Text
Browse by topic
Discover Text
Explore related documentation through its most useful keyword groups.
1070 items
Grouped by Architecture
Template filter
190 itemsA named transformation applied to a value inside a template expression.
Explore this clusterNotification
158 itemsA typed event or request exchanged between decoupled Zotonic components through the notifier.
Explore this clusterWire action
104 itemsA server-defined browser action or event binding connected through Zotonic wires.
Explore this clusterModel
102 itemsA namespaced interface for retrieving or changing data and invoking operations in Zotonic or browser-side components.
Explore this clusterModule
86 itemsAn OTP application or site component that adds Zotonic behavior templates data and configuration.
Explore this clusterTemplate
63 itemsA server-side template_compiler document that renders data into HTML text email or another representation.
Explore this clusterController
57 itemsA request handler that maps web requests to responses and coordinates authorization rendering or data transfer.
Explore this clusterDispatch rule
51 itemsA route declaration that matches a URL pattern and selects a controller with arguments.
Explore this clusterResource
38 itemsThe central Zotonic entity that represents content users media categories and other addressable objects.
Explore this clusterOther
410 itemsDocumentation not covered by the other keyword groups in this split.
Explore this clusterAll Text
split
Splits the filter value into a list of values.
mod_signup dispatch rules
URL dispatch rules defined by mod_signup in apps/zotonic_mod_signup/priv/dispatch/dispatch.
observe_export_resource_filename/2
mod_export - return the {ok, Filename} for the content disposition.
client_local_storage
Model to access the localStorage on the client (browser).
is_rtl
Check if the given language is a rtl or ltr language.
menu_flat
Flattens the rsc menu structure for use in a template loop.
controller_signup_confirm
Controller which displays the confirmation page where the user can confirm his signup.
controller_admin_referrers
Shows the list of pages ( resources) which refer to this resource through an edge.
log_ui
Model for admin UI log retrieval by index, gated by admin permissions.
to_name
Map a string to a name . That is a lowercased string with only [a-z0-9_] characters.
observe_auth_validated/2
Authentication against some (external or internal) service was validated
mod_clamav
Uses clamd to scan all uploaded files for viruses.
observe_identity_password_match/2
Check if passwords are matching. Uses the password hashing algorithms.
admin_identity
Model for admin identity configuration values, including password policy regex and default category/content-group for new users.
observe_pivot_fields/3
Foldr to change or add pivot fields for the main pivot table. The rsc contains all rsc properties for this resource, including pivot properties. Fold with a…
flatten_value
Flatten a list to a comma separated string.
edge
Access information about page connections.
unescape
Removes HTML escaping from a text.
to_binary
Convert the input to a binary value.
mod_facebook dispatch rules
URL dispatch rules defined by mod_facebook in apps/zotonic_mod_facebook/priv/dispatch/dispatch.
trans_filter_filled
Filters all empty translations from a property.
urldecode
Decode a text where characters are encoded as URL-safe characters.
observe_url_abs/2
Make a generated URL absolute, optionally called after url_rewrite by z_dispatcher
mod_export
Provides a generic framework for exporting resources, query results, and application-defined data. An export consists of a data provider and an encoder:
poll
Show a given survey (with the id parameter) as a “poll”. This presents a simpler interface, in which the user is directly asked to enter some information, e.g.
dialog_media_upload
Shows the admin dialog for uploading a media item. See Media.
Release Notes
Every time a Zotonic release is made, we create a document which lists the most important changes. This page contains links to the release notes for each…
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 readable format of kilo- or megabytes.
content_type_urls
Return the available content representations and URLs for a resource.
url
Generates the relative URL for the given dispatch information.
controller_admin_edit
The main admin edit controller. This controller serves the edit page where resources can be edited.
debug
Shows which variables are assigned for use in the current template’s scope:
slide_toggle
Toggle an element by sliding it up and down.
survey_test_max_points
Counts the total of all points that can be received for all test questions. Non test questions are not counted.
escapejs
Escapes the value for insertion in JavaScript output.
mod_editor_tinymce
Adds wysiwyg tinyMCE editors to the admin.
make_value
Convert a template value to its simple value representation.
mod_email_dkim
Signs outgoing e-mails with DomainKeys Identified Mail Signatures ( RFC 6376).
mod_base
mod_base is the base module, which acts as a container module holding most of Zotonic basic dispatch rules, Actions and Module tags.
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.
observe_user_is_enabled/2
Check if a user is enabled. Enabled users are allowed to log in. Return true , false or undefined . If undefined is returned, the user is considered enabled if…
observe_acl_is_owner/2
Check if a user is the owner of a resource. id is the resource id.
observe_search_query_term/2
Map a custom search term to a #search_sql_term{} record.
observe_auth_confirm/3
Confirm a user id.
module_toggle
Activate/deactivate a module in the module manager in the admin interface.
Show the contents of a value expression.
mod_email_status
This module tracks for all outgoing email addresses:
observe_action_event_type/2
Render the javascript for a custom action event type. The custom event type must be a tuple, for example: {% wire type={live id=myid} action={...} %}</code>…
tabs
Make a HTML element into a tab set.
set_value
Set the value of a form field.
observe_media_upload_rsc_props/3
Notification that a medium file has been uploaded. This is the moment to change resource properties, modify the file etc. The folded accumulator is the map…
site
Retrieve information that is stored in the site configuration. If you want to query values from the config table instead, you should use model#config.
mod_mailinglist dispatch rules (dispatch_mailinglist)
URL dispatch rules defined by mod_mailinglist in apps/zotonic_mod_mailinglist/priv/dispatch/dispatch_mailinglist.
observe_acl_logoff/2
Clear the associated access policy for the context.
mod_l10n dispatch rules
URL dispatch rules defined by mod_l10n in apps/zotonic_mod_l10n/priv/dispatch/dispatch.
observe_email_sent/2
Notify that we could NOT send an e-mail (there might be a bounce later...) The Context is the depickled z_email:send/2 context.
script
This action executes JavaScript directly. It can be used to interface with non-Zotonic JavaScript libraries and functions.
1.0.0_rc.15
Released on 2023-01-30.
1.0.0_rc.14
Released on 2022-12-23.
0.73.0
Welcome to Zotonic 0.73.0, released on December 8, 2022.
1.0.0_rc.13
Released on 2022-12-05.
0.72.0
Welcome to Zotonic 0.72.0, released on November 21, 2022.
1.0.0_rc.12
Released on 2022-11-17.
1.0.0_rc.11
Released on 2022-11-11.
1.0.0_rc.10
Released on 2022-10-31.
0.71.0
Welcome to Zotonic 0.71.0, released on October 18, 2022.
1.0.0_rc.9
Released on 2022-10-12.
0.70.1
Welcome to Zotonic 0.70.1, released on September 26, 2022.
0.70.0
Welcome to Zotonic 0.70.0, released on September 16, 2022.
1.0.0_rc.8
Released on 2022-09-13.
Security, templates and XSS prevention
Ensuring that you don't fall victim to cross site scripting and other injection attacks takes vigilance, eye for details and especially some good naming habits.
0.69.0
Welcome to Zotonic 0.69.0, released on August 30, 2022.
0.68.0
Welcome to Zotonic 0.68.0, released on July 21, 2022.
0.67.0
Welcome to Zotonic 0.67.0, released on July 5, 2022.
0.66.0
Welcome to Zotonic 0.66.0, released on May 24, 2022.
Support & Services
Community support - mailinglists Do you want to start a Zotonic based project? Then join our mailing lists and discuss Zotonic with us, our developers and our…
Download Zotonic
Get the latest release Download the latest release of Zotonic from Github. Use git clone, so that you can easily update later. Or clone our example project…
0.65.0
Welcome to Zotonic 0.65.0, released on March 17, 2022.
0.64.0
Welcome to Zotonic 0.64.0, released on March 4, 2022.
Server configuration
This chapter describes how to configure your Linux server for running Zotonic.
Restore/upgrade content db from backup
Contributed by: Scott Finnie
Resources
Resources are Zotonic’s main data unit. You may want to familiarise yourself with the Zotonic data model in the User Guide.
Execute tasks asynchronously using the task queue
The Zotonic task queue lets applications perform tasks asynchronously.
Exometer metrics
Zotonic comes with a system for collecting and exporting metrics (such as how much memory is used, how many database requests were made, etc.) called Exometer.
Dynamic select options using a wired template
Why Suppose you want to wire a change event for a select box to update a another select box, i.e. you want to wire the action to use the selected value when…
Just Enough Regular Expressions (in Erlang)
Learn how to manipulate string data with the re module.
CMS
Zotonic is a Content Management System (CMS).
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…
Creating sites
Initialize your site with a proper data model and some resources through manage_schema .
Displaying a site map
For the benefit of search engines and fans of tables of contents you can easily provide a site map.
Contributing to Zotonic
We encourage contributions to Zotonic from the community! This chapter describes how you can help improve Zotonic.
Access control
Access control is about defining who is allowed to access certain resources. It takes two steps:
Pivot Templates
Search uses database indices on special pivot columns and full text fields.
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 intelligently.
Automatically add new users to a user group
Why When you create a person, you usually need to add it to a user group as well. You may want to automate this, in particular if you need to differentiate…
Icons in templates
Zotonic provides a couple of ways to show icons in templates:
User Guide
Welcome to the Zotonic User Guide. This guide is a non-technical introduction to Zotonic.
HTTPS support
Zotonic has built-in support for HTTPS and TLS (previously SSL) certificate handling.
Best Practices
Creating sites Media Best Practices Template Best Practices and Pitfalls
How to customise error pages
Specific error pages Zotonic’s controller_http_error first tries to find an error page template that is specific for the HTTP status code, named templates…