Skip to content

Latest commit

 

History

History
190 lines (149 loc) · 7.39 KB

02-configuration.md

File metadata and controls

190 lines (149 loc) · 7.39 KB
Raw

EzSystemsCommentsBundle configuration

General consideration

EzSystemsCommentsBundle provides a semantic configuration (to be included in your ezpublish.yml or config.yml.

It is siteaccess aware, meaning that you can have several types of configuration depending on your siteaccess.

By default the no_comments provider is used, meaning that no comments will be displayed by default. This lets you write versatile templates.

Configuration overview

ez_comments:
    system:
        siteaccess_name:
            # Comments provider you want to use by default (e.g. "disqus").
            default_provider: provider_name

            # Rules for comments on Content objects. If none provided, commenting will be allowed for any type of content.
            content_comments:
                my_comment_ruleset:
                    # Indicates if comments are enabled or not. Default is true
                    enabled:              true
                    # Provider to use. Default is configured default_provider
                    provider:             ~
                    # Provider specific options. See available options for your provider.
                    options:              []
                    # Condition matchers configuration. You can use the same matchers as for selecting content view templates.
                    match:
                        # Example:
                        Identifier\ContentType:
                            - article
                            - blog_post

            provider_name:
                # Here comes provider's configuration

siteaccess_name can also be the name of a siteaccess group, "default" or "global"

Note that you can see dump configuration reference using the following command:

$ php ezpublish/console config:dump-reference ez_comments

Default settings can be found in Resources/config/default_settings.yml

Provider configuration

Disqus

Disqus is a very powerful cloud-based commenting system.

The first thing you need to do is to register your website to Disqus. You'll pick a shortname up, which is your website's identifier on Disqus (see more on Disqus documentation)

Configuration reference

ez_comments:
    system:
        siteaccess_name:
            disqus:
                # Disqus "shortname"
                shortname: my_disqus_shortname # Required

                # Template to use, overriding the built-in one.
                # Default template is "EzSystemsCommentsBundle::disqus.html.twig"
                template:             ~
                
                # Load JS code to render comment count
                count: true|false

Available options

  • shortname
  • identifier
  • title
  • url (must be absolute, defaults to window.location)
  • categoryId
  • template

Add comment count

This bundle supports additional Disqus comments counter which is loaded in separate JavaScript file. This counter is disabled by default and if you want to enable it, you have to follow these steps :

  • activate the count configuration
  • add an element with "disqus-comment-count" class as it is detailled in the disqus documentation.

Facebook

Facebook provider is an integration of Facebook Comments

You first need to register an application on Facebook. Once registered, you can get your AppId that will be used for configuration.

Configuration reference

Note that settings below are default values for your siteaccess. You can override them from the comments renderer an the template helper.

ez_comments:
    system:
        siteaccess_name:
            facebook:
                # Facebook application ID
                app_id:               ~ # Required

                # Width for the comments box (default is 470)
                width:                ~

                # Number of comments to display (default is 10)
                num_posts:            ~

                # Color scheme to use (can be "light" or "dark". Default is "light"
                color_scheme:         ~

                # Whether to include Facebook JS SDK with the comments rendering. If set to false, you must include it on your own. Default is true.
                include_sdk:          ~

                # Template to use, overriding the built-in one.
                # Default template is "EzSystemsCommentsBundle::facebook.html.twig"
                template:             ~

Available options

  • url (must be absolute). Defaults to current main location URL when using Content, current URL otherwise.
  • width
  • num_posts
  • color_scheme
  • include_sdk
  • template

Matcher based configuration for Content objects

By default, comments are open for any type of content, but you can define configuration rules under content_comments key to enable/disable comments, select a specific provider or even override the provider options!

You can do this by defining configuration blocks based on matchers. EzSystemsCommentsBundle uses the same matchers as for template selection rules in eZ Publish kernel.

Note: If you explicitly pass options to the comments renderer while options are set in a configuration block, explicit options will always have precedence.

Example

ez_comments:
    system:
        my_siteaccess:
            default_provider: disqus

            # Rules for comments on Content objects. If none provided, commenting will be allowed for any type of content.
            # The first matched rule always have precedence, so be sure to set IDs first
            content_comments:
                # Disable comments for specific content
                disabled_articles:
                    enabled:              false
                    match:
                        Id\Content: [123, 789]
                # Use facebook providers for articles and blog posts in "social_media" section
                social_articles:
                    enabled:             true
                    provider:            facebook
                    # Override default provider options.
                    options:
                        color_scheme: light
                        num_posts: 20
                    match:
                        Identifier\ContentType:
                            - article
                            - blog_post
                        Identifier\Section:  social_media

                # Private articles use the default provider
                private_articles:
                    enabled:             true
                    match:
                        Identifier\ContentType:
                            - article
                            - blog_post
                        Identifier\Section:  private