C5Magic_header_logo.png c5Magic

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.

jl_editor_comment_screenshot_0_1421593832.png

Comment colour scheme

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

  • jl_editor_comment.format.text_color (default: #101010)
  • jl_editor_comment.format.background_color (default: #fff79d)

Colours can be in any CSS acceptable format.

Date / time format

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

  • jl_editor_comment.format.date (default: Y-m-d H:i:s)

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 jl_editor_comment.format.date is also passed through the t() translation method for sites using locale based date/time formats.

Comment visibility

Comments can be shown in-page and outside of edit mode by setting the configuration value 

  • jl_editor_comment.view.group (default: false)

When set to true, comments will be shown to all. When set to a group gID, comments will be shown to users in that group. For example, the Administrators group is usually gID 3.

Comment markers /* */

The opening and closing markers are set to look like code comments /* and */. If you don't like these, you can set the configuration values

  • jl_editor_comment.format.opening_marker (default: /*)
  • jl_editor_comment.format.closing_marker (default: */)

If you don't want a marker to be used, set the configuration value to false.

Default configuration

When not explicitly set, these configuration values default to:

[code]

[
    'view' => [
        'group' => false,
    ],
    'format'=>[
        'text_color'=> '#101010',
        'background_color' => '#fff79d',
        'date' => 'Y-m-d H:i:s',
        'opening_marker'=> '/*',
        'closing_marker'=> '*/',
    ]
];

[/code]

Additional Pages