Text
Browse by topic
Discover Text
Explore related documentation through its most useful keyword groups.
1022 items
Grouped by Architecture
Template filter
189 itemsA named transformation applied to a value inside a template expression.
Explore this clusterNotification
154 itemsA typed event or request exchanged between decoupled Zotonic components through the notifier.
Explore this clusterWire action
103 itemsA server-defined browser action or event binding connected through Zotonic wires.
Explore this clusterModule
85 itemsAn OTP application or site component that adds Zotonic behavior templates data and configuration.
Explore this clusterModel
77 itemsA namespaced interface for retrieving or changing data from Erlang templates MQTT or APIs.
Explore this clusterTemplate
63 itemsA server-side template_compiler document that renders data into HTML text email or another representation.
Explore this clusterController
52 itemsA request handler that maps web requests to responses and coordinates authorization rendering or data transfer.
Explore this clusterDispatch rule
50 itemsA route declaration that matches a URL pattern and selects a controller with arguments.
Explore this clusterResource
36 itemsThe central Zotonic entity that represents content users media categories and other addressable objects.
Explore this clusterOther
390 itemsDocumentation not covered by the other keyword groups in this split.
Explore this clusterAll Text
dialog_delete_username
Open a dialog to confirm the deletion of the username of a user.
mod_email_relay
This module supports relaying email between Zotonic servers.
slide_fade_out
Hide an element by animating the height and opacity.
rjust
Justifies the value in a field of a certain width to the right, using spaces.
mailinglist_unsubscribe
Cancel a mailing list subscription. The recipient id is given with the id argument.
escape_link
Convert any URLs in a plaintext into HTML links, with adding the rel="nofollow" attribute, and replaces all newlines with <br> tags.
survey_answer_split
Filter to split multi-value survey answers on the '#' character.
mod_acl_user_groups
This module adds rule-based access control.
mailinglist_confirm
Confirm a mailinglist subscription. Required argument is the confirm_key .
controller_oauth2_access_token
Exchange OAuth 2.0 credentials for a bearer access token.
tokens
Returns a list of tokens from input string, separated by the characters in the filter argument.
mask_progress
Sets the progress bar of an action#mask.
urlize
Find urls in the given input and make them clickable.
mod_video
Adds support for viewing and handling video medium items.
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.
acl_rule
Model for ACL rule inspection and helper checks in mod_acl_user_groups, including insert/move checks, upload limits, mime checks, and ACL state lookups.
admin_note
Add an editorial note to any resource.
observe_rsc_update/3
An updated resource is about to be persisted. Observe this notification to change the resource properties before they are persisted.
slide_up
Hide an element by animating the height.
image_url
Generate the url of a still image.
mod_oembed
Makes media resources from embeddable URLs through the OEmbed protocol.
controller_oauth2_service_authorize
Start an OAuth login with an external identity provider.
observe_menu_rsc/2
Fetch the menu id belonging to a certain resource
mod_import_csv
Module which adds “import CSV” button to the admin status screen.
chunk
This filter splits a list in shorter lists. It splits an array in sub-arrays of at most a given length. This is useful when displaying a list of items in…
observe_acl_user_groups/2
Return the groups for the current user.
is_undefined
Tests if a value is undefined.
mod_video_embed
This module, if activated, checks the pasted URLs in the create media / page dialog of the admin. It will show an embed option for Youtube and Vimeo URLs. It…
mod_oauth2
OAuth2 provider module for app/client/token management and authorization flows.
mod_admin dispatch rules
URL dispatch rules defined by mod_admin in apps/zotonic_mod_admin/priv/dispatch/dispatch.
max
Take the maximum of the filter value and its first argument.
controller_admin_mailing_status
This controller shows the mailing status of a resource. It lists each mailing list available in the system, and shows whether or not the current resource has…
observe_auth_client_switch_user/2
Send a request to the client to switch users. The zotonic.auth.worker.js will
controller_admin_module_manager
Shows the list of Zotonic modules currently known to the system.
observe_acl_context_authenticated/2
Set the context to a typical authenticated user. Used by m_acl.erl
mod_logging
Logs messages to the database and adds log views to the admin.
mod_import_wordpress
Import WordPress .wxr files in your site.
dialog_close
Closes a dialog. When there is no dialog open then nothing happens.
mod_admin_identity
Provides identity management in the admin - for example the storage of usernames and passwords.
add_week
Adds a week to a date. The value must be of the form {{Y,M,D},{H,I,S}} .
sysconfig
Note
observe_logon_options/3
Check for logon options, called if logon_submit returns undefined. This is used to fetch external (or local) authentication links for a username. Return:: map()
dialog_user_add
Show a dialog for adding a user. This creates a person resource and adds a username / password to it.
import_csv_data
Model to track resources imported from CSV and XLSX files.
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.
mod_zotonic_site_management
Site management module for creating, configuring, and controlling managed Zotonic sites.
mod_zotonic_site_management dispatch rules
URL dispatch rules defined by mod_zotonic_site_management in apps/zotonic_mod_zotonic_site_management/priv/dispatch/dispatch.
force_escape
HTML escapes a text.
mod_artwork
This module contains many useful icons and images.
zmedia_choose
Used after a media item is selected in the media chooser for the TinyMCE editor.
translation
The m_translation model gives easy access to language and translation related information.
observe_export_resource_data/2
mod_export - fetch a row for the export, can return a list of rows, a binary, and optionally a continuation state. Where Values is [ term() ], i.e. a list of…
mod_admin_statistics
Admin module exposing site statistics views and related dashboard metrics.
auth2fa
Model for two-factor authentication state and setup, including TOTP QR/image generation, mode checks, reset checks, and clock skew checks.
observe_email_dkim_options/2
Return the options for the DKIM signature on outgoing emails. Called during email encoding.
effect
Run a jQuery UI effect on the target element.
set_class
Set the class of an element.
postback
Performs a custom server side validation of an input value. This allows you to add your own validation logic to HTML form fields.
mod_menu
Create nested navigation menus for your site.
backup_start
Action which starts a manual backup.
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…
trans
Translate a text value using gettext.
url
Generate the URL for a named dispatch rule. In this way it is possible to automatically change the generated URLs when the dispatch rules are modified.
mod_fileuploader dispatch rules
URL dispatch rules defined by mod_fileuploader in apps/zotonic_mod_fileuploader/priv/dispatch/dispatch.
embedded_media
Fetch media ids that are embedded in the body , body_extra and text blocks of your page.
observe_export_resource_header/2
mod_export - Fetch the header for the export.
observe_import_resource/2
An external feed delivered a resource. First handler can import it. Return:: {ok, m_rsc:resource_id()} , {error, Reason} , or undefined
cotonic_pathname_search
Render the current dispatch path_info values as a URL query string.
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.
brlinebreaks
Translate HTML <br/> elements into ASCII newlines ( \n ).
admin_config
Model for admin configuration views, including SSL certificate info, security directory info, and selected module config values.
Global template variables
These variables are always available for rendering in templates.
observe_acl_is_allowed/2
Check if a user is authorized to perform an operation on a an object (some resource or module). Observe this notification to do complex or more fine-grained…
link
Add an edge between two resources. Used in the admin.
toggle_class
Toggle a CSS class from an HTML element.
wire
Connect actions and events to a HTML element.
range
Generate a list of integers, with an optional step.
mod_survey
Adds survey resources: user-defined forms that can be created in the admin interface and filled in by site visitors. The module renders multi-page forms
translate
Translates a (English) value to the current language or the given language.
observe_media_upload_props/3
Notification that a medium file has been uploaded. This is the moment to change properties, modify the file etc. The folded accumulator is the map with updated…
controller_file_id
Redirect to the controller controller_file.
mod_contact
Implements a basic contact form, which gets emailed to the configuration value mod_contact.email , when submitted. Contact form module handling form submission
mod_authentication
This module contains the main Zotonic authentication mechanism. It contains the logon and logoff controllers, and implements the various hooks as described in…
mod_import_csv dispatch rules
URL dispatch rules defined by mod_import_csv in apps/zotonic_mod_import_csv/priv/dispatch/dispatch.
focus
Add a $(..).focus() jQuery call to the target element to give it input focus.
observe_content_types_dispatch/3
Get available content types and their dispatch rules Example: {{<<”text”>>, <<”html”>>, []}, page} A special dispatch rule is ‘page_url’, which refers to the…
controller_language_set
Controller which sets the language as given in the code argument, and redirects the user back to the page given in the p argument.
observe_import_csv_definition/2
Find an import definition for a CSV file by checking the filename of the to be imported file.
minmax
Force the given value in the given range.
menu
Show a page menu.
observe_auth_checked/2
Notify after logon of user with username, communicates valid or invalid password
observe_auth_reset/2
First to check for password reset forms, return undefined, ok, or {error, Reason}.
admin_merge_diff
Compare two resources and return a formatted list of their differences.
dialog_duplicate_rsc
Open a dialog to duplicate the current resource with a new id and title.
sorter
A sorter is a container for sortables.
call
Call an Erlang function.
min
Take the minimum of the filter value and its first argument.
observe_export_resource_content_type/2
mod_export - Determine the mime type for the export.
controller_admin_acl_rules_export
Download the site's access-control rules as a compressed Erlang term.
fade_out
Hide an element by animating the opacity.