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
acceptable_password
A validator to check whether a password conforms to the password secutiry requirements.
observe_auth_identity_types/3
Return the list of identity types that allow somebody to logon and become an active user of the system. Defaults to [ username_pw ]. In the future more types…
CSS classes used in templates
If you are building a website then you might want to use the standard dialogs, overlays, authentication and other parts of Zotonic. To make those look like…
0.82.0
Welcome to Zotonic 0.82.0, released on March 25, 2024.
search_status
Model for search subsystem status, including facet table health checks and facet definition metadata.
0.81.0
Welcome to Zotonic 0.81.0, released on January 12, 2024.
observe_language_detect/2
Try to detect the language of a translation. Set is_editable_only to false to detect any language, even if the language is not enabled for the site. Return…
observe_translate/2
Request a translation of a list of strings. The resulting translations must be in the same order as the request. This notification is handled by modules that…
About collaboration groups
Working together on private content. Groups can organize and manage members without the complexity of the full access control system.
0.80.0
Welcome to Zotonic 0.80.0, released on November 21, 2023.
format_dispatch_path_element
Format dispatch path element so variables will be more visible.
format_dispatch_controller_option
Format dispatch controller options.
media_for_language
Filter a list of media items by their medium_language property, return the best matching with the current or given language. Only visible media items are…
Building a live updating search page
Search pages are often simple forms that reload the page with new arguments. In this article we will show how you can make a search page that updates live…
Tracing templates for greater understanding
A picture tells a thousand words, so we added an exciting new development tool to explore which templates are used during page rendering. Our new tool gives a…
truncatechars
Truncate a text to a maximum length in characters.
menu_ids
Returns all resource ids in a menu. Could return invisible and non existing resource ids. The returned ids are a flat list, the hierarchy of the menu is lost.
observe_survey_result_columns/3
Add header columns for export. The values are the names of the answers and the text displayed above the column. The text format is for a complete export, the…
0.78.1
Welcome to Zotonic 0.78.1, released on July 6, 2023.
0.78.0
Welcome to Zotonic 0.78.0, released on June 29, 2023.
rdf
Model for RDF summaries of resources. It provides short RDF-oriented summary maps for resources, with translated and non-translated variants.
json
Validate that a form value is JSON.
oauth2_consumer
Model for OAuth2 consumer configuration and token access, including consumer lists and per-consumer token retrieval.
upper
Translates the value to upper case.
all_catinclude
Include a template for all a resource’s categories from all modules.
mod_base dispatch rules (dispatch-cotonic)
URL dispatch rules defined by mod_base in apps/zotonic_mod_base/priv/dispatch/dispatch-cotonic.
observe_validate_query_args/3
Called just before validation of all query arguments by z_validation.
controller_admin_mailing_preview
This controller shows a preview of what a resource that is being mailed would look like, in a popup window.
unlink
Remove an edge between two resources. Used in the admin.
category
This model can retrieve information about the resource category hierarchy in different ways.
mod_custom_redirect
Enables redirects from unknown hosts and paths to other locations. The other location can be a known path or another web site.
urlencode
Make a text safe for URLs.
zmedia_has_chosen
Used by the admin as a callback when a media file has been selected for insertion into the rich-text editor.
index_of
Returns the index of the first occurrence of the item in the given list.
group_firstchar
Group a list of sorted model#rsc resource IDs on their first letter of the title or another resource property. After grouping, it splits this list in a number…
observe_mailinglist_message/2
Send a welcome or goodbye message to the given recipient. The recipient is either a recipient-id or a recipient props. ‘what’ is send_welcome, send_confirm
enable
Resets the “disabled” attribute of a HTML tag and removes the CSS class “disabled”.
menu_subtree
Get the subtree of an id in a menu (if any).
menu_trail
Return a breadcrumb navigation trail for the given id.
sub_year
Subtracts a year from a date. The value must be of the form {{Y,M,D},{H,I,S}} .
if
Selects an argument depending on a condition.
delete_media
Delete a media file from a resource, without confirmation.
linebreaksbr
Translate ASCII newlines ( \n ) into HTML <br /> elements.
first
Returns the first character or element.
mod_development
Presents various tools for development.
mailinglist_subscribe
Show the mailinglist subscription form to subscribe to a certain mailinglist id.
alert
Show an alert dialog.
oauth2
Model for OAuth2 app/client/token administration and user token listings.
observe_edge_insert/2
An edge has been inserted. Note that the Context for this notification does not have the user who created the edge.
l10n
Model for localization helpers, including countries, country names, available timezones, and site timezone settings.
backup_revision
Model for resource revision backup metadata, including revision list/title retrieval and revision retention settings.
observe_signup_done/2
Signal that a user has been signed up (map, result is ignored)
sanitize_url
Sanitize an URL. Removes URLs that might be dangerous, like javascript: URLs.
script
This tag is the placeholder where all generated JavaScript scripts will be output on the page.
numericality
Numerical input and range check.
wire_args
Add extra arguments to wired actions.
mod_translation dispatch rules (dispatch_translation)
URL dispatch rules defined by mod_translation in apps/zotonic_mod_translation/priv/dispatch/dispatch_translation.
mod_admin_statistics dispatch rules
URL dispatch rules defined by mod_admin_statistics in apps/zotonic_mod_admin_statistics/priv/dispatch/dispatch.
mod_facebook
The mod_facebook module plugs into the authentication system to enable Facebook login on your site.
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:
observe_custom_pivot/2
Add custom pivot fields to a resource’s search index (map) Result is a single tuple or list of tuples {pivotname, props} , where “pivotname” is the pivot…
controller_admin_config
Shows the admin config editor. Here you can edit the key/value pairs of model#config.
eq_day
Tests if the value is a date and equal to the argument. The value and the argument must be a tuple of the format {Y,M,D} or {{Y,M,D},{H,I,S}} .
observe_resource_headers/3
Let all modules add resource specific response headers to the request. The accumulator is the list of headers to be set.
mask
Places a mask over an element, useful for blocking user interaction during lengthy postbacks.
The addsite command
Adding a site to Zotonic is done through the zotonic shell command. It syntax is like this:
date
Formats a date or datetime according to the format specified in the argument.
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…
observe_survey_is_submit/2
Check if a question (page block) is a submitting question.
mod_site_update
This module pulls updates of a site‘s code from a remote version control system. The supported version control systems are git and mercurial.
make_list
Forces the value to a list.
disable
Sets the “disabled” attribute of a HTML tag and adds the CSS class “disabled”.
chart_pie3d
Deprecated compatibility alias for scomp#chart_pie.
mod_admin_config dispatch rules
URL dispatch rules defined by mod_admin_config in apps/zotonic_mod_admin_config/priv/dispatch/dispatch.
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.
language_dir
Return rtl or ltr depening on the direction of the language.
observe_tkvstore_put/2
Put a value into the typed key/value store
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.
insert_after
Insert rendered HTML immediately after the target element.
survey
Model for survey reporting and participant state, including results, totals, per-user answers, exports, and result handlers.
mod_microsoft
Adds logon using the Microsoft identity platform.
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…
admin_blocks
Model for listing editable content blocks for a resource in the admin interface.
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.
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 .
seo
Model for SEO-related settings and generated SEO metadata, including webmaster verification keys, analytics settings, and JSON-LD output.
log_email
Model for email log lookups used by logging/admin views.
reversed
Reverse a list.
is_list
Test if a value is a list:
req
This model gives access to the request variables from within a template.
sortable
Mark an element as sortable.
development
Model for development and diagnostics controls, including tracing flags, observer lists, cache/compile/reindex actions, and dispatch info.
rand
Generates a random number. The number is from, and including, 1 up to, and including, the input value.
add_day
Adds a day to a date. The value must be of the form {{Y,M,D},{H,I,S}} .
sub_day
Subtracts a day from a date. The value must be of the form {{Y,M,D},{H,I,S}} .
for
Loop over multiple values in a list or search result.
overlay_open
Renders a template on the server and opens a full screen overlay with the HTML output of the template.
observe_signup/2
Request a signup of a new or existing user. Arguments are similar to #signup_url{} Returns {ok, UserId} or {error, Reason}
overlay_close
Closes the currently open overlay. When there is no overlay open then nothing happens.
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.