Text
Browse by topic
Discover Text
Explore related documentation through its most useful keyword groups.
1370 items
Grouped by Architecture
Template filter
197 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
Model
119 itemsA namespaced interface for retrieving or changing data and invoking operations in Zotonic or browser-side components.
Explore this clusterModule
111 itemsAn OTP application or site component that adds Zotonic behavior templates data and configuration.
Explore this clusterWire action
110 itemsA server-defined browser action or event binding connected through Zotonic wires.
Explore this clusterTemplate
101 itemsA server-side template_compiler document that renders data into HTML text email or another representation.
Explore this clusterDispatch rule
64 itemsA route declaration that matches a URL pattern and selects a controller with arguments.
Explore this clusterController
62 itemsA request handler that maps web requests to responses and coordinates authorization rendering or data transfer.
Explore this clusterResource
55 itemsThe central Zotonic entity that represents content users media categories and other addressable objects.
Explore this clusterOther
502 itemsDocumentation not covered by the other keyword groups in this split.
Explore this clusterAll Text
replace
Replace the target HTML element, including the target element itself, with rendered HTML.
mod_auth2fa
Two-factor authentication module adding TOTP setup, verification flows, and related auth checks.
confirmation
Check if two inputs are the same.
slide_down
Show an element by animating the height.
mod_seo dispatch rules
URL dispatch rules defined by mod_seo in apps/zotonic_mod_seo/priv/dispatch/dispatch.
controller_fileuploader
The fileuploader controller is used to upload parts of a file.
observe_export_resource_filename/2
mod_export - return the {ok, Filename} for the content disposition.
log_ui
Model for admin UI log retrieval by index, gated by admin permissions.
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:
debug
Shows which variables are assigned for use in the current template’s scope:
urldecode
Decode a text where characters are encoded as URL-safe characters.
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.
mod_facebook dispatch rules
URL dispatch rules defined by mod_facebook in apps/zotonic_mod_facebook/priv/dispatch/dispatch.
controller_admin_referrers
Shows the list of pages ( resources) which refer to this resource through an edge.
edge
Access information about page connections.
to_binary
Convert the input to a binary value.
observe_url_abs/2
Make a generated URL absolute, optionally called after url_rewrite by z_dispatcher
slide_toggle
Toggle an element by sliding it up and down.
trans_filter_filled
Filters all empty translations from a property.
to_name
Map a string to a name . That is a lowercased string with only [a-z0-9_] characters.
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.
survey_test_max_points
Counts the total of all points that can be received for all test questions. Non test questions are not counted.
unescape
Removes HTML escaping from a text.
observe_identity_password_match/2
Check if passwords are matching. Uses the password hashing algorithms.
content_type_urls
Return the available content representations and URLs for a resource.
flatten_value
Flatten a list to a comma separated string.
dialog_media_upload
Shows the admin dialog for uploading a media item. See Media.
url
Generates the relative URL for the given dispatch information.
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…
admin_identity
Model for admin identity configuration values, including password policy regex and default category/content-group for new users.
observe_auth_validated/2
Authentication against some (external or internal) service was validated
controller_admin_edit
The main admin edit controller. This controller serves the edit page where resources can be edited.
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…
mod_clamav
Uses clamd to scan all uploaded files for viruses.
mod_email_dkim
Signs outgoing e-mails with DomainKeys Identified Mail Signatures ( RFC 6376).
observe_acl_is_owner/2
Check if a user is the owner of a resource. id is the resource id.
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.
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>…
make_value
Convert a template value to its simple value representation.
tabs
Make a HTML element into a tab set.
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_search_query_term/2
Map a custom search term to a #search_sql_term{} record.
escapejs
Escapes the value for insertion in JavaScript output.
set_value
Set the value of a form field.
mod_editor_tinymce
Adds wysiwyg tinyMCE editors to the admin.
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…
Show the contents of a value expression.
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.
observe_acl_logoff/2
Clear the associated access policy for the context.
observe_auth_confirm/3
Confirm a user id.
mod_mailinglist dispatch rules (dispatch_mailinglist)
URL dispatch rules defined by mod_mailinglist in apps/zotonic_mod_mailinglist/priv/dispatch/dispatch_mailinglist.
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…
script
This action executes JavaScript directly. It can be used to interface with non-Zotonic JavaScript libraries and functions.
module_toggle
Activate/deactivate a module in the module manager in the admin interface.
mod_email_status
This module tracks for all outgoing email addresses:
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_l10n dispatch rules
URL dispatch rules defined by mod_l10n in apps/zotonic_mod_l10n/priv/dispatch/dispatch.
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.
Render template values safely
Choose escaping for the value and the output context.
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…
Get Zotonic
Choose a release or a development checkout and follow the installation guide.
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.
Rehearse a complete site restore
Restore into isolation and verify content, media, and access.
Tune server limits from measured load
Check actual limits and workload before changing operating-system settings.
Use stable resource names
A resource has a numeric ID within its database. Give application-owned resources a stable name when code needs to find them across installations.
Schedule deferred work
Queue a complete callback and distinguish enqueueing from completion.
Update a preview from a selection
Validate a selection before rendering a resource preview.
Inspect and export Zotonic metrics
Discover actual metrics before configuring subscriptions.
Use regular expressions with Erlang/OTP 28
Match and replace UTF-8 text with the current re module.
Introduction to editing with Zotonic
Use the admin to keep your website up to date.
Add an HTTP controller
Use controller_template when a dispatch rule only needs to render a template. Write a custom controller when the endpoint needs additional request processing…
Create your first site
Create the garden blog, open it in your browser, and sign in to its admin.
Cache selected public assets with Varnish
Start with a narrow VCL 4 policy and preserve authenticated responses.
Assign a user group from a trusted creation workflow
Add membership after creation with explicit permissions.
Contribute a Zotonic change
Build the checkout, verify the change, and send a focused pull request.
Keep permission checks at the boundary
Use the request context when checking access to data and actions. A hidden button is not an authorization check: callers can invoke a model or endpoint…
Create a public site-map page
Render the navigation menu on a named page.
Pivot Templates
Search uses database indices on special pivot columns and full text fields.
Zotonic for editors
Practical help for writing, organizing, and publishing website content.
Configure hostnames and HTTPS
Align DNS, site selection, and certificate termination.
Add an icon to a control
Use icons from the loaded theme and keep the control accessible.
Complete module and function names in the shell
Use shell completion without relying on a particular startup mode.
Use an Erlang shell safely
Distinguish a practice Erlang VM from a remote Zotonic shell.