☰ 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 cdna-admin screens you can override in your site repository.

Admin view

documentation/backend/comments/add.html Copy Comments\Add

Add a new record. Assigns an empty record to the template.

The admin template receives

Variable	Type	Description
$comment	Comment	Single (empty) Comment record

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

Customise this admin screen: create templates/documentation/backend/comments/add.html in your site repository.

documentation/backend/comments/edit.html Copy Comments\Edit

Retrieve a single record and display the edit page for the record

The admin template receives

Variable	Type	Description
$comment	Comment	Retrieved Comment record

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

Customise this admin screen: create templates/documentation/backend/comments/edit.html in your site repository.

documentation/backend/comments/manage.html Copy Comments\Manage

Retrieve available records and assign them to the template for editing.

The admin template receives

Variable	Type	Description
$comments	Collection<Comment>	Collection of Comments

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

Customise this admin screen: create templates/documentation/backend/comments/manage.html in your site repository.

documentation/backend/global-comments/add.html Copy GlobalComments\Add

Add a new record. Assigns an empty record to the template.

The admin template receives

Variable	Type	Description
$globalComment	GlobalComment	Single (empty) GlobalComment record

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

Customise this admin screen: create templates/documentation/backend/global-comments/add.html in your site repository.

documentation/backend/global-comments/edit.html Copy GlobalComments\Edit

Retrieve a single record and display the edit page for the record

The admin template receives

Variable	Type	Description
$globalComment	GlobalComment	Retrieved GlobalComment record

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

Customise this admin screen: create templates/documentation/backend/global-comments/edit.html in your site repository.

documentation/backend/global-comments/manage.html Copy GlobalComments\Manage

Retrieve available records and assign them to the template for editing.

The admin template receives

Variable	Type	Description
$globalComments	Collection<GlobalComment>	Collection of GlobalComments

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

Customise this admin screen: create templates/documentation/backend/global-comments/manage.html in your site repository.

documentation/backend/global-pages/add.html Copy GlobalPages\Add

Add a new record. Assigns an empty record to the template.

The admin template receives

Variable	Type	Description
$globalPage	GlobalPage	Single (empty) GlobalPage record

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

Customise this admin screen: create templates/documentation/backend/global-pages/add.html in your site repository.

documentation/backend/global-pages/edit.html Copy GlobalPages\Edit

Retrieve a single record and display the edit page for the record

The admin template receives

Variable	Type	Description
$globalPage	GlobalPage	Retrieved GlobalPage record

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

Customise this admin screen: create templates/documentation/backend/global-pages/edit.html in your site repository.

documentation/backend/global-pages/manage.html Copy GlobalPages\Manage

Retrieve available records and assign them to the template for editing.

The admin template receives

Variable	Type	Description
$globalPages	Collection<GlobalPage>	Collection of GlobalPages

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

Customise this admin screen: create templates/documentation/backend/global-pages/manage.html in your site repository.

documentation/backend/pages/add.html Copy Pages\Add

Add a new record. Assigns an empty record to the template.

The admin template receives

Variable	Type	Description
$page	Page	Single (empty) Page record

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

Customise this admin screen: create templates/documentation/backend/pages/add.html in your site repository.

documentation/backend/pages/edit.html Copy Pages\Edit

Retrieve a single record and display the edit page for the record

The admin template receives

Variable	Type	Description
$page	Page	Retrieved Page record

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

Customise this admin screen: create templates/documentation/backend/pages/edit.html in your site repository.

documentation/backend/pages/manage.html Copy Pages\Manage

Retrieve available records and assign them to the template for editing.

The admin template receives

Variable	Type	Description
$pages	Collection<Page>	Collection of Pages

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

Customise this admin screen: create templates/documentation/backend/pages/manage.html in your site repository.