Text
All Text
Gives access to the Zotonic system configuration from the zotonic.config file(s).
Dispatch rules Name Path Resource Args id [“id”,id] controller_id [] lib [“lib”,’*’] controller_file [{root
A user id has been confirmed.
This model gives access to the request variables from within a template.
The category hierarchy tables have been replaced by m_hierarchy . This model defines named hierarchies of resources…
Used for inserting an internal link in the TinyMCE editor in the admin.
Not yet documented.
This action logs off the current user and reloads the current page as the anonymous visitor.
auth_disconnect delete_username dialog_delete_username dialog_set_username_password dialog_user_add logoff…
Add custom pivot fields to a resource’s search index (map) Result is a single tuple or list of tuples {pivotname
Model to access the server side storage of data.
action_event_type activity activity_send admin_edit_blocks admin_menu admin_rscform category_hierarchy_save…
pivot_fields pivot_rsc_data pivot_update custom_pivot
media_identify_extension media_identify_file media_import media_import_medium media_preview_options media_import_props…
email_add_handler email_bounced email_dkim_options email_drop_handler email_ensure_handler email_failed…
edge_delete edge_insert edge_update
Enables the Zotonic site to relay emails for the site’s users to their real email addresses.
Enables the Zotonic site to receive emails for the site’s users. The user’s email address is username@hostname , where…
Adding a site to Zotonic is done through the zotonic shell command. It syntax is like this:
This model holds the admin menu, which is built up by calling each module to add items to the menu.
Site configuration parameter was changed
Model to access the sessionStorage on the client (browser).
Rescans all modules, to find all templates, lib files, dispatch rules, etc. again.
module_rescan module_toggle
Add WYSIWYG editor controls to all textarea’s with the z_editor class in the target.
Fetch the menu id belonging to a certain resource
Fold over the context after logon of user with username, communicates valid or invalid password
Show a dialog for setting a username / password on the given resource (which is usually a person).
Dispatch rules Name Path Resource Args sitemap_xml [“sitemap.xml”] controller_template [{template,”sitemap.tpl”}
Delete the username from a user, no confirmation.
Not yet documented.
Open a dialog to confirm the deletion of the username of a user.
Dispatch rules Name Path Resource Args admin_backup [“admin”,”backup”] controller_admin_backup [seo_noindex]…
Not yet documented.
Push some information to the debug page in the user-agent. Will be displayed with io_lib:format(“~p: ~p~n”, [What, Arg]…
Used by the admin as a callback when a media file has been selected for insertion into the rich-text editor.
Signal that the hierarchy underneath a resource has been changed by mod_menu
Save (and update) the complete category hierarchy
Accesses comments on a page.
script
The m_translation model gives easy access to language and translation related information.
mod_search implements various ways of searching through the main resource table using m_search.
Shows the admin dialog for uploading a media item. See Media.
Open a dialog to edit the “basic” information of a resource.
Open a dialog to confirm the deletion of a resource.
Delete a media file from a resource, without confirmation.
delete_media delete_rsc dialog_delete_rsc dialog_duplicate_rsc dialog_edit_basics dialog_media_upload dialog_new_rsc…
Fold over the resource props map to extend/remove data to be pivoted
Upload and replace the resource with the given data. The data is in the given format.
An updated resource is about to be persisted. Observe this notification to change the resource properties before they…
Send a notification that the resource ‘id’ is added to the query query_id.
Resource will be deleted. This notification is part of the delete transaction, it’s purpose is to clean up associated…
rsc_delete rsc_get rsc_import_fetch rsc_insert rsc_merge rsc_pivot_done rsc_query_item rsc_update rsc_update_done…
Closes the currently open overlay. When there is no overlay open then nothing happens.
dialog dialog_open dialog_close overlay_open overlay_close
Access information about which modules are installed and which ones are active.
Create new users In the admin, under ‘Auth’ > ‘Users’ you can find a list of all users. Use the ‘Make a new user’…
User is about to log off. Modify (if needed) the logoff request context.
Updates the content of an iframe with a template or a literal HTML text.
Set the class of an element.
Add a $(..).effect jQuery call to the target element.
add_class animate buttonize effect fade_in fade_out hide insert_after insert_before insert_bottom insert_top…
Not yet documented.
Handle a new file received in the ‘files/dropbox’ folder of a site. Unhandled files are deleted after a hour.
Sanitize an HTML element.
When uploading a file, this module extracts properties from the uploaded media and sets them in the resource.
Submits the enclosing form, a specifically targeted form or the closest form to an element.
Resets the enclosing form, a specifically targeted form or the closest form to an element.
Resets the target form to its initial state.
Bind actions to a jQuery event or submit a form.
disable enable event focus form_reset reset set_value submit typeselect validation_error
Not yet documented.
Show more results of the current search query inline on the page.
moreresults
Not yet documented.
Not yet documented.
Add a handler for receiving e-mail notifications
Notification sent to a site when e-mail for that site is received
If you encounter any issues in using Zotonic, or have ideas for new features, please let us know at the Zotonic issue…
Rewrite a URL after it has been generated using the z_dispatcher
Rewrite a URL before it will be dispatched using the z_sites_dispatcher
content_types_dispatch dispatch dispatch_host dispatch_rewrite page_url url_abs url_rewrite
Get available content types and their dispatch rules Example: {“text/html”, page} A special dispatch rule is ‘page_url’
Not yet documented.
Simple (type,key)/value store. Stores data in the store with minimal latency and (local) serialization of get/put…
Simple read-only interface to the typed key-value store of mod_tkvstore. To get a value from the store: use m.tkvstore.
Sets the progress bar of a mask.
Removes a mask that was placed over an element using the mask action.
Places a mask over an element, useful for blocking user interaction during lengthy postbacks.
This module presents an interface for letting users register themselves.
Request the SSL certificates for this site. The server_name property contains the hostname used by the client. (first…
Move an element to another place, appending it to the target. The element is given by id with the element argument, or…
A module has been activated and started.
Model to access the localStorage on the client (browser).
Reload the current page.
This action redirects the browser to another page or back to the previous page.
redirect reload
Not yet documented.
Map to signal merging two resources. Move any information from the loser to the winner. The loser will be deleted.