Text
Browse by topic
Explore related documentation through its most useful keyword groups.
1438 items
Grouped by Architecture
A named transformation applied to a value inside a template expression.
Explore this clusterA typed event or request exchanged between decoupled Zotonic components through the notifier.
A namespaced interface for retrieving or changing data and invoking operations in Zotonic or browser-side components.
Explore this clusterAn OTP application or site component that adds Zotonic behavior templates data and configuration.
Explore this clusterA server-defined browser action or event binding connected through Zotonic wires.
Explore this clusterA server-side template_compiler document that renders data into HTML text email or another representation.
Explore this clusterA request handler that maps web requests to responses and coordinates authorization rendering or data transfer.
Explore this clusterA route declaration that matches a URL pattern and selects a controller with arguments.
Explore this clusterThe central Zotonic entity that represents content users media categories and other addressable objects.
Explore this clusterDocumentation not covered by the other keyword groups in this split.
Explore this clusterAdd a handler for receiving e-mail notifications
Show a dialog for creating a new predicate.
URL dispatch rules defined by mod_ssl_letsencrypt in apps/zotonic_mod_ssl_letsencrypt/priv/dispatch/dispatch.
Model for content-group checks, currently exposing whether a content group is in use.
Model for Facebook integration helpers, including auth-use flag, profile picture fetch, and Graph API proxy calls.
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.
Mark an element as valid drag destination.
URL dispatch rules defined by mod_admin_merge in apps/zotonic_mod_admin_merge/priv/dispatch/dispatch.
Renders a template on the server and opens a full screen overlay with the HTML output of the template.
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…
Round a floating point value to the nearest integer.
Request a signup of a new or existing user. Arguments are similar to #signup_url{} Returns {ok, UserId} or {error, Reason}
Converts a text into a slug.
URL dispatch rules defined by mod_admin_modules in apps/zotonic_mod_admin_modules/priv/dispatch/dispatch_module_admin.
Show an element by animating the height and opacity.
Include the markup of an extended template into the extending template.
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…
Add button interaction classes to an element.
Add support for editing the site’s configuration values, as accessed through model#config.
Port configurations can be tricky, especially in combination with SSL. Here we explain all steps to come to a correctly configured installation with working…
Used by the survey module to add extra column values to the result editor.
Delete the username from a user, no confirmation.
URL dispatch rules defined by mod_linkedin in apps/zotonic_mod_linkedin/priv/dispatch/dispatch.
Return the site's current Let's Encrypt reachability token as plain text.
Access to data about uploaded files and other media.
Controller to log UI errors and events.
Render a JS-aided inplace textbox.
Parses an URL (URI) using uri_string:parse/1 .
Try to find a filename extension for a mime type (example: <<".jpg">> )
Controller which downloads the given mailinglist id as a CSV file.
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.
Broadcast some file changed, used for livereload by mod_development
URL dispatch rules defined by mod_admin_category in apps/zotonic_mod_admin_category/priv/dispatch/dispatch.
Check and possibly modify the http response security headers All headers are in lowercase.
This model exposes some meta-information for the use in mod_admin templates.
A user id has been confirmed.
Perform array-slice operations on a list or string.
Escapes the value for safe insertion into JSON strings.
Map a custom search term to a #search_sql_term{} record.
Display any value as in JSON (JavaScript Object Notation).
Refresh the context or request process for the given request or action
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…
URL dispatch rules defined by mod_logging in apps/zotonic_mod_logging/priv/dispatch/dispatch.
Show an element without any animation.
Converts the first character of the value to uppercase.
Open a dialog that asks confirmation to delete a configuration key/value pair.
Render the administration dashboard for live Zotonic system statistics.
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…
MQTT is a machine-to-machine (M2M)/“Internet of Things” connectivity protocol. It was designed as an extremely lightweight publish/subscribe messaging…
Open a dialog to create a new configuration key/value pair.
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).
Publishes a message on the topic tree of the current page.
Show an element by animating the opacity.
Generates an absolute URL for the given dispatch information.
First for logon of user with username, called after successful password check.
Model for backup configuration and operational status, including backup permissions, listing, directory, encryption settings, and active backup state.
Determine if any answer of a question was correct. Used for showing results of thurstone test questions.
Model for custom redirect records, exposing redirect list and individual redirect lookup by id.
URL dispatch rules defined by mod_development in apps/zotonic_mod_development/priv/dispatch/tests.
Fetch list of handlers for survey submits.
First to validate a password. Return {ok, RscId} or {error, Reason}.
Test whether a value has valid email-address syntax.
Include CSS and JavaScript libraries, combining files of each type into a single request.
Resource is read, opportunity to add computed fields Used in a foldr with the read properties as accumulator.
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…
Pickle an Erlang value so that it can be safely submitted with a form.
Takes a menu, or a menu resource id, and adds all haspart objects connected to the menu ids.
Resets the target form to its initial state.
Show something if two values are equal.
Fold over the resource props map to extend/remove data to be pivoted
This chapter describes the configuration options for your sites. There’s also global configuration.
Reload the current page.
Localization of Zotonic. Provides lookups for country, month, week names. Localization module providing locale, country, and timezone data and related helpers.
URL dispatch rules defined by mod_contact in apps/zotonic_mod_contact/priv/dispatch/dispatch.
Convert a value to an Erlang atom.
All the nitty gritty details when the big picture has settled.
Truncate a HTML text to a maximum length.
Regular expression test.
Check if an email address is blocked
A validator to check whether a resource’s name is unique:
Provide an alternative value in case a value has a falsy value (0, false , undefined or empty string).
Finds a value in a list.
Post a message to the test mailing list, given with the id argument.
mod_export - return the {ok, Disposition} for the content disposition.
Model for runtime logging state and access to server log entries for clients allowed to read logs.
First for logon of user with username, check for ratelimit, blocks etc.
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…
Signal that a user has been confirmed. (map, result is ignored)
URL dispatch rules defined by mod_auth2fa in apps/zotonic_mod_auth2fa/priv/dispatch/dispatch.
The m_search model provides access to different kinds of search queries for searching through models.
Used in the admin to process a submitted resource form
Check the length of a text input.
Creates a sitemap.xml file for your site, containing links to all publicly accessible pages.
Actions, tags (also known as screen components), and javascript for user interfaces using wires .
Round a number value to a number of significant digits. The significance defaults to two digits.
This controller shows the mailing lists that are available in the system.
Translates the value to lower case.
Filter a list of resource ids so that only the visible ids remain.
Model for Let's Encrypt status information, available to administrators.
Return the language the resource (or translated text) will be displayed in.