Text
Browse by topic
Discover Text
Explore related documentation through its most useful keyword groups.
1342 items
Grouped by Architecture
Template filter
194 itemsA named transformation applied to a value inside a template expression.
Explore this clusterNotification
164 itemsA typed event or request exchanged between decoupled Zotonic components through the notifier.
- Add a named resource search
- Assign a user group from a trusted creation workflow
- Choose a model, controller, observer, or component
Wire action
110 itemsA server-defined browser action or event binding connected through Zotonic wires.
Explore this clusterModel
110 itemsA namespaced interface for retrieving or changing data and invoking operations in Zotonic or browser-side components.
Explore this clusterModule
102 itemsAn OTP application or site component that adds Zotonic behavior templates data and configuration.
Explore this clusterTemplate
101 itemsA server-side template_compiler document that renders data into HTML text email or another representation.
Explore this clusterController
60 itemsA request handler that maps web requests to responses and coordinates authorization rendering or data transfer.
Explore this clusterDispatch rule
59 itemsA route declaration that matches a URL pattern and selects a controller with arguments.
Explore this clusterResource
55 itemsThe central Zotonic entity that represents content users media categories and other addressable objects.
Explore this clusterOther
492 itemsDocumentation not covered by the other keyword groups in this split.
Explore this clusterAll Text
observe_signup_failed_url/2
Signup failed, give the error page URL. Return {ok, Url} or undefined. Reason is returned by the signup handler for the particular signup method (username
typeselect
Show possible selections whilst typing.
submit
Submits the enclosing form, a specifically targeted form or the closest form to an element.
mod_authentication dispatch rules
URL dispatch rules defined by mod_authentication in apps/zotonic_mod_authentication/priv/dispatch/dispatch.
mod_filestore dispatch rules
URL dispatch rules defined by mod_filestore in apps/zotonic_mod_filestore/priv/dispatch/dispatch.
timesince
Show a readable version of a date/time difference.
module_rescan
Rescans all modules, to find all templates, lib files, dispatch rules, etc. again.
observe_email_received/2
Notification sent to a site when e-mail for that site is received
trigger_event
Trigger a named {% wire %} event in the browser. The required name argument identifies the wire; every other action argument is passed to the named event.
observe_sanitize_embed_url/2
Sanitize an embed url. The hostpart is of the format: <<"youtube.com/v...">> .
dialog_mail_page
Shows the dialog to mail the current page ( resource) to a single e-mail address. This is used in the frontend of a site to “share” the current page over e
mod_signup
This module presents an interface for letting users register themselves.
survey_prepare_matching
Prepare the items and options of a survey matching question for rendering.
Global configuration
This section describes the location and contents of Zotonic’s global configuration files erlang.config and zotonic.config . There’s also site-specific…
draggable
Mark a html element as draggable.
observe_language/2
Notify that the session’s language has been changed
add_year
Adds a year to a date. The value must be of the form {{Y,M,D},{H,I,S}} .
observe_category_hierarchy_save/2
Save (and update) the complete category hierarchy
survey_is_submit
Check if the questions end with a question type that is a submit button.
show_media
Convert the image markers in HTML from the Rich Text editor into image tags.
mod_translation
This module provides support for dealing with multiple languages.
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 undefined.
pprint
Pretty print a zotonic value in a template.
zlink
Used for inserting an internal link in the TinyMCE editor in the admin.
mod_admin_frontend dispatch rules
URL dispatch rules defined by mod_admin_frontend in apps/zotonic_mod_admin_frontend/priv/dispatch/dispatch.
reset
Resets the enclosing form, a specifically targeted form or the closest form to an element.
observe_set_user_language/2
Set the language of the context to a user’s prefered language
controller_id
Handle different content representations of a page.
observe_edge_delete/2
An edge has been deleted Note that the Context for this notification does not have the user who deleted the edge.
email_dkim
DomainKeys Identified Mail Signatures (RFC 6376) is a method to add a signature to outgoing emails. This enables recipients to check who sent an email and if…
mod_content_groups
Module for content group support and ACL-aware content group behavior.
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 also be a list of resource ids to be…
ifchanged
Not implemented, but exists in Zotonic for forward compatibility with future ErlyDTL and Django versions.
animate
Add a $(..).animate jQuery call to the target element.
observe_acl_collab_groups_modify/3
Modify the list of collaboration groups of a user. Called internally by the ACL modules when fetching the list of collaboration groups a user is member of.
to_integer
Convert the input to an integer value.
Check if the content of the input field is an e-mail address.
comment
Ignore part of a template.
autoescape
Automatically apply HTML escaping to values.
gravatar_code
Calculate the gravatar code for an e-mail address:
observe_media_preview_options/3
Modify the options for an image preview url or tag. This is called for every image url generation, except if the ‘original’ image option is passed. The…
mqtt_ticket
A ticketing system for out of band MQTT posts via HTTP.
sub_week
Subtracts a week from a date. The value must be of the form {{Y,M,D},{H,I,S}} .
signup
Exported APIs:
mod_backup
mod_backup serves two different purposes: it makes a nightly backup of your files and database, and can also backup/restore individual resource items.
mailinglist
Model for mailinglist operations and reporting, including recipient counts, delivery stats, subscriptions, and scheduled mailings.
observe_email_add_handler/2
Add a handler for receiving e-mail notifications
if_undefined
Tests whether a value is undefined, returning the given argument.
observe_rsc_query_item/2
Send a notification that the resource ‘id’ is added to the query query_id.
logoff
This action logs off the current user and reloads the current page as the anonymous visitor.
template
Render a template. When used in a postback action, the result will be sent back with the response data for the postback.
observe_export_resource_encode/2
mod_export - Encode a single data element.
fix_ampersands
Replaces ampersands in the value with “&” entities.
mod_search
mod_search implements various ways of searching through the main resource table using model#search.
Command-line reference
Look up the syntax, requirements, and effects of each bundled command.
observe_mailinglist_mailing/2
Send a page to a mailinglist (notify) Use {single_test_address, Email} when sending to a specific e-mail address.
dialog_config_edit
Open a dialog to edit a configuration key/value pair.
controller_export
Stream an export that is not tied to one resource.
survey_as_pages
Split the page blocks into pages, prepare them for easy display in the survey question editor.
insert_bottom
Inserts HTML after the contents of an HTML element.
acceptance
Check if an input value evaluates to true.
observe_url_rewrite/3
Rewrite a URL after it has been generated using the z_dispatcher
mod_acl_mock
Mocking module for access control during tests.
chart_pie
Render a pie chart as inline SVG.
Glossary
Action An action is functionality that can be attached to a HTML element or event. Actions are wired to an element or event. Think of showing dialogs, posting…
observe_survey_submit/2
A survey has been filled in and submitted.
observe_dispatch/2
Final try for dispatch, try to match the request. Called when the site is known, but no match is found for the path
controller_website_redirect
This controller does a redirect to the website property of the given resource.
controller_admin_seo
Shows a form with settings related to Search Engine Optimization.
Installation requirements
Check the required tools and install optional media tools when you need them.
0.77.0
Welcome to Zotonic 0.77.0, released on May 25, 2023.
0.76.0
Welcome to Zotonic 0.76.0, released on April 4, 2023.
0.75.0
Welcome to Zotonic 0.75.0, released on March 2, 2023.
server_storage
Model to access the server side storage of data.
mod_custom_redirect dispatch rules
URL dispatch rules defined by mod_custom_redirect in apps/zotonic_mod_custom_redirect/priv/dispatch/dispatch.
observe_rsc_update_done/2
An updated resource has just been persisted. Observe this notification to execute follow-up actions for a resource update.
insert_top
Inserts HTML before the contents of an HTML element.
controller_static_pages
Serve a static page or pages.
observe_media_identify_file/2
Try to identify a file, returning a map with file properties.
ratelimit
Model for exposing current ratelimit timeout information for the active request context.
sub_hour
Subtracts an hour from a date. The value must be of the form {{Y,M,D},{H,I,S}} .
Configuration
Global configuration Site configuration Port configurations
mod_export dispatch rules (dispatch_export)
URL dispatch rules defined by mod_export in apps/zotonic_mod_export/priv/dispatch/dispatch_export.
dialog_set_username_password
Show a dialog for setting a username / password on the given resource (which is usually a person).
observe_rsc_import_fetch/2
Fetch the data for an import of a resource. Returns data in the format used by m_rsc_export and m_rsc_import. Either returns the JSON data, the imported…
observe_dropbox_file/2
Handle a new file received in the ‘files/dropbox’ folder of a site. Unhandled files are deleted after an hour. If the handler returns ‘ok’ then the file is…
validate
The validator tag accepts the following arguments:
append
Appends the argument to the value.
mod_backup dispatch rules (backup)
URL dispatch rules defined by mod_backup in apps/zotonic_mod_backup/priv/dispatch/backup.
add_month
Adds a month to a date. The value must be of the form {{Y,M,D},{H,I,S}} .
observe_email_drop_handler/2
Drop an e-mail handler for a user/resource id. (notify). The notification, user and resource should be the same as when the handler was registered.
is_defined
Tests if a value is defined.
controller_hello_world
Simple controller that always serves the string Hello, World!
dialog_new_rsc
Show the admin dialog for creating a new resource.
mod_geoip
Used to map IP addresses to geographical locations.
observe_email_send_encoded/2
Add a handler for receiving e-mail notifications
mod_survey dispatch rules (survey)
URL dispatch rules defined by mod_survey in apps/zotonic_mod_survey/priv/dispatch/survey.
mod_microsoft dispatch rules
URL dispatch rules defined by mod_microsoft in apps/zotonic_mod_microsoft/priv/dispatch/dispatch.
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.
summary
Extract a summary from a resource.