Documentation
Browse by topic
Discover Documentation
Explore related documentation through its most useful keyword groups.
1337 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
99 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
490 itemsDocumentation not covered by the other keyword groups in this split.
Explore this clusterAll Documentation
connectdb: Test the configured PostgreSQL connection
Test the configured PostgreSQL connection.
Connecting pages
Link an article to an author, subject, or another page.
Connect resources and preserve order
An edge connects a subject resource to an object resource through a predicate. Use model#edge to inspect and manage these connections.
Connect to the running Erlang shell
From the checkout root:
content_group
Model for content-group checks, currently exposing whether a content group is in use.
Content ownership
Know who created content and who is responsible for it.
content_type_label
Return a translated, human-readable label for a MIME content type.
content_type_urls
Return the available content representations and URLs for a resource.
Contribute a Zotonic change
Build the checkout, verify the change, and send a focused pull request.
controller_admin
The admin controller is the main controller behind which admin pages are served. Its main purpose is that it does an authentication check (Is current user…
controller_admin_acl_rules_export
Download the site's access-control rules as a compressed Erlang term.
controller_admin_backup
Shows the admin backup screen where you can download nightly backups that were made by module#mod_backup.
controller_admin_backup_revision
Shows the admin backup revisions screen where you can see older version for a resource.
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.
controller_admin_comments
Shows an admin screen with an overview of most recently created comments. The screen offers the option to moderate the comments or delete them entirely.
controller_admin_comments_settings
Shows an admin settings screen where you can edit settings related to module#mod_comment.
controller_admin_config
Shows the admin config editor. Here you can edit the key/value pairs of model#config.
controller_admin_edit
The main admin edit controller. This controller serves the edit page where resources can be edited.
controller_admin_mailinglist
This controller shows the mailing lists that are available in the system.
controller_admin_mailinglist_recipients
Shows the recipients of the current mailing list. The recipients are listed in three columns, and have a checkbox next to them to deactivate them.
controller_admin_mailing_preview
This controller shows a preview of what a resource that is being mailed would look like, in a popup window.
controller_admin_mailing_run
Display mailing history and the delivery status of an individual mailing run.
controller_admin_mailing_run_content
Serve the saved HTML copy of a mailing run for a specific language.
controller_admin_mailing_status
This controller shows the mailing status of a resource. It lists each mailing list available in the system, and shows whether or not the current resource has…
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.
controller_admin_module_manager
Shows the list of Zotonic modules currently known to the system.
controller_admin_referrers
Shows the list of pages ( resources) which refer to this resource through an edge.
controller_admin_seo
Shows a form with settings related to Search Engine Optimization.
controller_admin_statistics
Render the administration dashboard for live Zotonic system statistics.
controller_api
controler_api processes authorized REST API requests: It provides an easy way to create API calls to allow computer programs to perform functions on your…
controller_authentication
This controller manages all authentication cookies. It is called by the auth model in the browser.
controller_csp_report
Controller handling Content-Security-Policy reports.
controller_export
Stream an export that is not tied to one resource.
controller_export_resource
Stream one resource, or a resource-derived list, in a negotiated export format.
controller_file
Serve an uploaded-, resized- or library file.
controller_file_id
Redirect to the controller controller_file.
controller_fileuploader
The fileuploader controller is used to upload parts of a file.
controller_hello_world
Simple controller that always serves the string Hello, World!
controller_http_error
This controller is called for serving http error pages.
controller_id
Handle different content representations of a page.
controller_keyserver_key
Publish the site's RSA encryption public key as JavaScript.
controller_language_set
Controller which sets the language as given in the code argument, and redirects the user back to the page given in the p argument.
controller_letsencrypt_challenge
Serve an ACME HTTP-01 challenge for Let's Encrypt certificate issuance.
controller_letsencrypt_ping
Return the site's current Let's Encrypt reachability token as plain text.
controller_log_client
Controller to log UI errors and events.
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.
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.
controller_mailinglist_export
Controller which downloads the given mailinglist id as a CSV file.
controller_media_runner_callback
Client-side receiver for results produced by the external media runner site. This controller belongs to mod_base , so each client site has a callback endpoint…
controller_mqtt_transport
Controller for transport of MQTT data between the browser (client) and server.
controller_nocontent
Return an empty HTTP 204 No Content response.
controller_oauth2_access_token
Exchange OAuth 2.0 credentials for a bearer access token.
controller_oauth2_service_authorize
Start an OAuth login with an external identity provider.
controller_oauth2_service_redirect
Complete the browser-facing redirect step of an external OAuth login.
controller_page
Show a rsc as a HTML page.
controller_ping
Simple controller for connection tests, used on the /test/connection page.
controller_redirect
Redirect to another url.
controller_signup
Controller which displays a form to sign up (rendered from signup.tpl ).
controller_signup_confirm
Controller which displays the confirmation page where the user can confirm his signup.
controller_static_pages
Serve a static page or pages.
controller_template
Show a template.
controller_test_helloworld
Example controller used by the Zotonic test sandbox.
controller_website_redirect
This controller does a redirect to the website property of the given resource.
controller_websub
HTTP hub and subscriber callback controller for mod_websub .
controller_websub_topic
Serve the complete JSON representation advertised as a resource's WebSub topic.
controller_zotonic_status
Serve the Zotonic status site and fallback templates.
Copying content between languages
Use existing text as a starting point for a translation.
copyright
Model for copyright and rights metadata helpers, including Creative Commons lists, rights statement lookup, and attribution/year values.
Cotonic Cotonic
Cotonic is a Javascript library which makes it possible to split the javascript code of your page into truly isolated components. By…
cotonic.broker Cotonic
The broker module handles all local publish subscribe connections. The subscriptions are stored in a trie datastructure allowing quick action. They…
cotonic.mqtt Cotonic
The mqtt module provides functions to work with mqtt topics. The broker uses this module as the basis to provide its functionality. This module…
cotonic.mqtt_bridge Cotonic
This module makes it possible to bridge the broker on the local page to an external MQTT broker.
cotonic_pathname_search
Render the current dispatch path_info values as a URL query string.
cotonic.tokenizer Cotonic
The tokenizer transforms text to html tokens. The tokenizer is used by the user interface composer in order to call the incremental-dom api.
cotonic.ui Cotonic
The user interface composer manages html snippets which can be placed in the DOM tree. When an updated html snippet is delivered to the composer it…
Create a custom template tag
Render escaped text through the current zotonic_scomp behaviour.
Create and check a site backup
Request a backup and verify its completion and scope.
Create an Erlang application with Rebar3
Build a small standalone OTP application using Erlang/OTP 28 and Rebar3.
Create a page layout
Use an existing site base template as your starting point. Put shared document structure in the base and page-specific markup in blocks.
Create a page layout
Use an existing site base template as your starting point. Put shared document structure in the base and page-specific markup in blocks.
Create a public site-map page
Render the navigation menu on a named page.
Create a reusable browser action
Wrap a maintained Zotonic action instead of assembling JavaScript strings.
Create a reusable module
Create apps_user/zotonic_mod_garden with the following files. This example adds a discoverable module without starting an extra process.
Create a reusable module
Create apps_user/zotonic_mod_garden with the following files. This example adds a discoverable module without starting an extra process.
createdb: Prepare a site database and schema
Prepare a site database and schema.
Create your first site
Create the garden blog, open it in your browser, and sign in to its admin.
Create your first site
Create the garden blog, open it in your browser, and sign in to its admin.
Create your first site
Create the garden blog, open it in your browser, and sign in to its admin.
Creating a mailing
Prepare the page that will become your email.
Creating and using collections
Group pages into an ordered set.
Creating a page
Start a new page with the right category and language.
Creating a quiz
Mark correct answers, set scores, and choose the feedback respondents see.
Creating a user
Set up an account when your role allows user management.
Creating submenus
Place a menu entry under another entry.
Creating your first form
Create an unpublished survey and give respondents a clear introduction.
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…
custom
Support for custom client-side (JavaScript-based) validators.
Customize HTTP error pages
Override the error template while preserving the response status.
Customize login and signup presentation
Reuse the maintained authentication flow and override its presentation.
custom_redirect
Model for custom redirect records, exposing redirect list and individual redirect lookup by id.