☰ Browse the reference

Templates·Documentation module

Documentation templates

Default templates the Documentation module renders, the controller that renders each one and what it receives. A file at the same path in your site repository replaces the platform's.

View Default templates of the public site.

Templates view

documentation/global-pages/model.html Copy GlobalPages\Model

Show a page documenting a model

The template receives

Variable	Type	Description
$abstraction	string	Current abstraction
$abstractions	array	Model documentation for every abstraction, keyed Frontend, Api, Backend
$currentModule	string	Current module
$currentModel	string	Current module
$modules	array	Array with documented modules
$root	Page	Root page

Common variables such as $_url, $_request and $_menu are available too. Global template variables

Override it: create templates/documentation/global-pages/model.html in your site repository.

documentation/global-pages/show.html Copy GlobalPages\Show

Show the page

The template receives

Variable	Type	Description
$modules	array	Array with documented modules
$abstraction	string	Current abstraction
$page	Page	Page that is displayed

Common variables such as $_url, $_request and $_menu are available too. Global template variables

Override it: create templates/documentation/global-pages/show.html in your site repository.

documentation/pages/show.html Copy Pages\Show

Show the page

The template receives

Variable	Type	Description
$modules	array	Array with documented modules
$abstraction	string	Current abstraction
$page	Page	Page that is displayed

Common variables such as $_url, $_request and $_menu are available too. Global template variables

Override it: create templates/documentation/pages/show.html in your site repository.