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
Finding content
Find a page without creating a duplicate.
Finding media
Locate the right file in the media library.
Find registered observers
Open Show an overview of all observers from the Development page. Find the notification and inspect the registered callbacks and their order.
Find the configuration layer to change
Distinguish global Zotonic configuration, Erlang runtime configuration, site configuration files, and module settings stored for a site. Similar setting names…
Find the status site and your site's admin
The status site manages the running Zotonic installation. A site's /admin manages that site's content and enabled modules. They have different scopes and can…
Find the template used by a page
Enable module#mod_development and open its template tools in the admin. Search for the template name and inspect the selected file and alternatives.
first
Returns the first character or element.
firstof
Not implemented, but exists in Zotonic for forward compatibility with future ErlyDTL and Django versions.
fix_ampersands
Replaces ampersands in the value with “&” entities.
flatten_value
Flatten a list to a comma separated string.
floor
Round down a floating point value.
flush: Flush site caches
Flush site caches.
focus
Add a $(..).focus() jQuery call to the target element to give it input focus.
Follow a request to its template
Start with the URL that gives an unexpected result. Check its hostname: Zotonic uses it to select a site before matching the site's dispatch rules.
Follow a request to its template
Start with the URL that gives an unexpected result. Check its hostname: Zotonic uses it to select a site before matching the site's dispatch rules.
for
Loop over multiple values in a list or search result.
force_escape
HTML escapes a text.
format
Regular expression test.
format_dispatch_controller_option
Format dispatch controller options.
format_dispatch_path_element
Format dispatch path element so variables will be more visible.
format_duration
Show a duration in hours, minutes and seconds.
format_integer
Show an integer value.
format_number
Show an integer or float.
format_price
Show a price with decimals.
Formatting text
Make body text easy to scan and read.
form_reset
Resets the target form to its initial state.
fragment
Define a named reusable template fragment.
from_json
Parse a string as a JSON (JavaScript Object Notation) value. The returned value can be processed futher.
get_admin_url
Return the absolute administration URL for a Zotonic site.
Get Zotonic
Choose a release or a development checkout and follow the installation guide.
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…
Global template variables
These variables are always available for rendering in templates.
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…
gravatar_code
Calculate the gravatar code for an e-mail address:
group_by
Groups items of a list by a property.
group_firstchar
Group a list of sorted model#rsc resource IDs on their first letter of the title or another resource property. After grouping, it splits this list in a number…
group_title_firstchar
Similar to filter#group_firstchar, but always uses the title column from the rsc table.
growl
Show a message in the upper right corner of the browser window. The message will automatically disappear after some time.
Handle a browser event with a wire
Use scomp#wire to connect a browser event to an action or a server postback. Give the target element a stable ID within the rendered page.
Handle a browser event with a wire
Use scomp#wire to connect a browser event to an action or a server postback. Give the target element a stable ID within the rendered page.
Hand over an incident and record recovery
Give the next operator enough context to continue safely.
hasedge
A validator to check if a resource has a certain number of edges with a predicate.
hide
Hide an element without any animation.
hierarchy
The category hierarchy tables have been replaced by m_hierarchy . This model defines named hierarchies of resources (pages).
How languages work
Understand translated fields on one page.
How Zotonic finds templates, dispatch rules, and assets
Zotonic indexes resources from the site's active modules. A file existing on disk is not enough: its application must be discoverable, and its module must…
How Zotonic organizes content
Choose the right tool for organizing a page.
I accidentally changed or deleted something
Take the next step without overwriting more content.
identity
The m_identity model manages usernames and other user identities. module#mod_authentication uses it to store and check salted passwords, but also provides a…
if
Selects an argument depending on a condition.
if
Show something if the condition is true.
ifchanged
Not implemented, but exists in Zotonic for forward compatibility with future ErlyDTL and Django versions.
ifequal
Show something if two values are equal.
ifnotequal
Show something if two values are not equal.
if_undefined
Tests whether a value is undefined, returning the given argument.
image
Show a still image using an <img\> element. The image will be automatically resized to the desired size and filters. For video, use the tag#media tag instead.
Image captions and alignment
Adjust an image inserted in the body text.
image_data_url
Generate a data: url of a still image.
image_edit
Manages the medium_edit_settings property for non destructive image editing.
image_url
Generate the url of a still image.
import_csv_data
Model to track resources imported from CSV and XLSX files.
Importing and exporting recipients
Transfer a list of email addresses.
include
Include another template. The include tag is replaced with the contents of the included template file. You can give arguments to the included template, they…
Index a custom resource property
Create a pivot column and fill it through the custom_pivot notification.
index_of
Returns the index of the first occurrence of the item in the given list.
in_future
Tests if a date is in the future.
inherit
Include the markup of an extended template into the extending template.
inject_recipientdetails
Adds recipient query string details to hyperlinks.
in_past
Tests if a date is in the past.
inplace_textbox
Render a JS-aided inplace textbox.
insert
Prepends the argument in front of the value.
insert_after
Insert rendered HTML immediately after the target element.
insert_before
Insert the result of a render action before an HTML element.
insert_bottom
Inserts HTML after the contents of an HTML element.
insert_top
Inserts HTML before the contents of an HTML element.
Inspect and export Zotonic metrics
Discover actual metrics before configuring subscriptions.
Inspect global and site configuration
Use the command suited to the question:
Inspect logs and running processes
Use bin/zotonic logtail for the configured console log, or select error or crash when those files are available. The command prints the last 500 lines and…
Inspect template dependencies
Open Dependency graph of all available templates from the Development page. Use the graph to understand inheritance and include relationships before changing a…
Installation and deployment
Prepare an environment and deploy a release with a recovery plan.
Installation requirements
Check the required tools and install optional media tools when you need them.
Install initial content with a datamodel
Use a datamodel for application-owned categories, predicates, resources, and relationships that must exist when a module is installed.
Install on macOS or Linux
Install the native tools, prepare PostgreSQL, and build a local checkout.
Install with Docker or Podman
Build and run Zotonic with its development containers, then create a site.
Introduction
This is the Zotonic Developer Guide. It takes you through all aspects of Zotonic so you can start building your own sites as quickly as possible.
Introduction to editing with Zotonic
Use the admin to keep your website up to date.
ip2country
Return the lowercase ISO country code associated with an IP address.
ip2geo
Return geographic information associated with an IP address.
is_a
Filter a list of resource ids on category, or test if a single resource id belongs to a category.
is_defined
Tests if a value is defined.
is_even
Test if an integer value is even:
is_letsencrypt_valid_hostname
Test if a hostname can be used for a Let’s Encrypt certificate.
is_list
Test if a value is a list:
is_not_a
is_not_a mirrors filter#is_a. It is particularly useful when iterating over a category and excluding members of a sub-category (iterating over all images…
is_number
Test if a value is a number (integer or floating point):
is_rtl
Check if the given language is a rtl or ltr language.
is_site_url
Test if the given URL is a url for the current site.
is_undefined
Tests if a value is undefined.
is_user
Test if a resource is a user.
is_valid_email
Test whether a value has valid email-address syntax.