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
template
Model for dynamic template rendering. It renders a template path passed in the request path and returns the rendered template output.
update
Updates the content of an HTML element with a template or a literal HTML text.
controller_mqtt_transport
Controller for transport of MQTT data between the browser (client) and server.
validation_error
Render a validation error on the target. Text is given in the text argument.
temporary_rsc
Creates a temporary resource if its input value is not defined.
observe_acl_user_groups_modify/3
Modify the list of user groups of a user. Called internally by the ACL modules when fetching the list of user groups a user is member of.
controller_keyserver_key
Publish the site's RSA encryption public key as JavaScript.
exclude
Filters a list on the value of a property, either on absence or inequality.
truncate
Truncate a text to a maximum length.
observe_rsc_upload/2
Upload and replace the resource with the given data. The data is in the given format.
log_format_stack
Escapes and formats a Javascript string with a stack trace to readable HTML.
striptags
Removes all HTML tags from the value.
observe_comment_insert/2
Notification to signal an inserted comment. ‘comment_id’ is the id of the inserted comment, ‘id’ is the id of the resource commented on.
observe_postback_notify/2
Handle a javascript notification from the postback handler. The message is the the request, trigger the id of the element which triggered the postback, and…
before
Return the first element before another element in a list. For example:
date_range
Show a date range.
observe_media_stillimage/2
See if there is a ‘still’ image preview of a media item. (eg posterframe of a movie) Return:: {ok, ResourceId} or undefined
controller_admin_backup
Shows the admin backup screen where you can download nightly backups that were made by module#mod_backup.
observe_scomp_script_render/2
Add extra javascript with the {% script %} tag. (map) Used to let modules inject extra javascript depending on the arguments of the {% script %} tag. Must…
presence
Check if an input has been filled in or checked.
controller_ping
Simple controller for connection tests, used on the /test/connection page.
editor_tinymce
Model exposing TinyMCE editor version metadata used by admin/editor integration.
replace_args
Replace $N placeholders in string from a list of replacement values.
survey_is_stop
Check if there is a ‘stop’ question in list of (survey) blocks
normalize_email
Normalize an email address, used in the identity management.
ifnotequal
Show something if two values are not equal.
observe_rsc_merge/2
Map to signal merging two resources. Move any information from the loser to the winner. The loser will be deleted.
observe_admin_menu/3
Used for fetching the menu in the admin.
format_integer
Show an integer value.
worker
Start a named Cotonic worker from a template.
config_delete
Trigger the deletion of a configuration value. Used in the admin.
controller_admin_backup_revision
Shows the admin backup revisions screen where you can see older version for a resource.
media
Show embed, video or audio media.
in_future
Tests if a date is in the future.
survey_any_wrong_answer
Determine if any answer of a question was wrong. Used for showing results of thurstone test questions.
spaceless
Removes whitespace between HTML tags.
load
Loads the given custom tags for use in the templates. Normally not needed, as custom tags are automatically loaded through the module system.
observe_page_url/2
Fetch the url of a resource’s html representation
spinner
Add an AJAX activity indicator.
cache
Cache frequently used rendered template output for later reuse.
username_unique
Check if an entered username is unique by querying model#identity for the given username:
group_title_firstchar
Similar to filter#group_firstchar, but always uses the title column from the rsc table.
mod_linkedin
The mod_linkedin module plugs into the authentication system to enable LinkedIn login on your site.
editor_add
Add WYSIWYG editor controls to the textareas selected by the target. The active editor integration, such as TinyMCE, implements the actual controls; the action…
last
Returns the last character or element.
remove
Remove an element from the page.
config_toggle
Toggle a configuration value. Used in the admin, for instance when displaying a “live” checkbox the state of which should reflect a config value.
filter
Filter the contents of a block through variable filters.
is_number
Test if a value is a number (integer or floating point):
microsoft
Check with useauth if the authentication using the Microsoft identity platform is enabled and configured.
md5
Translates a string to a md5 hex value.
add_hour
Adds an hour to a date. The value must be of the form {{Y,M,D},{H,I,S}} .
all_include
Call all modules to include a certain template.
trans_ext
Translate a text value using gettext and substitute variables.
sha1
Translate a string to a sha1 hex value.
remove_class
Remove a CSS class from an HTML element.
mod_media_exif
When uploading a file, this module extracts properties from the uploaded media and sets them in the resource.
move
Move the target element by appending it to another element.
mailinglist_recipient_key_decode
Used on the mailing list subscriptions page where users and recipients can unsubscribe from mailinglists.
observe_module_activate/2
A module has been activated and started.
controller_letsencrypt_challenge
Serve an ACME HTTP-01 challenge for Let's Encrypt certificate issuance.
observe_auth_logoff/3
User is about to log off. Modify (if needed) the logoff request context.
after
Return the first element after another element in a list. For example:
email_status
Tracks the send/bounce/error status of all outgoing emails.
controller_nocontent
Return an empty HTTP 204 No Content response.
mod_cron
Provides periodic tick notifications and module-defined cron job scheduling.
observe_media_update_done/2
Media update done notification. action is ‘insert’, ‘update’ or ‘delete’
match
Match a value with a regular expression.
controller_page
Show a rsc as a HTML page.
observe_url_fetch_options/2
Determine the URL fetch options for fetching the content of an URL. Used by z_fetch.erl.
element
Select an element from a tuple or list of tuples.
sanitize_html
Sanitize a HTML code. Removes elements and attributes that might be dangerous, like <script> elements.
mod_audio
Adds support for viewing and handling audio medium items.
observe_identity_verification/2
Request to send a verification to the user. Return ok or an error. Handled by mod_signup to send out verification emails. Identity may be undefined, or is an…
is_a
Filter a list of resource ids on category, or test if a single resource id belongs to a category.
observe_sanitize_element/3
Sanitize an HTML element.
set_url_language
Change the language of an URL to another language. Useful to generate alternative URLs for a page.
mod_admin_frontend
Adds editing of resources, menu-trees and collections for non-admin users.
utc
Translates a datetime from local time to UTC.
ne_day
Tests if two dates are not equal.
content_type_label
Return a translated, human-readable label for a MIME content type.
fileuploader
Model to start uploads, upload a block and delete uploads.
join
Joins the elements of a list. Joins the elements of the input list together, separated by the argument.
unmask
Removes a mask that was placed over an element using the action#mask action.
controller_admin_category_sorter
Shows the admin category screen where you can edit the category tree, rearranging the categories, adding new categories, or removing existing ones.
now
Show the current date and time.
observe_dispatch_rewrite/3
Rewrite a URL before it will be dispatched using the z_sites_dispatcher
observe_tkvstore_delete/2
Delete a value from the typed key/value store
mod_ssl_letsencrypt
Request certificates from Let’s Encrypt.
observe_survey_result_column_values/3
Modify row with answers for export. The header columns are given and the values that are known are set in the folded value. The user_id is the user who filled…
email_unique
Check if an entered e-mail address is unique by querying model#identity for the email key:
observe_auth_client_logon_user/2
Send a request to the client to login a user. The zotonic.auth.worker.js will
group_by
Groups items of a list by a property.
submit
Submits the enclosing form, a specifically targeted form or the closest form to an element.
typeselect
Show possible selections whilst typing.
module_rescan
Rescans all modules, to find all templates, lib files, dispatch rules, etc. again.
dialog_mail_page
Shows the dialog to mail the current page ( resource) to a single e-mail address. This is used in the frontend of a site to “share” the current page over e
mod_seo
Adds basic search engine optimization to the base templates and provides an admin interface for configuring SEO options and Google Universal Analytics.
observe_signup_failed_url/2
Signup failed, give the error page URL. Return {ok, Url} or undefined. Reason is returned by the signup handler for the particular signup method (username
mod_authentication dispatch rules
URL dispatch rules defined by mod_authentication in apps/zotonic_mod_authentication/priv/dispatch/dispatch.