Documentation

Simply add the Editor Comment block where you want to leave comments.

It takes any plain text you enter and only shows it again during edit mode. When the edit is saved and the page is shown normally, nothing is shown.

Edit the page again, and you can read the comment.

For those who want to customise the comment style, two configuration values can optionally be set in application/config/app.php to define colors.

  • app.editor_comment.text_color
  • app.editor_comment.background_color

Colors can be in any CSS acceptable format.

 A further configuration value can be used to define a custom date/time format:

  • app.editor_comment.date_format

This constant accepts any php date/time format string and, when defined, will be used to format the date/timestamp shown with comments. The date/time format string defined in app.editor_comment.date_format is also passed through the t() translation method for sites using locale based date/time formats.

Comments can be shown in-page by setting the configuration value 

  • app.editor_comment.developer_view

When not explicitly set, these configuration values default to:

editor_comment => array (
	developer_view => false,
	text_color => '#101010',
	background_color => '#fff79d',
	date_format => 'Y-m-d H:i:s'
)