Text
Browse by topic
Discover Text
Explore related documentation through its most useful keyword groups.
1342 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
101 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
492 itemsDocumentation not covered by the other keyword groups in this split.
Explore this clusterAll Text
loremipsum
Inserts a piece of “lorem ipsum” text into the page.
ip2geo
Return geographic information associated with an IP address.
observe_admin_edit_blocks/3
Used in the admin to fetch the possible blocks for display
mod_ssl_ca
The mod_ssl_ca module adds support for using SSL certificates bought from a Certificate Authority.
client_session_storage
Model to access the sessionStorage on the client (browser).
observe_m_config_update_prop/2
Site configuration parameter was changed
controller_signup
Controller which displays a form to sign up (rendered from signup.tpl ).
observe_logon_ready_page/2
Check where to go after a user logs on.
observe_export_resource_visible/2
mod_export - Check if the resource or dispatch is visible for export.
yesno
Show a boolean value as a text.
raw
Make a literal section which does not interpret tags.
mod_development dispatch rules (development)
URL dispatch rules defined by mod_development in apps/zotonic_mod_development/priv/dispatch/development.
mod_ratelimit
Implements rate limiting for various resources.
overrules
Inherit markup from like named template in another module.
controller_api
controler_api processes authorized REST API requests: It provides an easy way to create API calls to allow computer programs to perform functions on your…
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_email_relay
This module supports relaying email between Zotonic servers.
observe_media_viewer/2
Request to generate a HTML media viewer for a resource. The HTML data can not contain any Javascript, as it might be serialized. This could happen if the…
tokens
Returns a list of tokens from input string, separated by the characters in the filter argument.
survey_answer_split
Filter to split multi-value survey answers on the '#' character.
dialog_delete_username
Open a dialog to confirm the deletion of the username of a user.
escape_link
Convert any URLs in a plaintext into HTML links, with adding the rel="nofollow" attribute, and replaces all newlines with <br> tags.
rjust
Justifies the value in a field of a certain width to the right, using spaces.
admin_note
Add an editorial note to any resource.
slide_fade_out
Hide an element by animating the height and opacity.
urlize
Find urls in the given input and make them clickable.
mod_video
Adds support for viewing and handling video medium items.
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.
mailinglist_unsubscribe
Cancel a mailing list subscription. The recipient id is given with the id argument.
controller_redirect
Redirect to another url.
controller_oauth2_access_token
Exchange OAuth 2.0 credentials for a bearer access token.
mailinglist_confirm
Confirm a mailinglist subscription. Required argument is the confirm_key .
mask_progress
Sets the progress bar of an action#mask.
slide_up
Hide an element by animating the height.
Model for LinkedIn integration helpers, currently exposing whether LinkedIn auth integration is enabled.
controller_export_resource
Stream one resource, or a resource-derived list, in a negotiated export format.
mod_acl_user_groups
This module adds rule-based access control.
observe_request_context/3
Refresh the context or request process for the given request or action
observe_rsc_update/3
An updated resource is about to be persisted. Observe this notification to change the resource properties before they are persisted.
dialog_user_add
Show a dialog for adding a user. This creates a person resource and adds a username / password to it.
add_week
Adds a week to a date. The value must be of the form {{Y,M,D},{H,I,S}} .
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()
mod_import_wordpress
Import WordPress .wxr files in your site.
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.
mod_oembed
Makes media resources from embeddable URLs through the OEmbed protocol.
dialog_close
Closes a dialog. When there is no dialog open then nothing happens.
mod_zotonic_site_management
Site management module for creating, configuring, and controlling managed Zotonic sites.
is_undefined
Tests if a value is undefined.
image_url
Generate the url of a still image.
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…
import_csv_data
Model to track resources imported from CSV and XLSX files.
observe_acl_context_authenticated/2
Set the context to a typical authenticated user. Used by m_acl.erl
mod_admin dispatch rules
URL dispatch rules defined by mod_admin in apps/zotonic_mod_admin/priv/dispatch/dispatch.
observe_auth_client_switch_user/2
Send a request to the client to switch users. The zotonic.auth.worker.js will
force_escape
HTML escapes a text.
max
Take the maximum of the filter value and its first argument.
mod_admin_identity
Provides identity management in the admin - for example the storage of usernames and passwords.
sysconfig
Note
mod_oauth2
OAuth2 provider module for app/client/token management and authorization flows.
mod_logging
Logs messages to the database and adds log views to the admin.
controller_admin_module_manager
Shows the list of Zotonic modules currently known to the system.
mod_import_csv
Module which adds “import CSV” button to the admin status screen.
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…
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.
controller_oauth2_service_authorize
Start an OAuth login with an external identity provider.
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_menu_rsc/2
Fetch the menu id belonging to a certain resource
observe_acl_user_groups/2
Return the groups for the current user.
translation
The m_translation model gives easy access to language and translation related information.
effect
Run a jQuery UI effect on the target element.
backup_start
Action which starts a manual backup.
wire
Connect actions and events to a HTML element.
auth2fa
Model for two-factor authentication state and setup, including TOTP QR/image generation, mode checks, reset checks, and clock skew checks.
Global template variables
These variables are always available for rendering in templates.
set_class
Set the class of an element.
admin_config
Model for admin configuration views, including SSL certificate info, security directory info, and selected module config values.
cotonic_pathname_search
Render the current dispatch path_info values as a URL query string.
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
observe_email_dkim_options/2
Return the options for the DKIM signature on outgoing emails. Called during email encoding.
brlinebreaks
Translate HTML <br/> elements into ASCII newlines ( \n ).
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.
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…
mod_artwork
This module contains many useful icons and images.
mod_fileuploader dispatch rules
URL dispatch rules defined by mod_fileuploader in apps/zotonic_mod_fileuploader/priv/dispatch/dispatch.
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…
observe_export_resource_header/2
mod_export - Fetch the header for the export.
mod_menu
Create nested navigation menus for your site.
zmedia_choose
Used after a media item is selected in the media chooser for the TinyMCE editor.
link
Add an edge between two resources. Used in the admin.
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…
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.
trans
Translate a text value using gettext.
mod_admin_statistics
Admin module exposing site statistics views and related dashboard metrics.
embedded_media
Fetch media ids that are embedded in the body , body_extra and text blocks of your page.
postback
Performs a custom server side validation of an input value. This allows you to add your own validation logic to HTML form fields.
toggle_class
Toggle a CSS class from an HTML element.
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…
observe_email_failed/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_identity_verified/2
Notify that a user’s identity has been verified. Signals to modules handling identities to mark this identity as verified. Handled by mod_admin_identity to…
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…