Documentation
Browse by topic
Discover Documentation
Explore related documentation through its most useful keyword groups.
1337 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
99 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
490 itemsDocumentation not covered by the other keyword groups in this split.
Explore this clusterAll Documentation
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.
debug
Shows which variables are assigned for use in the current template’s scope:
debug: Start Zotonic in the foreground with an Erlang shell
Start Zotonic in the foreground with an Erlang shell.
decrypt: Decrypt a local encrypted backup file
Decrypt a local encrypted backup file.
default
Provide an alternative value in case a value has a falsy value (0, false , undefined or empty string).
default_if_none
Provide an alternative value in case a value is undefined.
default_if_undefined
Provide an alternative value in case a value is undefined.
Define what a complete backup includes
Choose recovery coverage, retention, and an owner.
delete_media
Delete a media file from a resource, without confirmation.
delete_rsc
Delete a resource, without confirmation.
delete_username
Delete the username from a user, no confirmation.
Deleting content
Remove a page that is no longer needed.
Dependencies, capabilities, and module priority
The main site or module can declare:
Deploy and verify a release
Apply a tested revision and check the site from a visitor’s perspective.
Deploy a repeatable release
Record the code revision, build steps, configuration changes, and schema changes for the release. Build and test the same revision in an acceptance environment…
Developer guide
Build, inspect, and maintain Zotonic sites and modules.
development
Model for development and diagnostics controls, including tracing flags, observer lists, cache/compile/reindex actions, and dispatch info.
Diagnose a failed browser interaction
Reproduce one action with the browser console and network panel open. Check for a JavaScript error before the request, a failed request, or a successful…
Diagnose a site that will not start
Separate node, site, database, and application failures.
Diagnose failed uploads or missing media
Locate the failure in permission, storage, or processing.
Diagnose missing or failed email
Trace one message from request to recipient.
dialog
Opens a dialog with a predefined HTML content and title.
dialog_close
Closes a dialog. When there is no dialog open then nothing happens.
dialog_config_delete
Open a dialog that asks confirmation to delete a configuration key/value pair.
dialog_config_edit
Open a dialog to edit a configuration key/value pair.
dialog_config_new
Open a dialog to create a new configuration key/value pair.
dialog_delete_rsc
Open a dialog to confirm the deletion of a resource.
dialog_delete_username
Open a dialog to confirm the deletion of the username of a user.
dialog_duplicate_rsc
Open a dialog to duplicate the current resource with a new id and title.
dialog_edit_basics
Open a dialog to edit the “basic” information of a resource.
dialog_mailing_page
Shows the dialog to mail the current page ( resource) to a mailing list. This is used in the admin “mailing status” interface. A mailing can be sent…
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
dialog_media_upload
Shows the admin dialog for uploading a media item. See Media.
dialog_new_rsc
Show the admin dialog for creating a new resource.
dialog_open
Renders a template on the server and opens a dialog with the HTML output of the template.
dialog_predicate_new
Show a dialog for creating a new predicate.
dialog_set_username_password
Show a dialog for setting a username / password on the given resource (which is usually a person).
dialog_user_add
Show a dialog for adding a user. This creates a person resource and adds a username / password to it.
Direct test mail to a controlled recipient
Prevent an acceptance workflow from emailing real users.
disable
Sets the “disabled” attribute of a HTML tag and adds the CSS class “disabled”.
dispatch
Dispatch or generate URLs or page paths. Useful to check dispatch rules or for client side code to dispatch page paths.
dispatch: Inspect dispatch rules or trace a URL
Inspect dispatch rules or trace a URL.
Display images with mediaclasses
Define reusable image sizes in priv/templates/mediaclass.config and use them in image tags. For example, a local mediaclass can constrain an image's width:
Display images with mediaclasses
Define reusable image sizes in priv/templates/mediaclass.config and use them in image tags. For example, a local mediaclass can constrain an image's width:
Distinguish stale cache data from stale code
First check which file is selected and whether the changed code compiled. Then repeat the request with the relevant cache disabled or flushed.
Downloading survey results
Export answers and check what information the file contains.
draggable
Mark a html element as draggable.
droppable
Mark an element as valid drag destination.
Duplicating or reusing content
Choose between a new copy and a connection to existing content.
edge
Access information about page connections.
Editing a page
Change existing content and check the result.
Editing the main menu
Find the menu that your website displays.
editor_add
Add WYSIWYG editor controls to the textareas selected by the target. The active editor integration, such as TinyMCE, implements the actual controls; the action…
editor_remove
Remove WYSIWYG editor controls from the textareas selected by the target. Use this before replacing or moving editor-managed markup so the editor can release…
editor_tinymce
Model exposing TinyMCE editor version metadata used by admin/editor integration.
effect
Run a jQuery UI effect on the target element.
element
Select an element from a tuple or list of tuples.
Check if the content of the input field is an e-mail address.
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…
email_receive_recipient
Model for received-email recipient extraction and matching used by mod_email_receive.
email_relay
Model for email relay API endpoints, handling relay delivery requests and relay status updates.
email_status
Tracks the send/bounce/error status of all outgoing emails.
email_unique
Check if an entered e-mail address is unique by querying model#identity for the email key:
embedded_media
Fetch media ids that are embedded in the body , body_extra and text blocks of your page.
enable
Resets the “disabled” attribute of a HTML tag and removes the CSS class “disabled”.
Enable a module from the Erlang shell
Enable an installed module on one site and verify the result.
Enable or disable a site feature
Change module activation and verify the affected workflow.
Enable the Development module
Sign in to the local site's admin as an administrator. Open the module management page, find Development (mod_development), and activate it if necessary.
eq_day
Tests if the value is a date and equal to the argument. The value and the argument must be a tuple of the format {Y,M,D} or {{Y,M,D},{H,I,S}} .
Erlang applications, Zotonic modules, and sites
These terms describe different parts of the system.
escape
HTML escape a text. Escapes all reserved HTML characters in the value. Escaped strings are safe to be displayed in a HTML page. When you echo a query string…
escape_check
Ensures thant an HTML escaped value is properly escaped.
escape_ical
Escape the value according to the RFC2445 rules.
escapejs
Escapes the value for insertion in JavaScript output.
escapejson
Escapes the value for safe insertion into JSON strings.
escape_link
Convert any URLs in a plaintext into HTML links, with adding the rel="nofollow" attribute, and replaces all newlines with <br> tags.
escapexml
Escape the value for insertion in xml output.
etop: Inspect active Erlang processes
Inspect active Erlang processes.
event
Bind actions to a jQuery event or submit a form.
exclude
Filters a list on the value of a property, either on absence or inequality.
Expose an operation through an API
Start from the site's existing model API or controller patterns. Specify the method, input fields, response shape, and errors before connecting a browser or…
Expose data through a model
Create src/models/m_garden.erl in the Garden module. This complete example exposes a public greeting:
Expose data through a model
Create src/models/m_garden.erl in the Garden module. This complete example exposes a public greeting:
extends
Inherit markup from another template.
extract
Extract a specific property from each item in a list.
Model for Facebook integration helpers, including auth-use flag, profile picture fetch, and Graph API proxy calls.
fade_in
Show an element by animating the opacity.
fade_out
Hide an element by animating the opacity.
Featured and related content
Suggest which pages deserve attention.
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.
filestore
Read filestore configuration and statistics through m.filestore , for example {{ m.filestore.service }} or {{ m.filestore.stats.cloud }} in an admin template.
fileuploader
Model to start uploads, upload a block and delete uploads.
filter
Filters a list on the value of a property, either on presence or equality.
filter
Filter the contents of a block through variable filters.
filter_by
Filter a list of items based on a property value and optional predicate.
filter_geomap_distance
Calculate the great-circle distance between two locations in kilometers.