Skip to content
This repository has been archived by the owner on Nov 23, 2021. It is now read-only.

Migrate to version 1.2.0

Florian Pircher edited this page May 23, 2017 · 4 revisions

Version 1.2.0 of the Kirby Comments plugin introduces a cleaner, more coherent naming scheme for its options. Deleted and renamed options will continue to work for all versions of Kirby Comments 1.x.x.

The following table displays the old options and their default values to the left, the modification status* in the center and the new options and default values on the right. --> denotes the recommended option for replacing the job of a deleted option.

*A: added, D: deleted, R: renamed

'comments-page.title'    => 'Comments',                          | D | --> pages.comments.title
                                                                 | A | 'pages.comments.title'      => function ($page) { return 'Comments for “' . $page->title() . '”'; },
'comments-page.dirname'  => 'comments',                          | R | 'pages.comments.dirname'    => 'comments',
'comments-page.template' => 'comments',                          | R | 'pages.comments.template'   => 'comments',
'comment-page.dirname'   => 'comment',                           | R | 'pages.comment.dirname'     => 'comment',
'comment-page.template'  => 'comment',                           | R | 'pages.comment.template'    => 'comment',
'comments-snippet'       => 'comments',                          | D |
'form.submit'            => 'submit',                            |   | 'form.submit'               => 'submit',
'form.preview'           => 'preview',                           |   | 'form.preview'              => 'preview',
'form.name'              => 'name',                              |   | 'form.name'                 => 'name',
'form.email'             => 'email',                             |   | 'form.email'                => 'email',
'form.website'           => 'website',                           |   | 'form.website'              => 'website',
'form.message'           => 'message',                           |   | 'form.message'              => 'message',
'form.honeypot'          => 'subject',                           |   | 'form.honeypot'             => 'subject',
'form.session_id'        => 'session_id',                        |   | 'form.session_id'           => 'session_id',
'session.key'            => 'comments',                          |   | 'session.key'               => 'comments',
'require.email'          => false,                               | R | 'form.email.required'       => false,
'use.honeypot'           => true,                                | R | 'honeypot.enabled'          => true,
'use.email'              => false,                               | R | 'email.enabled'             => false,
'allowed_tags'           => '<p><br><a><em><strong><code><pre>', | R | 'form.message.allowed_tags' => '<p><br><a><em><strong><code><pre>',
'smartypants'            => true,                                | R | 'form.message.smartypants'  => true,
'max-character-count'    => 1000,                                | R | 'form.message.max-length'   => 1024,
'max-field-length'       => 64,                                  | D | --> form.{name, email, website}.max-length
                                                                 | A | 'form.name.max-length'      => 64,
                                                                 | A | 'form.email.max-length'     => 64,
                                                                 | A | 'form.website.max-length'   => 64,
'human-honeypot-value'   => '',                                  | R | 'honeypot.human-value'      => '',
'email.to'               => array(),                             |   | 'email.to'                  => array(),
'email.subject'          => 'New Comment on {{ page.title }}',   |   | 'email.subject'             => 'New Comment on {{ page.title }}',
'email.undefined-value'  => '(not specified)',                   |   | 'email.undefined-value'     => '(not specified)',
'setup.page.title_key'   => 'title'                              | D | --> setup.content-page.title
                                                                 | A | 'setup.content-page.title'  => function ($page) { return $page->title(); }
Clone this wiki locally