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
ssl_letsencrypt
Model for Let's Encrypt status information, available to administrators.
is_visible
Filter a list of resource ids so that only the visible ids remain.
lower
Translates the value to lower case.
filter
Filters a list on the value of a property, either on presence or equality.
mod_filestore
Support for storing uploaded and generated images and documents on external services.
email_receive_recipient
Model for received-email recipient extraction and matching used by mod_email_receive.
acl_user_group
Model for ACL user-group helper values in mod_acl_user_groups, including collaboration-group settings and category usage checks.
ljust
Justifies the value in a field of a certain width to the left, with spaces.
dialog_mailing_page
Shows the dialog to mail the current page ( resource) to a mailing list. This is used in the admin “mailing status” interface. A mailing can be sent…
observe_pivot_update/3
Pivot just before a m_rsc_update update. Used to pivot fields before the pivot itself.
insert
Prepends the argument in front of the value.
survey_prepare_thurstone
Normalize a survey Thurstone question before rendering or processing it.
hierarchy
The category hierarchy tables have been replaced by m_hierarchy . This model defines named hierarchies of resources (pages).
is_letsencrypt_valid_hostname
Test if a hostname can be used for a Let’s Encrypt certificate.
if
Show something if the condition is true.
templatetag
Not implemented, but exists in Zotonic for forward compatibility with future ErlyDTL and Django versions.
observe_email_status/2
Email status notification, sent when the validity of an email recipient changes
observe_rsc_pivot_done/2
Signal that a resource pivot has been done.
insert_before
Insert the result of a render action before an HTML element.
observe_hierarchy_updated/2
Signal that the hierarchy underneath a resource has been changed by mod_menu
mod_bootstrap
Adds support for the Twitter Bootstrap CSS / JavaScript framework. Integration module for Bootstrap assets and helper templates/components.
add_class
Add a css class to an html element.
mod_admin_modules
Adds support in the admin for activating and deactivating modules.
mod_server_storage
Server side storage for the client (aka browser) and server.
image_edit
Manages the medium_edit_settings property for non destructive image editing.
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…
observe_media_viewer_consent/2
Optionally wrap HTML with external content so that it adheres to the cookie/privacy settings of the current site visitor. Typically called with a ‘first’ by…
with
Assign a complex value to a variable.
authentication
Model for authentication state and login support checks, including password authentication flow helpers and reminder/verification actions.
observe_output_html/3
Fold for mapping non-iolist output to iolist values.
acl
The m_acl model gives access the id of the currently logged in user, and provides a mechanism to do basic access control checks.
controller_http_error
This controller is called for serving http error pages.
observe_acl_logon/2
Initialize context with the access policy for the user.
mod_mailinglist
This module implements a mailing list system. You can make as many mailing lists as you like and send any page to any mailing list, including confirm mail and…
editor_remove
Remove WYSIWYG editor controls from the textareas selected by the target. Use this before replacing or moving editor-managed markup so the editor can release…
moreresults
Show more results of the current search query inline on the page.
delete_rsc
Delete a resource, without confirmation.
datediff
Calculate the difference between two dates, returning a single part of that difference.
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…
replace
Regular expression replacement of a pattern with a string.
regroup
Not implemented tag, for forward compatibility with future ErlyDTL and Django versions.
observe_user_context/3
Set #context fields depending on the user and/or the preferences of the user.
dialog_open
Renders a template on the server and opens a dialog with the HTML output of the template.
observe_rsc_delete/2
Resource will be deleted. This notification is part of the delete transaction, it’s purpose is to clean up associated data.
observe_acl_is_allowed_prop/2
Check if a user is authorizded to perform an action on a property. Defaults to true .
observe_media_replace_file/2
Notification that a medium file has been changed (notify) The id is the resource id, medium contains the medium’s complete property map.
mod_admin_merge
Adds functionality to merge two pages together into a single page.
live
Live-updating templates driven by MQTT topics.
escapexml
Escape the value for insertion in xml output.
config
Zotonic has two places where a site's configuration is kept:
observe_signup_url/2
Handle a signup of a user, return the follow on page for after the signup. Return {ok, Url} ‘props’ is a map with properties for the person resource (email
growl
Show a message in the upper right corner of the browser window. The message will automatically disappear after some time.
observe_module_deactivate/2
A module has been stopped and deactivated.
observe_media_import/2
Notification to translate or map a file after upload, before insertion into the database Used in mod_video to queue movies for conversion to mp4. You can set…
mod_menu dispatch rules
URL dispatch rules defined by mod_menu in apps/zotonic_mod_menu/priv/dispatch/dispatch.
observe_tkvstore_get/2
Get a value from the typed key/value store
stringify
Translates atoms, integers and floats to strings. The undefined value is translated to the empty string. Does not translate tuples.
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…
observe_m_config_update/2
Site configuration parameter was changed
format_number
Show an integer or float.
format_duration
Show a duration in hours, minutes and seconds.
controller_file
Serve an uploaded-, resized- or library file.
dialog_edit_basics
Open a dialog to edit the “basic” information of a resource.
escape
HTML escape a text. Escapes all reserved HTML characters in the value. Escaped strings are safe to be displayed in a HTML page. When you echo a query string…
date
Validate input date against a given date format.
controller_admin_comments_settings
Shows an admin settings screen where you can edit settings related to module#mod_comment.
language_sort
Sort a list of language codes or map with languages on their sort key. Return a list of {Code, LanguageProps} pairs.
observe_dispatch_host/2
Try to find the site for the request Called when the request Host doesn’t match any active site.
update
Updates the content of an HTML element with a template or a literal HTML text.
predicate
Retrieve information about predicates. Predicates are the labels on edges (connections between resources) that give meaning to an edge. An example is the…
ACL options
Authorization checks to perform, in addition to the acl_action dispatch option, can be given in the acl dispatch option, and accepts the following options:
menu_rsc
Return the menu to be displayed with a resource.
escape_check
Ensures thant an HTML escaped value is properly escaped.
template
Model for dynamic template rendering. It renders a template path passed in the request path and returns the rendered template output.
controller_mqtt_transport
Controller for transport of MQTT data between the browser (client) and server.
mod_admin_predicate dispatch rules
URL dispatch rules defined by mod_admin_predicate in apps/zotonic_mod_admin_predicate/priv/dispatch/dispatch.
is_site_url
Test if the given URL is a url for the current site.
observe_signup_check/3
signup_check Check if the signup can be handled, a fold over all modules. Fold argument/result is {ok, Props, SignupProps} or {error, Reason}
observe_auth_options_update/3
Update the given (accumulator) authentication options with the request options.
escape_ical
Escape the value according to the RFC2445 rules.
mod_email_receive
Enables the Zotonic site to receive emails for the site’s users. The user’s email address is username@hostname, where the hostname is the hostname as…
validation_error
Render a validation error on the target. Text is given in the text argument.
mod_admin_category
Note
observe_signup_confirm_redirect/2
Fetch the page a user is redirected to after signing up with a confirmed identity
observe_media_stillimage/2
See if there is a ‘still’ image preview of a media item. (eg posterframe of a movie) Return:: {ok, ResourceId} or undefined
survey_is_stop
Check if there is a ‘stop’ question in list of (survey) blocks
observe_postback_notify/2
Handle a javascript notification from the postback handler. The message is the the request, trigger the id of the element which triggered the postback, and…
striptags
Removes all HTML tags from the value.
before
Return the first element before another element in a list. For example:
exclude
Filters a list on the value of a property, either on absence or inequality.
observe_rsc_upload/2
Upload and replace the resource with the given data. The data is in the given format.
temporary_rsc
Creates a temporary resource if its input value is not defined.
observe_acl_user_groups_modify/3
Modify the list of user groups of a user. Called internally by the ACL modules when fetching the list of user groups a user is member of.
controller_admin_backup
Shows the admin backup screen where you can download nightly backups that were made by module#mod_backup.
truncate
Truncate a text to a maximum length.
observe_comment_insert/2
Notification to signal an inserted comment. ‘comment_id’ is the id of the inserted comment, ‘id’ is the id of the resource commented on.
controller_ping
Simple controller for connection tests, used on the /test/connection page.
date_range
Show a date range.
controller_keyserver_key
Publish the site's RSA encryption public key as JavaScript.
presence
Check if an input has been filled in or checked.