Browse by topic

Discover Text

Explore related documentation through its most useful keyword groups.

1342 items

Grouped by Architecture

All Text

Validators

acceptable_password

A validator to check whether a password conforms to the password secutiry requirements.

Notifications

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…

Developer guide

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…

Release notes

0.82.0

Welcome to Zotonic 0.82.0, released on March 25, 2024.

Models

search_status

Model for search subsystem status, including facet table health checks and facet definition metadata.

Release notes

0.81.0

Welcome to Zotonic 0.81.0, released on January 12, 2024.

Notifications

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…

Notifications

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…

Article

About collaboration groups

Working together on private content. Groups can organize and manage members without the complexity of the full access control system.

About collaboration groups

Release notes

0.80.0

Welcome to Zotonic 0.80.0, released on November 21, 2023.

Filters

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…

Article

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…

Building a live updating search page

Article

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…

Tracing templates for greater understanding

Filters

truncatechars

Truncate a text to a maximum length in characters.

Filters

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.

Notifications

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…

Release notes

0.78.1

Welcome to Zotonic 0.78.1, released on July 6, 2023.

Release notes

0.78.0

Welcome to Zotonic 0.78.0, released on June 29, 2023.

Models

rdf

Model for RDF summaries of resources. It provides short RDF-oriented summary maps for resources, with translated and non-translated variants.

Validators

json

Validate that a form value is JSON.

Models

category

This model can retrieve information about the resource category hierarchy in different ways.

Filters

index_of

Returns the index of the first occurrence of the item in the given list.

Actions

zmedia_has_chosen

Used by the admin as a callback when a media file has been selected for insertion into the rich-text editor.

Tags

all_catinclude

Include a template for all a resource’s categories from all modules.

Notifications

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

Filters

urlencode

Make a text safe for URLs.

Models

oauth2_consumer

Model for OAuth2 consumer configuration and token access, including consumer lists and per-consumer token retrieval.

Filters

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…

Actions

unlink

Remove an edge between two resources. Used in the admin.

Filters

upper

Translates the value to upper case.

Modules

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.

Filters

linebreaksbr

Translate ASCII newlines ( \n ) into HTML <br /> elements.

Filters

menu_subtree

Get the subtree of an id in a menu (if any).

Filters

first

Returns the first character or element.

Filters

if

Selects an argument depending on a condition.

Scomp

script

This tag is the placeholder where all generated JavaScript scripts will be output on the page.

Filters

sanitize_url

Sanitize an URL. Removes URLs that might be dangerous, like javascript: URLs.

Filters

sub_year

Subtracts a year from a date. The value must be of the form {{Y,M,D},{H,I,S}} .

Actions

enable

Resets the “disabled” attribute of a HTML tag and removes the CSS class “disabled”.

Actions

delete_media

Delete a media file from a resource, without confirmation.

Actions

alert

Show an alert dialog.

Filters

menu_trail

Return a breadcrumb navigation trail for the given id.

Models

l10n

Model for localization helpers, including countries, country names, available timezones, and site timezone settings.

Scomp

mailinglist_subscribe

Show the mailinglist subscription form to subscribe to a certain mailinglist id.

Models

backup_revision

Model for resource revision backup metadata, including revision list/title retrieval and revision retention settings.

Models

oauth2

Model for OAuth2 app/client/token administration and user token listings.

Notifications

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.

Filters

make_list

Forces the value to a list.

Modules

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.

Models

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:

Actions

mask

Places a mask over an element, useful for blocking user interaction during lengthy postbacks.

Scomp

wire_args

Add extra arguments to wired actions.

Notifications

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.

Notifications

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…

Modules

mod_facebook

The mod_facebook module plugs into the authentication system to enable Facebook login on your site.

Reference

The addsite command

Adding a site to Zotonic is done through the zotonic shell command. It syntax is like this:

Filters

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}} .

Filters

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…

Filters

date

Formats a date or datetime according to the format specified in the argument.

Controllers

controller_admin_config

Shows the admin config editor. Here you can edit the key/value pairs of model#config.

Models

req

This model gives access to the request variables from within a template.

Filters

sub_day

Subtracts a day from a date. The value must be of the form {{Y,M,D},{H,I,S}} .

Actions

disable

Sets the “disabled” attribute of a HTML tag and adds the CSS class “disabled”.

Filters

add_day

Adds a day to a date. The value must be of the form {{Y,M,D},{H,I,S}} .

Actions

insert_after

Insert rendered HTML immediately after the target element.

Notifications

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…

Filters

language_dir

Return rtl or ltr depening on the direction of the language.

Controllers

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.

Models

log_email

Model for email log lookups used by logging/admin views.

Filters

rand

Generates a random number. The number is from, and including, 1 up to, and including, the input value.

Scomp

sortable

Mark an element as sortable.

Modules

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 .

Models

seo

Model for SEO-related settings and generated SEO metadata, including webmaster verification keys, analytics settings, and JSON-LD output.

Scomp

chart_pie3d

Deprecated compatibility alias for scomp#chart_pie.

Modules

mod_microsoft

Adds logon using the Microsoft identity platform.

Models

survey

Model for survey reporting and participant state, including results, totals, per-user answers, exports, and result handlers.

Notifications

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.

Models

admin_blocks

Model for listing editable content blocks for a resource in the admin interface.

Filters

is_list

Test if a value is a list:

Models

development

Model for development and diagnostics controls, including tracing flags, observer lists, cache/compile/reindex actions, and dispatch info.

Tags

for

Loop over multiple values in a list or search result.

Controllers

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.

Scomp

droppable

Mark an element as valid drag destination.