g
Frontend | Backend | Api

Documentation default templates

This page contains an overview of the default templates for the Documentation module.

The overview is generated based on controllers using the specified template as their default layout and containing GET methods; thus depending on the configuration the controller might not use the template at all or other controllers might use the template too.
The table is only meant as a first orientation which ResponseVariables can likely be expected when working with the template.

File Controller GET Response variables GET Description
documentation/global-pages/model.html GlobalPages\Model
Name Type Description
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_menu Coredna\Kernel\Helper\Response\Menu Menu helper; provides easy access to DXP defined menus
abstraction string Current abstraction
currentModule string Current module
currentModel string Current module
modules array Array with documented modules
root Page Root page
Show a page documenting a model
documentation/global-pages/show.html GlobalPages\Show
Name Type Description
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_menu Coredna\Kernel\Helper\Response\Menu Menu helper; provides easy access to DXP defined menus
modules array Array with documented modules
abstraction string Current abstraction
page Page Page that is displayed
_validation Coredna\Kernel\Helper\Validation Validation helper
Show the page
documentation/pages/show.html Pages\Show
Name Type Description
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_menu Coredna\Kernel\Helper\Response\Menu Menu helper; provides easy access to DXP defined menus
modules array Array with documented modules
abstraction string Current abstraction
page Page Page that is displayed
_validation Coredna\Kernel\Helper\Validation Validation helper
Show the page