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
catinclude
Include another template based on the category of a resource. The include tag is replaced with the contents of the included template file. You can give…
observe_survey_is_allowed_results_download/2
Check if the current user is allowed to download a survey.
rsc
The main resource model, which is the central part of the Zotonic data model. This model provides an interface to all resource ("page") information. It also…
dialog_predicate_new
Show a dialog for creating a new predicate.
mod_admin_merge dispatch rules
URL dispatch rules defined by mod_admin_merge in apps/zotonic_mod_admin_merge/priv/dispatch/dispatch.
content_group
Model for content-group checks, currently exposing whether a content group is in use.
comment
Model for comments attached to resources. It provides listing, moderation checks, counting, and retrieval of individual comments.
observe_email_ensure_handler/2
Add a handler for receiving e-mail notifications
mod_seo_sitemap dispatch rules
URL dispatch rules defined by mod_seo_sitemap in apps/zotonic_mod_seo_sitemap/priv/dispatch/dispatch.
mod_base dispatch rules (dispatch-test)
URL dispatch rules defined by mod_base in apps/zotonic_mod_base/priv/dispatch/dispatch-test.
round
Round a floating point value to the nearest integer.
observe_debug/2
Push some information to the debug page in the user-agent. Will be displayed with io_lib:format(“~p: p n”, [What, Arg]), be careful with escaping information!
mod_ssl_letsencrypt dispatch rules
URL dispatch rules defined by mod_ssl_letsencrypt in apps/zotonic_mod_ssl_letsencrypt/priv/dispatch/dispatch.
without_embedded_media
Filter out media ids that are embedded in the body , body_extra and text blocks of your page.
droppable
Mark an element as valid drag destination.
Model for Facebook integration helpers, including auth-use flag, profile picture fetch, and Graph API proxy calls.
admin
This model exposes some meta-information for the use in mod_admin templates.
slugify
Converts a text into a slug.
inherit
Include the markup of an extended template into the extending template.
mod_admin_modules dispatch rules (dispatch_module_admin)
URL dispatch rules defined by mod_admin_modules in apps/zotonic_mod_admin_modules/priv/dispatch/dispatch_module_admin.
observe_media_identify_extension/2
Try to find a filename extension for a mime type (example: <<".jpg">> )
Port configurations
Port configurations can be tricky, especially in combination with SSL. Here we explain all steps to come to a correctly configured installation with working…
controller_logon_done
This controller is used as a jumping stone after a log on from the /logon page. The p argument is passed from the /logon page.
mod_linkedin dispatch rules
URL dispatch rules defined by mod_linkedin in apps/zotonic_mod_linkedin/priv/dispatch/dispatch.
observe_filewatcher/2
Broadcast some file changed, used for livereload by mod_development
controller_mailinglist_export
Controller which downloads the given mailinglist id as a CSV file.
controller_log_client
Controller to log UI errors and events.
buttonize
Add button interaction classes to an element.
survey_result_column_values
Used by the survey module to add extra column values to the result editor.
observe_activity/2
An activity in Zotonic. When this is handled as a notification then return a list of patterns matching this activity. These patterns are then used to find…
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.
media
Access to data about uploaded files and other media.
parse_url
Parses an URL (URI) using uri_string:parse/1 .
observe_security_headers/2
Check and possibly modify the http response security headers All headers are in lowercase.
slice
Perform array-slice operations on a list or string.
slide_fade_in
Show an element by animating the height and opacity.
controller_letsencrypt_ping
Return the site's current Let's Encrypt reachability token as plain text.
delete_username
Delete the username from a user, no confirmation.
inplace_textbox
Render a JS-aided inplace textbox.
observe_auth_confirm_done/2
A user id has been confirmed.
to_json
Display any value as in JSON (JavaScript Object Notation).
publish
Publishes a message on the topic tree of the current page.
observe_rsc_insert/3
Foldr for a resource insert, these are the initial properties and will overrule the properties in the insert request. Use with care. The props are the…
escapejson
Escapes the value for safe insertion into JSON strings.
controller_admin_statistics
Render the administration dashboard for live Zotonic system statistics.
observe_session_context/3
Refresh the context or request process for the given request or action
mod_cookie_consent
Wrap external content in such a way that it is only loaded if the user consented to the inclusion of the content (and subsequent cookies).
url_abs
Generates an absolute URL for the given dispatch information.
dialog_config_delete
Open a dialog that asks confirmation to delete a configuration key/value pair.
fade_in
Show an element by animating the opacity.
dialog_config_new
Open a dialog to create a new configuration key/value pair.
capfirst
Converts the first character of the value to uppercase.
mod_logging dispatch rules
URL dispatch rules defined by mod_logging in apps/zotonic_mod_logging/priv/dispatch/dispatch.
mod_mqtt
MQTT is a machine-to-machine (M2M)/“Internet of Things” connectivity protocol. It was designed as an extremely lightweight publish/subscribe messaging…
observe_media_upload_preprocess/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…
observe_search_query/2
Map a custom search term to a #search_sql_term{} record.
show
Show an element without any animation.
backup
Model for backup configuration and operational status, including backup permissions, listing, directory, encryption settings, and active backup state.
mod_development dispatch rules (tests)
URL dispatch rules defined by mod_development in apps/zotonic_mod_development/priv/dispatch/tests.
custom_redirect
Model for custom redirect records, exposing redirect list and individual redirect lookup by id.
observe_auth_postcheck/2
First for logon of user with username, called after successful password check.
form_reset
Resets the target form to its initial state.
pickle
Pickle an Erlang value so that it can be safely submitted with a form.
reload
Reload the current page.
observe_pivot_rsc_data/3
Fold over the resource props map to extend/remove data to be pivoted
is_valid_email
Test whether a value has valid email-address syntax.
observe_rsc_get/3
Resource is read, opportunity to add computed fields Used in a foldr with the read properties as accumulator.
Site configuration
This chapter describes the configuration options for your sites. There’s also global configuration.
menu_expand
Takes a menu, or a menu resource id, and adds all haspart objects connected to the menu ids.
mod_l10n
Localization of Zotonic. Provides lookups for country, month, week names. Localization module providing locale, country, and timezone data and related helpers.
lib
Combine css and javascript includes in a single request.
observe_auth_validate/2
First to validate a password. Return {ok, RscId} or {error, Reason}.
observe_ssl_options/2
Request the SSL certificates for this site. The server_name property contains the hostname used by the client. (first) Returns either ‘undefined’ or a list of…
ifequal
Show something if two values are equal.
observe_survey_get_handlers/3
Fetch list of handlers for survey submits.
survey_any_correct_answer
Determine if any answer of a question was correct. Used for showing results of thurstone test questions.
mailing_page_test
Post a message to the test mailing list, given with the id argument.
format
Regular expression test.
mod_auth2fa dispatch rules
URL dispatch rules defined by mod_auth2fa in apps/zotonic_mod_auth2fa/priv/dispatch/dispatch.
observe_auth_precheck/2
First for logon of user with username, check for ratelimit, blocks etc.
mod_seo_sitemap
Creates a sitemap.xml file for your site, containing links to all publicly accessible pages.
search
The m_search model provides access to different kinds of search queries for searching through models.
observe_email_is_blocked/2
Check if an email address is blocked
mod_wires
Actions, tags (also known as screen components), and javascript for user interfaces using wires .
Reference
All the nitty gritty details when the big picture has settled.
as_atom
Convert a value to an Erlang atom.
truncate_html
Truncate a HTML text to a maximum length.
observe_export_resource_content_disposition/2
mod_export - return the {ok, Disposition} for the content disposition.
split_in
This filter split a list in shorter lists. It splits an array in N sub-arrays of more or less equal length. This is useful when displaying a list of items in…
log
Model for runtime logging state and access to server log entries for clients allowed to read logs.
default
Provide an alternative value in case a value has a falsy value (0, false , undefined or empty string).
observe_admin_rscform/3
Used in the admin to process a submitted resource form
member
Finds a value in a list.
round_significant
Round a number value to a number of significant digits. The significance defaults to two digits.
observe_signup_confirm/2
Signal that a user has been confirmed. (map, result is ignored)
name_unique
A validator to check whether a resource’s name is unique:
length
Check the length of a text input.
mod_contact dispatch rules
URL dispatch rules defined by mod_contact in apps/zotonic_mod_contact/priv/dispatch/dispatch.
survey_prepare_narrative
Parse a survey narrative question into renderable text and input parts.