Documentation
Browse by topic
Discover Documentation
Explore related documentation through its most useful keyword groups.
1367 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
120 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
99 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 Documentation
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.
is_visible
Filter a list of resource ids so that only the visible ids remain.
javascript
Adds javascript that will be run after jQuery has been initialized. In dynamic content it will run after the DOM has been updated with the template where the…
join
Joins the elements of a list. Joins the elements of the input list together, separated by the argument.
jquery_effect
Trigger various jQuery effects on the target element. Mostly, each of these effects have their own action as a shortcut, for example action#show, action#hide.
json
Validate that a form value is JSON.
Keep development and production settings distinct
Keep development and production settings distinct.
Keep development and production settings distinct
Keep development and production settings distinct.
Keeping a page out of search engines
Request that search engines leave a page out of their results.
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…
l10n
Model for localization helpers, including countries, country names, available timezones, and site timezone settings.
language
Return the language the resource (or translated text) will be displayed in.
language_dir
Return rtl or ltr depening on the direction of the language.
language_sort
Sort a list of language codes or map with languages on their sort key. Return a list of {Code, LanguageProps} pairs.
language_sort_localized
Sort a list of language codes or map with languages on their localized name in the currently selected language. This is useful for editorial interfaces where…
Language-specific URLs
Check links to translated content.
last
Returns the last character or element.
lazy
Custom tag which adds a ‘loader’ image to the page and performs a one-time action when loader comes into view.
length
Returns the length of the value.
length
Check the length of a text input.
lib
Include CSS and JavaScript libraries, combining files of each type into a single request.
linebreaksbr
Translate ASCII newlines ( \n ) into HTML <br /> elements.
link
Add an edge between two resources. Used in the admin.
Model for LinkedIn integration helpers, currently exposing whether LinkedIn auth integration is enabled.
Links Cotonic
Introduction to Incremental DOM
Link to resources and dispatch routes
Use a resource's page URL when linking to content. This lets Zotonic account for its path and language.
live
Live-updating templates driven by MQTT topics.
ljust
Justifies the value in a field of a certain width to the left, with spaces.
load
Loads the given custom tags for use in the templates. Normally not needed, as custom tags are automatically loaded through the module system.
load: Load changed BEAM files
Load changed BEAM files.
log
Model for runtime logging state and access to server log entries for clients allowed to read logs.
log_csp
Model for admin Content-Security Report log retrieval by index, gated by admin permissions.
log_email
Model for email log lookups used by logging/admin views.
log_format_stack
Escapes and formats a Javascript string with a stack trace to readable HTML.
logoff
This action logs off the current user and reloads the current page as the anonymous visitor.
logtail: Print recent lines from a configured log file
Print recent lines from a configured log file.
log_ui
Model for admin UI log retrieval by index, gated by admin permissions.
loremipsum
Inserts a piece of “lorem ipsum” text into the page.
lower
Translates the value to lower case.
m_access_url
Generate absolute resource page URLs signed with the current user's view permissions. Requires mod_access_url to be enabled. Opening the link does not log the…
mailinglist
Model for mailinglist operations and reporting, including recipient counts, delivery stats, subscriptions, and scheduled mailings.
mailinglist_confirm
Confirm a mailinglist subscription. Required argument is the confirm_key .
mailinglist_recipient_key_decode
Used on the mailing list subscriptions page where users and recipients can unsubscribe from mailinglists.
mailinglist_run
Durable mailing runs and delivery accounting, available as m.mailinglist_run in templates. Recipient addresses and message diagnostics are never published on…
mailinglist_subscribe
Show the mailinglist subscription form to subscribe to a certain mailinglist id.
mailinglist_unsubscribe
Cancel a mailing list subscription. The recipient id is given with the id argument.
mailing_page_test
Post a message to the test mailing list, given with the id argument.
make_list
Forces the value to a list.
make_value
Convert a template value to its simple value representation.
Making images understandable
Provide useful text for readers who cannot see an image.
Managing recipients
Keep a mailing list accurate.
mask
Places a mask over an element, useful for blocking user interaction during lengthy postbacks.
mask_progress
Sets the progress bar of an action#mask.
match
Match a value with a regular expression.
max
Take the maximum of the filter value and its first argument.
md5
Translates a string to a md5 hex value.
media
Show embed, video or audio media.
media
Access to data about uploaded files and other media.
Media and depictions
Understand shared files and page images.
media_exif_value
Formats EXIF values for display in templates.
media_for_language
Filter a list of media items by their medium_language property, return the best matching with the current or given language. Only visible media items are…
member
Finds a value in a list.
menu
Show a page menu.
menu_expand
Takes a menu, or a menu resource id, and adds all haspart objects connected to the menu ids.
menu_flat
Flattens the rsc menu structure for use in a template loop.
menu_ids
Returns all resource ids in a menu. Could return invisible and non existing resource ids. The returned ids are a flat list, the hierarchy of the menu is lost.
menu_is_visible
Filters a list of menu items on visibility and existance. Only top-level menu items that are both visible and exist are kept in the list. Note that sub-menus…
menu_rsc
Return the menu to be displayed with a resource.
Menus and collections
Choose navigation or an ordered group of content.
menu_subtree
Get the subtree of an id in a menu (if any).
menu_trail
Return a breadcrumb navigation trail for the given id.
merge_tags
A mail-merge like filter where tag-expressions in a text are replaced with the value of their evaluation.
m_exchange_rates
Read currency rates and convert amounts using the site's mod_exchange_rates server. Rates express currency units per USD and may be retained from earlier…
m_geomap
Expose GeoMap configuration and country-map data to templates and model GET requests.
microsoft
Check with useauth if the authentication using the Microsoft identity platform is enabled and configured.
min
Take the minimum of the filter value and its first argument.
minmax
Force the given value in the given range.
Missing translations and fallback languages
Understand why a page may show text in another language.
mod_access_url
Share protected pages, images and feeds using signed URLs with the signing user's view permissions. Recipients do not need to log in as that user. Typical uses…
mod_acl_mock
Mocking module for access control during tests.
mod_acl_user_groups
This module adds rule-based access control.
mod_acl_user_groups dispatch rules
URL dispatch rules defined by mod_acl_user_groups in apps/zotonic_mod_acl_user_groups/priv/dispatch/dispatch.
mod_admin
Admin backend module that wires the core admin interface, assets, and admin-specific event handling.
mod_admin_category
Note
mod_admin_category dispatch rules
URL dispatch rules defined by mod_admin_category in apps/zotonic_mod_admin_category/priv/dispatch/dispatch.
mod_admin_config
Add support for editing the site’s configuration values, as accessed through model#config.
mod_admin_config dispatch rules
URL dispatch rules defined by mod_admin_config in apps/zotonic_mod_admin_config/priv/dispatch/dispatch.
mod_admin dispatch rules
URL dispatch rules defined by mod_admin in apps/zotonic_mod_admin/priv/dispatch/dispatch.
mod_admin_frontend
Adds editing of resources, menu-trees and collections for non-admin users.
mod_admin_frontend dispatch rules
URL dispatch rules defined by mod_admin_frontend in apps/zotonic_mod_admin_frontend/priv/dispatch/dispatch.
mod_admin_identity
Provides identity management in the admin - for example the storage of usernames and passwords.
mod_admin_identity dispatch rules (admin_dispatch)
URL dispatch rules defined by mod_admin_identity in apps/zotonic_mod_admin_identity/priv/dispatch/admin_dispatch.
mod_admin_keyword
Add keyword analysis tools to the Zotonic administration interface.