Text
Browse by topic
Discover Text
Explore related documentation through its most useful keyword groups.
1374 items
Grouped by Architecture
Template filter
198 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
121 itemsA namespaced interface for retrieving or changing data and invoking operations in Zotonic or browser-side components.
Explore this clusterModule
111 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
101 itemsA server-side template_compiler document that renders data into HTML text email or another representation.
Explore this clusterDispatch rule
64 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
505 itemsDocumentation not covered by the other keyword groups in this split.
Explore this clusterAll Text
tkvstore
Simple read-only interface to the typed key-value store of module#mod_tkvstore. To get a value from the store: use m.tkvstore.type.key, like this:
vsplit_in
This filter splits 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…
controller_admin_config
Shows the admin config editor. Here you can edit the key/value pairs of model#config.
insert_after
Insert rendered HTML immediately after the target element.
for
Loop over multiple values in a list or search result.
log_email
Model for email log lookups used by logging/admin views.
mod_microsoft
Adds logon using the Microsoft identity platform.
is_list
Test if a value is a list:
observe_media_import_medium/2
Notification to import a medium record from external source. This is called for non-file medium records, for example embedded video. If the medium record is…
observe_tkvstore_put/2
Put a value into the typed key/value store
development
Model for development and diagnostics controls, including tracing flags, observer lists, cache/compile/reindex actions, and dispatch info.
controller_admin_media_preview
A controller for rendering preview thumbnails of any media embedded in a richtext-editor component of a resource on the controller#controller_admin_edit page.
disable
Sets the “disabled” attribute of a HTML tag and adds the CSS class “disabled”.
sub_day
Subtracts a day from a date. The value must be of the form {{Y,M,D},{H,I,S}} .
reversed
Reverse a list.
controller_logoff
Controller that logs off a user, destroying the session. It also removes any “remember me” cookies the user has, so that auto-logon is disabled.
observe_activity_send/2
Push a list of activities via a ‘channel’ (eg ‘email’) to a recipient. The activities are a list of #activity{} records.
chart_pie3d
Deprecated compatibility alias for scomp#chart_pie.
seo
Model for SEO-related settings and generated SEO metadata, including webmaster verification keys, analytics settings, and JSON-LD output.
admin_blocks
Model for listing editable content blocks for a resource in the admin interface.
mod_admin_config dispatch rules
URL dispatch rules defined by mod_admin_config in apps/zotonic_mod_admin_config/priv/dispatch/dispatch.
rand
Generates a random number. The number is from, and including, 1 up to, and including, the input value.
sortable
Mark an element as sortable.
language_dir
Return rtl or ltr depening on the direction of the language.
req
This model gives access to the request variables from within a template.
add_day
Adds a day to a date. The value must be of the form {{Y,M,D},{H,I,S}} .
survey
Model for survey reporting and participant state, including results, totals, per-user answers, exports, and result handlers.
mod_admin_predicate
Add support for editing predicates in the admin, by presenting a list of all defined predicates on http://yoursite.com/admin/predicate .
mod_base dispatch rules (dispatch-test)
URL dispatch rules defined by mod_base in apps/zotonic_mod_base/priv/dispatch/dispatch-test.
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.
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…
mod_seo_sitemap dispatch rules
URL dispatch rules defined by mod_seo_sitemap in apps/zotonic_mod_seo_sitemap/priv/dispatch/dispatch.
dialog_predicate_new
Show a dialog for creating a new predicate.
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_email_ensure_handler/2
Add a handler for receiving e-mail notifications
observe_survey_is_allowed_results_download/2
Check if the current user is allowed to download a survey.
droppable
Mark an element as valid drag destination.
round
Round a floating point value to the nearest integer.
overlay_close
Closes the currently open overlay. When there is no overlay open then nothing happens.
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!
image
Show a still image using an <img\> element. The image will be automatically resized to the desired size and filters. For video, use the tag#media tag instead.
overlay_open
Renders a template on the server and opens a full screen overlay with the HTML output of the template.
mod_admin_merge dispatch rules
URL dispatch rules defined by mod_admin_merge in apps/zotonic_mod_admin_merge/priv/dispatch/dispatch.
Model for Facebook integration helpers, including auth-use flag, profile picture fetch, and Graph API proxy calls.
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.
observe_signup/2
Request a signup of a new or existing user. Arguments are similar to #signup_url{} Returns {ok, UserId} or {error, Reason}
parse_url
Parses an URL (URI) using uri_string:parse/1 .
slice
Perform array-slice operations on a list or string.
media
Access to data about uploaded files and other media.
survey_result_column_values
Used by the survey module to add extra column values to the result editor.
buttonize
Add button interaction classes to an element.
controller_letsencrypt_ping
Return the site's current Let's Encrypt reachability token as plain text.
mod_admin_config
Add support for editing the site’s configuration values, as accessed through model#config.
inplace_textbox
Render a JS-aided inplace textbox.
observe_security_headers/2
Check and possibly modify the http response security headers All headers are in lowercase.
slugify
Converts a text into a slug.
delete_username
Delete the username from a user, no confirmation.
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.
mod_admin_category dispatch rules
URL dispatch rules defined by mod_admin_category in apps/zotonic_mod_admin_category/priv/dispatch/dispatch.
observe_filewatcher/2
Broadcast some file changed, used for livereload by mod_development
controller_log_client
Controller to log UI errors and events.
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.
slide_fade_in
Show an element by animating the height and opacity.
inherit
Include the markup of an extended template into the extending template.
observe_auth_confirm_done/2
A user id has been confirmed.
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…
observe_media_identify_extension/2
Try to find a filename extension for a mime type (example: <<".jpg">> )
admin
This model exposes some meta-information for the use in mod_admin templates.
controller_mailinglist_export
Controller which downloads the given mailinglist id as a CSV file.
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…
fade_in
Show an element by animating the opacity.
dialog_config_new
Open a dialog to create a new configuration key/value pair.
dialog_config_delete
Open a dialog that asks confirmation to delete a configuration key/value pair.
observe_search_query/2
Map a custom search term to a #search_sql_term{} record.
mod_mqtt
MQTT is a machine-to-machine (M2M)/“Internet of Things” connectivity protocol. It was designed as an extremely lightweight publish/subscribe messaging…
show
Show an element without any animation.
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.
mod_logging dispatch rules
URL dispatch rules defined by mod_logging in apps/zotonic_mod_logging/priv/dispatch/dispatch.
url_abs
Generates an absolute URL for the given dispatch information.
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…
to_json
Display any value as in JSON (JavaScript Object Notation).
controller_admin_statistics
Render the administration dashboard for live Zotonic system statistics.
publish
Publishes a message on the topic tree of the current page.
capfirst
Converts the first character of the value to uppercase.
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).
observe_session_context/3
Refresh the context or request process for the given request or action
observe_pivot_rsc_data/3
Fold over the resource props map to extend/remove data to be pivoted
mod_l10n
Localization of Zotonic. Provides lookups for country, month, week names. Localization module providing locale, country, and timezone data and related helpers.
ifequal
Show something if two values are equal.
observe_auth_postcheck/2
First for logon of user with username, called after successful password check.
mod_development dispatch rules (tests)
URL dispatch rules defined by mod_development in apps/zotonic_mod_development/priv/dispatch/tests.
menu_expand
Takes a menu, or a menu resource id, and adds all haspart objects connected to the menu ids.
Site configuration
This chapter describes the configuration options for your sites. There’s also global configuration.
custom_redirect
Model for custom redirect records, exposing redirect list and individual redirect lookup by id.
reload
Reload the current page.
observe_auth_validate/2
First to validate a password. Return {ok, RscId} or {error, Reason}.