Text
Browse by topic
Discover Text
Explore related documentation through its most useful keyword groups.
1383 items
Grouped by Architecture
Template filter
200 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
124 itemsA namespaced interface for retrieving or changing data and invoking operations in Zotonic or browser-side components.
Explore this clusterModule
112 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
103 itemsA server-side template_compiler document that renders data into HTML text email or another representation.
Explore this clusterDispatch rule
65 itemsA route declaration that matches a URL pattern and selects a controller with arguments.
Explore this clusterController
63 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
508 itemsDocumentation not covered by the other keyword groups in this split.
Explore this clusterAll Text
email_status
Tracks the send/bounce/error status of all outgoing emails.
element
Select an element from a tuple or list of tuples.
observe_url_fetch_options/2
Determine the URL fetch options for fetching the content of an URL. Used by z_fetch.erl.
after
Return the first element after another element in a list. For example:
remove
Remove an element from the page.
last
Returns the last character or element.
move
Move the target element by appending it to another element.
observe_auth_logoff/3
User is about to log off. Modify (if needed) the logoff request context.
mod_media_exif
When uploading a file, this module extracts properties from the uploaded media and sets them in the resource.
all_include
Call all modules to include a certain template.
trans_ext
Translate a text value using gettext and substitute variables.
config_toggle
Toggle a configuration value. Used in the admin, for instance when displaying a “live” checkbox the state of which should reflect a config value.
group_by
Groups items of a list by a property.
controller_admin_category_sorter
Shows the admin category screen where you can edit the category tree, rearranging the categories, adding new categories, or removing existing ones.
content_type_label
Return a translated, human-readable label for a MIME content type.
now
Show the current date and time.
unmask
Removes a mask that was placed over an element using the action#mask action.
mod_admin_frontend
Adds editing of resources, menu-trees and collections for non-admin users.
ne_day
Tests if two dates are not equal.
observe_dispatch_rewrite/3
Rewrite a URL before it will be dispatched using the z_sites_dispatcher
join
Joins the elements of a list. Joins the elements of the input list together, separated by the argument.
sanitize_html
Sanitize a HTML code. Removes elements and attributes that might be dangerous, like <script> elements.
email_unique
Check if an entered e-mail address is unique by querying model#identity for the email key:
observe_tkvstore_delete/2
Delete a value from the typed key/value store
mod_ssl_letsencrypt
Request certificates from Let’s Encrypt.
is_a
Filter a list of resource ids on category, or test if a single resource id belongs to a category.
observe_identity_verification/2
Request to send a verification to the user. Return ok or an error. Handled by mod_signup to send out verification emails. Identity may be undefined, or is an…
utc
Translates a datetime from local time to UTC.
set_url_language
Change the language of an URL to another language. Useful to generate alternative URLs for a page.
observe_auth_client_logon_user/2
Send a request to the client to login a user. The zotonic.auth.worker.js will
observe_sanitize_element/3
Sanitize an HTML element.
mod_audio
Adds support for viewing and handling audio medium items.
fileuploader
Model to start uploads, upload a block and delete uploads.
observe_survey_result_column_values/3
Modify row with answers for export. The header columns are given and the values that are known are set in the folded value. The user_id is the user who filled…
image_data_url
Generate a data: url of a still image.
mod_authentication dispatch rules
URL dispatch rules defined by mod_authentication in apps/zotonic_mod_authentication/priv/dispatch/dispatch.
module_rescan
Rescans all modules, to find all templates, lib files, dispatch rules, etc. again.
block
Define a template block and overrules a template block from an inherited template.
observe_sanitize_embed_url/2
Sanitize an embed url. The hostpart is of the format: <<"youtube.com/v...">> .
mod_seo
Adds basic search engine optimization to the base templates and provides an admin interface for configuring SEO options and Google Universal Analytics.
timesince
Show a readable version of a date/time difference.
inject_recipientdetails
Adds recipient query string details to hyperlinks.
mod_signup
This module presents an interface for letting users register themselves.
dialog_mail_page
Shows the dialog to mail the current page ( resource) to a single e-mail address. This is used in the frontend of a site to “share” the current page over e
trigger_event
Trigger a named {% wire %} event in the browser. The required name argument identifies the wire; every other action argument is passed to the named event.
submit
Submits the enclosing form, a specifically targeted form or the closest form to an element.
admin_menu
This model holds the admin menu, which is built up by calling each module to add items to the menu.
mod_filestore dispatch rules
URL dispatch rules defined by mod_filestore in apps/zotonic_mod_filestore/priv/dispatch/dispatch.
typeselect
Show possible selections whilst typing.
observe_email_received/2
Notification sent to a site when e-mail for that site is received
controller_admin
The admin controller is the main controller behind which admin pages are served. Its main purpose is that it does an authentication check (Is current user…
survey_prepare_matching
Prepare the items and options of a survey matching question for rendering.
length
Returns the length of the value.
observe_signup_failed_url/2
Signup failed, give the error page URL. Return {ok, Url} or undefined. Reason is returned by the signup handler for the particular signup method (username
observe_acl_collab_groups_modify/3
Modify the list of collaboration groups of a user. Called internally by the ACL modules when fetching the list of collaboration groups a user is member of.
zlink
Used for inserting an internal link in the TinyMCE editor in the admin.
pprint
Pretty print a zotonic value in a template.
observe_language/2
Notify that the session’s language has been changed
to_integer
Convert the input to an integer value.
mod_admin_frontend dispatch rules
URL dispatch rules defined by mod_admin_frontend in apps/zotonic_mod_admin_frontend/priv/dispatch/dispatch.
random
Returns a random value from a list of values. When the input is an empty list or not a list then the result is undefined.
survey_is_submit
Check if the questions end with a question type that is a submit button.
observe_edge_delete/2
An edge has been deleted Note that the Context for this notification does not have the user who deleted the edge.
observe_category_hierarchy_save/2
Save (and update) the complete category hierarchy
show_media
Convert the image markers in HTML from the Rich Text editor into image tags.
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…
draggable
Mark a html element as draggable.
controller_id
Handle different content representations of a page.
add_year
Adds a year to a date. The value must be of the form {{Y,M,D},{H,I,S}} .
mod_translation
This module provides support for dealing with multiple languages.
email_dkim
DomainKeys Identified Mail Signatures (RFC 6376) is a method to add a signature to outgoing emails. This enables recipients to check who sent an email and if…
mod_content_groups
Module for content group support and ACL-aware content group behavior.
observe_set_user_language/2
Set the language of the context to a user’s prefered language
ifchanged
Not implemented, but exists in Zotonic for forward compatibility with future ErlyDTL and Django versions.
reset
Resets the enclosing form, a specifically targeted form or the closest form to an element.
sort
The sort filter takes a list of items to sort. Items can be an ordinary list of terms, property lists, or maps. It can also be a list of resource ids to be…
animate
Add a $(..).animate jQuery call to the target element.
Command-line reference
Look up the syntax, requirements, and effects of each bundled command.
template
Render a template. When used in a postback action, the result will be sent back with the response data for the postback.
mqtt_ticket
A ticketing system for out of band MQTT posts via HTTP.
if_undefined
Tests whether a value is undefined, returning the given argument.
mailinglist
Model for mailinglist operations and reporting, including recipient counts, delivery stats, subscriptions, and scheduled mailings.
Check if the content of the input field is an e-mail address.
logoff
This action logs off the current user and reloads the current page as the anonymous visitor.
signup
Exported APIs:
observe_rsc_query_item/2
Send a notification that the resource ‘id’ is added to the query query_id.
observe_export_resource_encode/2
mod_export - Encode a single data element.
observe_email_add_handler/2
Add a handler for receiving e-mail notifications
mod_search
mod_search implements various ways of searching through the main resource table using model#search.
sub_week
Subtracts a week from a date. The value must be of the form {{Y,M,D},{H,I,S}} .
observe_media_preview_options/3
Modify the options for an image preview url or tag. This is called for every image url generation, except if the ‘original’ image option is passed. The…
comment
Ignore part of a template.
gravatar_code
Calculate the gravatar code for an e-mail address:
mod_backup
mod_backup serves two different purposes: it makes a nightly backup of your files and database, and can also backup/restore individual resource items.
autoescape
Automatically apply HTML escaping to values.
fix_ampersands
Replaces ampersands in the value with “&” entities.
observe_mailinglist_mailing/2
Send a page to a mailinglist (notify) Use {single_test_address, Email} when sending to a specific e-mail address.
controller_website_redirect
This controller does a redirect to the website property of the given resource.
controller_admin_seo
Shows a form with settings related to Search Engine Optimization.
mod_acl_mock
Mocking module for access control during tests.