This guide describes the Comments add-on, walks you through add-on setup and integration, and serves as a reference document for the configuration and customization options.

Introduction

Gigya's Comments add-on enables site users to post comments and have discussions about published content on the site.

This guide describes the Comments add-on, walks you through add-on setup and integration, and serves as a reference document for the configuration and customization options.

Gigya now offers a new, improved version of the comments add-on, version 2, which differs from the original version in the following ways:

Using the new Comments add-on version 2 is simple; just add the version parameter to the params of the comments.showCommentsUI method, and set it to 2:

var params =  { 
    categoryID: 7623701,
    streamID: '',
    containerID: 'commentsDiv',
    version: 2
};

 

This guide also includes an explanation on how to make the comments in your Comments add-on searchable using  Search Engine Optimization (SEO) Support.

  • If you wish to use the add-on for R&R, please follow the designated guide.

How it Works

The add-on presents:

  1. A "Write a comment" canvas. The look of the canvas depends on whether the user is logged in.
  2. A "Comments" stream.

Layout When User is Logged Out

When a user clicks inside the "Write a comment" canvas, it expands and displays the "Post" button as well as a grayed-out sharing panel which contains check boxes for several social networks. If rich text formatting and/or media have been enabled, the appropriate buttons for these features are displayed on the top right corner of the text box (or top left, if the add-on is displayed in RTL mode):

 

If a user tries to post a comment when they are not logged in, the user is prompted to either log in or post a comment as a guest:

 

Note: By default, clicking "Post" prompts the user to log in and does not offer the "As Guest" option. You can configure the comments add-on to enable anonymous (guest) comments: see  Adding Guest Login.

 

A Login Bar can be displayed above the text box by setting the showLoginBar  parameter to true in comments.showCommentsUI. If guest login has been enabled, the Login Bar displays an extra button for logging in as a guest:

The Share panel under the text box allows the user to choose a social network to share the comment to. For a user who is not logged in, clicking one of the check boxes in the Share Panel opens a login popup, where the user can connect to the selected social network. Once the user is logged in to the network, the appropriate check box is checked, and subsequent comments posted will also be shared to the specified social network(s).

 

Layout When User is Logged In


 

In the logged-in state, the "Write a comment" canvas includes:

Major Features



Configuration and Administration

If you go back to the Comments Setup page, in the Comments category row that you have created, you will see a "Comments Settings" button. Clicking this button leads to the Comments Settings page. This page is an administration screen that lets you change the default settings of the Comments category.

 

You may change the settings as you choose and then save them by clicking the "Save changes" button at the bottom of the page. The changes are saved in Gigya's database (server side). No coding changes are required. The change will take effect immediately. For a page that is already loaded, refresh the page and you will see the change.

The available configuration options in this page are:

Changing to 'Read Only'

The 'Status' property is 'Enabled' by default, meaning that users are able to submit comments.
If you change the Status to 'Read only', users will only be able to read comments. Graphically, the 'Post a new comment' canvas is not displayed.

Moderation

Gigya's commenting service supports moderation administration. This section of the Comments Settings page includes moderation settings, including notification email, moderation mode, and more. Read more  in the  Comments Moderation dedicated  guide.


 

Blocked Words

 

The Gigya Console comes with a pre-defined list of blocked strings that will cause a comment to be rejected. This list can be edited to suit your specific needs by going to the Restrictions tab of the Comments section.

 

 

 

 

When a comment is rejected due to a blocked term, an email will be sent to the site's Moderators with the blocked word highlighted. It is important to note that the Restrictions algorithm will stop running after it encounters the first blocked term, so if there are additional words or phrases in your Restrictions list, only the first encountered blocked term will be highlighted.

 

You can also set blocked terms from inside the Moderator's Panel itself via the Settings tab.

 

 

 

When a comment is posted, Gigya will first check the Restrictions list defined in the Site Settings of the Gigya Console, then will check the Moderator Panel Restrictions.

 

Notifications

When Moderation is enabled, the moderator(s) will receive an email whenever a comment is posted. This includes Rejected and Flagged comments.

When comments reach the specified Flag threshold, they are moved into the Flagged que within the Moderator panel.

If you enabled Allow users to delete their comments, once a comment is deleted by the user, it ceases to exist within the Moderation panel.

Moderator Comments

In this section you can also choose how moderator commenter names and photos will appear in comment streams when they reply to comments. Read more  in the  Comments Moderation dedicated guide .

Adding and Changing Moderators

You can add to or modify the moderators for your site by clicking the Moderator tab in the Comments section of the left-hand navigation menu.


 

On the Moderator page you are able to add and remove moderators. There is also a link directly to the Moderators Panel.


Editing User Comments

Moderators may be authorized to edit existing user comments. To enable a moderator to edit user comments you need to perform the following:

Highlighted Comments 

Comment highlighting allows you to make certain comments or reviews in your site stand out from the rest using colors and icons.

There are three major uses of comment highlighting: 

  1. You may want replies made by comment moderators to be easily recognized. In that case, use Highlight Moderators.
  2. Similarly, you may want comments made by certain special users, such as site staff, to be easily recognized. In that case, use Highlight User Groups. You can use one or more of the pre-defined groups or define new ones.
  3. You may want moderators to select some comments manually for highlighting, e.g. to mark well-written comments as "Editor's pick". In that case, use Highlight Specific Comments.

To set up these different types of highlighting, see the appropriate sections below.

 

Notes:

  1. Only comments submitted by logged-in users can be highlighted.
  2. Highlighting and disabling of highlighting for groups of users only affect future comments posted by the users.

Highlight Moderators

Comments  posted by moderators can include a unique visual indication, as previewed in the Settings page:

The status is "On" by default, meaning that highlighting of moderator comments is enabled.

To edit the settings of the Moderators group, click the edit icon under the Settings column. This will open the Edit Group Properties dialog box.

In the Edit Group Properties dialog box, you can:

Any changes you make are shown to you in the "Preview" section.

The Comments add-on will display the moderator comments according to the settings you defined here:

In this case the text of the "Moderator" badge has been customized, and changed to "hello". The color of the "hello" badge and the color of moderator's name have not been changed.

If you chose to show the "Moderator" badge (either customized or not), the badge will be the first to appear (i.e. before any other badge such as Staff, Expert, Journalist, etc.).

Highlight User Groups

 If you set up highlighting for user groups, comments posted by users who belong to specified groups will include a unique visual indication, as previewed in the Settings page.

To assign users to groups, use the Comments Moderation Page.

 

Pre-Defined Custom User Groups:

Three user groups are pre-defined for you: Staff, Expert and Journalist. However, comment highlighting is not enabled for any of them by default. If you choose to use any of these groups, you need to change the Status of the group to "On" (as well as assign users to the group).

To delete a group, click the "X" icon under the Settings column of that group.

To edit the settings of a group, click the edit icon under the Settings column of that group. This will open the Edit Group Properties dialog box.

In the Edit Group Properties dialog box, you can:

Any changes you make are shown to you in the "Preview" section.

 

Adding a New Group:

To add a new custom user group, click the "Add New Group" button. This opens the Add New Group dialog box, where you can name the group, specify whether to show a badge, select a badge color and select a color to apply to the commenter's name. Click Create to add the group.

The Comments add-on will display the custom group comments according to the settings you defined here.

In this example, the user belongs to two groups - Journalist and Staff. Each has their own badge and color. Both badges are displayed.

If the user is highlighted, the highlighting badges are also shown in the post box.

Highlight Comments

 This option allows you to apply highlighting to specific comments that are selected manually by a moderator using the Comments Moderation Page. The visual indication that will be applied to these comments is previewed in the Settings page.

There is one pre-defined group for comments: "Editor's Pick". Its status is "Off" by default. Change the Status indicator to "On" to enable highlighting of comments that have been marked as "Editor's Pick" by a moderator.

 

In the Edit Group Properties dialog box, you can:

Any changes you make are shown to you in the "Preview" section.

 

To add new comment groups, click Add New Group. This will open the following dialog box:

User Login

This section controls the login UI, which is included in the "Write a Comment" canvas. If a user tries to post a comment when they are not logged in, a login prompt appears:

 

In addition, it is possible to display a Login bar in the add-on by setting the showLoginBar  parameter in comments.showCommentsUI :

 

Adding Guest Login

Adding guest login is simple: Check the "Allow guest comments" checkbox and click the "Save changes" button at the bottom of the page. Refresh your comments page and see the additional "Guest Login" in the login bar:

If you set the "Allow guest comments" radio button to "Yes", you will also see the "As Guest" option in the Login add-on :

 

You can also decide whether an email address is required for guest users, and if to request a required nickname from the guest:

If all three checkboxes are checked then when a user clicks the "Guest" button he is prompted to insert a nickname and an email address:

If an email is not required, or the guest nickname is not requested, the add-on will not display the relevant textbox. 

Adding Site Login

Adding site login is a bit more complex:

Set the useSiteLogin parameter of the comments .showCommentsUI method to true: 

var params =  { 
    categoryID: 7623701,
    streamID: '',
    version: 2,
    containerID: 'commentsDiv',
    useSiteLogin: true,
    cid:''
}

You will now see the site login button instead of the Gigya Login button. When you set the comment with useSiteLogin=true , clicking the Post button will be the same as clicking the Login button except the comment won't be automatically posted. 

If you want the comment automatically posted after the site Login event, add a callback function to the event object of onSiteLoginClicked.  This will be called when the user finishes logging-in. For example:

// onSiteLoginClicked event handler
function onSiteLoginClicked(event) {
    // set GAC from server side
   event.callback();
}

Clicking the site login button at the bottom of the page fires an onSiteLoginClicked event. To register to this event, set the onSiteLoginClicked parameter of the comments .showCommentsUI method with a reference to an event handler function. This function should open a popup or redirect the user for the site login page. The following sample code illustrates this:

// onSiteLoginHandler event handler
function onSiteLoginHandler(event) {

    // Site Login button clicked
    // open a popup or redirect the user for the site login page}

var params =  { 
    categoryID: 7623701,
    streamID: '',
    version: 2,
    containerID: 'commentsDiv',
    useSiteLogin: true,
    onSiteLoginClicked: onSiteLoginHandler,   // registering to the onSiteLoginClicked event
    cid:''
}

gigya.comments.showCommentsUI(params);  

Note that the popup or site login page should include Gigya's Login add-on.  

Note: If you have a site login implementation that redirects the user or refreshes the page after logging in, then logging the user into the site from the Comments add-on leads to the user losing the comment they have typed. We recommend combining the Comments add-on with an AJAX-based login process that does not require a redirect or page refresh.

Social Network Publishing

Layout Customization

This section allows you to change a few aspects of the Comments add-on layout settings:

 

Pagination

Pagination refers to dividing the comments into pages. The default is a display of 25 comments per page, but you may choose to change the number of comments per page using the drop-down menu.

Comment Box Location

The Comment box refers to the 'Post your review ' canvas. By default it is located above the  comments stream, at the top of the add-on. You may change this by checking the 'Bottom' radio button. As a result the canvas will appear below the comments stream, at the bottom of the add-on.

Show Newly Added Comments

This section allows you to specify whether the add-on should be refreshed in real-time and show newly added comments that were posted after the user has entered the page where the add-on is displayed.
T his drop-down menu allows you to select one of the following three options:

 

 

Note: No matter what setting is selected for the "Show Newly Added Comments", there is no impact on the page performance.

When the setting is "Automatically show new comments", you can pause the comments stream by clicking "Pause live stream":

Click the "Resume live stream" link to continue the comment stream.

Displaying Number of Comments

The checkbox allows you to display or hide the number of comments in the stream.

Displaying Subscribe Links

You can choose whether to display an RSS button and a Subscribe button. This allows users to subscribe to comments streams by email. Read more in the Subscribing to Comments section.

Other Settings

This section allows you to change the default settings of:

 

Comments Threading

By default comments threading is enabled, so commenters can reply to other comments, and the replies are displayed in a nested manner. If you prefer not to allow comments threading, select the 'No' radio button.

You may choose the depth of the threading, from 1 to 5, using the drop-down menu. The default threading depth is 5.

Replies Default View

You can decide whether the replies to the comments will be displayed in expanded or collapsed view.

Google Analytics Social Data Hub Integration

As of September 30th, 2016 Google Analytics has deprecated returning Google Social Data Hub data.

Maximum Comment Length

You may select the maximum length of the comments. If you do not set this value, the default maximum length of the comments is 5000 characters.

In-line Tagging of Commenters

You can allow commenters to tag other commenters from the comment stream. 

When this option is checked, you can easily enter the commenter you want tagged, either by:

 

Once you tag a commenter (or commenters), you may post the comment:

The tagged commenter will receive a notification email regarding the tagging if he selected "Follow replies to my comments". 

In mobile versions the tag in the comments is supported, though at this time tagging commenters is not yet supported.

 

Enable Links in Comments

If this checkbox is checked, URLs that have been entered as part of a comment are displayed as clickable links in the published comment. The links are configured with the "nofollow" option and open in a new window. For the purpose of this feature, URLs are strings that begin with "http://", "https://" or "www.".

For example, in a comment such as this one:

If you enable links in comments, your website users will be able to click "http://www.example.com" to open the link in a new window. If you disable links in comments, URLs will appear as regular text.

By default, this option is not enabled.

Allow Users to Edit their own Comments

Check the 'Allow users to edit their comments' checkbox to enable the editing feature.

Updated comments are treated as new comments in the following sense:

Edited comments are treated differently than new comments in the following sense:

When a category is defined as 'Read only', editing is disabled.

Allow Users to Delete their own Comments

When you check the checkbox, a "Delete" button appears, allowing a logged-in users to delete their own comments:

Enabling Voting on Comments

The "Enable voting on comments" checkbox determines whether to make voting on comments available for users. 

Like Button

In addition to the regular thumbs up button, a Like button appears:

Once the Like button is pressed, the thumbs up icon turns to green, and the "Like" turns to "Unlike". When the "Unlike" is pressed, the thumbs up icon changes back to gray, and the "Unlike" changes to "Like".

To disable this feature, set  streamSettings. allowNegativeVoting to "true", u sing  comments.setCategoryInfo. The outcome will be that the thumbs up and thums down will appear, and the Like button won't.

Sorting Comments

The comments can be displayed in different orders.

If the "Enabling voting on comments " checkbox is not checked, you may sort the comments according to one of the following orders:

If the "Enabling voting on comments" checkbox is checked, you have two additional sorting options:

You can also allow users to sort the comments in a different way than as it was preset by the site. The sort options are the displayed in a drop-down menu. Once a new sort is selected by the user, the comments are reloaded according to the new sort. 

Enable Rich Text Formatting

When you select this check box, the comments users are able to perform text formatting on all new comments. A formatting toolbar is displayed, and when a user clicks on any of the format buttons, the format of the selected text in the comment is changed accordingly.

Enable Embedding Media Items

The add-on enables you to embed media items of supported providers to your comments.

When you check the "Enable embedding media" checkbox, you will see the "attach" icon:

 

 

Note: In order attach a media item, the user must be logged in (they may be logged in as a guest user).

 

When clicking on the "attach" icon, the add-on will open an "add media item" dialog:

Enter the URL of the embedded media item you wish to add to the comment.

You can embed:

For example, the following image shows an embedded video item from Vimeo:

The supported vendors are:  Youtube, Vimeo, Flicker, CNN, Facebook, Pinterest, Twitter, SoundCloud, Instagram, Imgur, Twitter Pics, Tumblr, Spotify, rdio, last.fm, Pandora, SmugMug, PhotoBucket, Ustream, CollegeHumor, FunnyOrDieThe Onion, Dropbox and Brightcove.

Anonymous Posts 

The add-on enables you to allow logged-in users to post an anonymous comment or review.

When you check the "Allowed anonymous post by logged-in users" checkbox, the add-on displays a checkbox that when checked, it enables the user to post anonymously:

If non-logged-in users want to post anonymously, they can post as guests.

Notifications

This section allows you to register a callback URL which will be sent notifications when a new comment event is triggered or when a comment status change event is triggered. Comment statuses can be "published", "pending" or "rejected" (see the comment object).

Notifications are sent as an HTTP/HTTPS post. For details of their content, see Comment Notifications

Notifications can also be generated using the comments.setCategoryInfo API.

Site Restrictions

Gigya offers you the option to manage a custom black list of words and phrases to be filtered in comments, and to block IP addresses. You can read more in the Site Restrictions section, or go directly to the Site Restrictions on Gigya's site.

Commenting Rate Limit

Gigya supports rate limits on commenting in order to prevent spamming and abuse. This includes limiting the number of root comments and replies a user may post per stream in a day, and limiting the number of root comments and replies a user may post per site in a day.

Importing Commenting Systems

Gigya supports importing third-party commenting systems. If you wish to migrate to Gigya's commenting system, you can import your existing comments to Gigya and display them on your site. For this operation, please contact Gigya Support via the link in the top-right of your Gigya Dashboard

Comment Stream Subscriptions and Notifications

Notification of Comments Replies

By clicking the "Follow replies to my comments", logged-in users can choose to receive notifications when other users reply to their comments. After clicking, the user is notified by email whenever anyone replies to their comments (this feature is not available to anonymous commenters).
 

Subscribing to Comments

You can allow all your users whether they are logged-in or not to subscribe to a comments stream by email. First, make sure that in the  Comments Settings  page, the Display Subscribe Links radio button is set to Display. This causes the comments add-on to display the "Subscribe" and "RSS" links under the comment box:

When a user clicks the RSS button in a supporting browser, an RSS reader opens , showing the RSS feed for this comments stream. If their browser does not support RSS, clicking the link opens the XML file.

When a user clicks the Subscribe button, the following dialog box opens:

If the user is logged in, their email address is pre-filled in the dialog box, and they can change it if they wish.

Otherwise, the user has to enter a valid email address.

After the user clicks "Subscribe", the Gigya system begins sending them email notifications about updates to the current stream. Notifications are not immediate: Gigya checks for updates in the comment stream every few hours, and sends the user an email saying that comments have been added to the stream to which they have subscribed.

Once an email address has been entered, the Subscribe button changes to Unsubscribe so that the user can choose to stop receiving notifications. The user can also use the "Unsubscribe" link included in the update email for the same purpose.

Note:

  1. Notification emails are not sent for comments which the subscriber has already viewed by visiting the comments page. Gigya only sends notifications for newly posted comments which the subscribed user has not seen.
  2. Only one batch notification email is sent at a time, regardless of how many new comments have been posted.

Comment Email Templates

Users who subscribe to comment streams receive a Stream Subscription Email notifying them that they have subscribed to the stream and a Comments Reply Email notifying them when someone replies to their comment.
The default form of these emails exists in all supported languages. The language of the comment stream determines which language will be used in the email. Comment email subscriptions and the languages they use can be set in comments.subscribe and comments.setUserOptions.

The default content of the notification emails can be customized by site administrators using the Comments Email Templates (Settings >> Comments >> Email Templates in the Gigya Console).
When customized templates are created, they are for a specific Comment Category and language. 

Default Stream Subscription Email

Default Comment Reply Email

Content of Email Templates

Customized email templates define email content (from, subject and body) for a specific language and comment category. The email template is an HTML template that supports placeholders and META tags.

  1. META tags define the header of the email.
  2. Placeholders are variables that Gigya replaces in the email body (text) with actual values when the email is sent. All email templates must contain an %unsubscribeLink% placeholder. 
     

Note: Email templates cannot be saved without an unsubscribe link (%unsubscribeLink%).

 

The supported META tags:

The supported placeholders for Stream Subscription Emails:

The supported placeholders for Comments Reply Emails:

 

Creating Customized Emails

The Email Templates page has two tabs, one for the Stream Subscription Email and one for the Comments Reply Email

 

 

  1. Select either the Comments Reply Email tab or the Stream Subscription Email tab.
  2. Enter a comments category at the top of the page.
  3. Click the "Add Template" button.
  4. Select the language.
  5. Edit the content of the template
  6. When you finish click the "Save Settings" button. 

UI Customizations

We provide several levels of customization for the Comments add-on UI:

You are welcome to consult Gigya's support team to guide you through advanced UI customizations. You can contact us by filling in a support form on our site. You can also access the support page by clicking "Support" on the upper menu of Gigya's site.

Template Classes

The  templates  parameter in comments.showCommentsUI defines a series of classes each of which represents a single user interface element in the Comments add-on. Each template is a layout definition for a group of related graphics elements in the Comments add-on and each template is sub-divided into a series of classes each of which represents an individual graphical element within that template.

Use this parameter to override the default design of the Comments add-on, to change the location of elements, prevent them from being displayed and to apply CSS to them.  The templates are: 

Comments Plugin (commentsPlugin)

Can be used to set the order in which each of the following template elements appear and whether it appears at all. Most of the commentsPlugin classes refers to one of the other templates; for example gig-comments-comments controls the comment template.

Header (header)

Can be used to set the order in which each class appears, whether it is displayed and to apply CSS styling.

Updates (updates)

Can be used to control the order in which each class appears, whether it is displayed and to apply CSS styling.

Comment (comment)

Can be used to control the order in which each class appears, whether it is displayed and to apply CSS styling.

Compose Box (composebox)

Can be used to control the order in which each class appears, whether it is displayed and to apply CSS styling.

My Review (myReview)

Can be used to control the order in which each class appears, whether it is displayed and to apply CSS styling.

Running Example

In the following example the Comments add-on is presented, with graphic elements laid out differently than the default.  The "Show more comments" link has been moved to the top and the header placed above the compose box.  Some of the classes in the header are not displayed.

 

<iframe src="https://s3.amazonaws.com/wikifiles.gigya.com/Socialize/CommentsUI_Example_Templates2.htm" style="width:850px; height:660px;"></iframe>

 

Example Code

<html>
<head>
<script src="http://cdn.gigya.com/js/gigya.js?apiKey=2_Y82PzwJ_chSFImHXaIDJClnLyJzmk-VFOavSsaNTzl6m901s_NNxRAS0xJ3bd3_N" 
	type="text/javascript"></script>

</head>
<body>
<div id="commentsDiv"></div>
<script type="text/javascript">
    // Optional - define templates to changes structures in the Comments add-on
    var templates = {
        commentsPlugin: '<span style="color:blue;">This is the more option(usually appears at the bottom):</span><span class=gig-comments-more></span><br><br><br>' +
                        '<span style="color:blue;">This is the header: </span><span class=gig-comments-header style="float:right"></span><br><br><br>' +
                        '<span style="color:blue;">This is the compose box:</span><span class=gig-comments-composebox> </span><br>' +
                        '<span style="color:blue;">This is the list of comments:</span><span class=gig-comments-comments> </span>', 
 
         header:        '<span style="color:red;">header count:</span> <span class=gig-comments-count></span><br><br>' +
                        '<span style="color:red;">header subscribe:</span><span class=gig-comments-subscribe> </span><br>',

        comment: '<span style="color:green;">This is the username:</span> <span class=gig-comment-username style="color:blue;"></span><br>' +
                 '<br><br><span style="color:green;">This is the Photo: </span><span class=gig-comment-photo style="float:right;"></span><br>' +
                 '<span style="color:green;">This is the Date String:</span> <span class=gig-comment-time style="color:blue;"></span><br>' +
                 '<span style="color:green;">This is the Comment Body:</span> <span class=gig-comment-body style="color:blue;"></span><br>' +
	 	         '<span style="color:green;">This is the Replies Count:</span> <span class=gig-comment-count style="color:blue;"></span><br>' +
                 '<span style="color:green;">This is the Reply Button: </span><span class=gig-comment-replyLink style="color:blue;"></span><br><br>' +
                 '<span style="color:green;">This is the Flagging option:</span> <span class=gig-comment-flag style="color:blue;"></span><br>' +
                 '<span style="color:green;">This is the comment vote total:</span> <span class="gig-comment-vote-total"></span><br>' +
                 '<span style="color:green;">This is the Voting option:</span> <span class=gig-comment-vote-pos style="color:blue;"></span>' +
                 '<span class=gig-comment-vote-neg style="color:blue;"></span><br>' +
                 '<span style="color:green;">This is the comment reply box:</span> <span class=gig-comment-replybox ></span><br>'
    };
    var params =
    {
        // Required parameters:
        categoryID: 7623701,
        containerID: 'commentsDiv',
		streamID: 'foo6', 
		version: 2,
        // Optional parameters:
        templates: templates,
        cid: ''
    };
    // Load the Comments add-on
    gigya.comments.showCommentsUI(params);
</script>
</body>
</html>

HTML Elements Style (CSS)

Any elements on the add-on that has an ID can be overridden with supported style attributes. There are dozens of elements on the add-on. identify the HTML elements on the add-on using developer tools, and assign a new style to it. Please make sure to use the add-on's container <div> ID when assigning style, so it will not affect other elements on the page.

For example:

 

<style> #commentsDiv .gig-button-post-text {color:Yellow;background-color:black} </style>

Sharing Comments to Social Networks

Users can share their comments to social networks by clicking the "Share" link under the comment to be shared:

Once the "Share" link is clicked, a mini Share add-on will pop up to suggest to the user to share his comment to the social networks. The user is given an option to choose to which social network he wants to post the content. When the user presses the social network's button, Gigya will publish the user's reaction to the selected social network.

In order for this share to work, follow these two easy steps: 

Step 1: Construct a UserAction Object 

The UserAction object represents a user action. We use the UserAction object constructor for this purpose:

var shareUserAction = new gigya.socialize.UserAction();  

 

By default, the shareUserAction object fields are mapped as follows: 

After you have constructed the object, you can use the various UserAction member methods to set the rest of the object's properties, or change existing ones. For example:

shareUserAction.setSubtitle("This is my sub title");
...

 

The UserAction's object properties represent the various items of which a User Action may consist: Title, etc.

Step 2: Include the shareUserAction in the Comments add-on parameters

var params =  {
    categoryID: 7623701,
    streamID: '',
    containerID: 'commentsDiv',
    version:2, 
    userAction: shareUserAction  }; // The UserAction object from Step 1

Comments UI in Mobile View

When the comments .showCommentsUI deviceType parameter is set to mobile, the comments UI is displayed in the mobile mode. Also if deviceType is set to auto and you open the page on mobile, it will also display the mobile layout:

 

In this mobile mode some of the Comments UI functionality is not supported:

When an embedded media item is in the comments stream, clicking on the HTML media item will redirect the browser to the URL.

Comments Counter in Share Bar

Gigya's Share Bar add-on is built out of one or more buttons, arranged horizontally in a bar. You can add a Comments button to your Share Bar, with a counter indicating the number of comments made in that specific comments stream. The comments stream is identified by its unique categoryID and streamID. To learn how to embed a Share Bar with Comments button, read the Adding a Comments Counter section of the Share Bar add-on.

Browsers Compatibility

Comments version 2 is supported from the following browser versions:

For older browsers the system will automatically fall back to comments version 1.

Mobile Compatibility

Comments version 2 is supported from the following OS versions:

Comments version 2 is supported from the following browser versions:

For older browsers the system will automatically fall back to comments version 1.

Right-to-Left Localization

Gigya provides right-to-left language support for the Comments add-onThe add-on will be displayed according to the locale:

 

Responsive Design

The Comments add-on is designed to respond fluidly as the size of the browser window is changed. The mode can be set to Mobile or autoDetect where applicable. Read more in the Mobile View section.

Support for Custom Texts

The Comments add-on has a long list of keys that represent texts in the add-on, for example, "thank_you_for_subscribing" represents the text "thank you for subscribing". 

You can override these existing texts, and use your own custom texts in the comments add-on. This is done with the customLang  parameter in comments.showCommentsUI, by setting pairs that include the key that represents a text element in the UI, with the text to which you want to change:

customLang = {textKey1text1,textKey2text2,[...]}.

For example:

 

params.customLang = {
            num_comments: '%num talkbacks',
            write_a_comment: 'Write a talkback'
        };

For the full list of existing keys, see our customLang documentation.

Search Engine Optimization (SEO) Support

This section provides instructions on how to make the comments in your Comments add-on searchable by the main search engines, and by that adding SEO value to users. As you know search engines index only static data in your site. It is difficult to make them index dynamic data. This includes the comments data. The comments data is kept on Gigya's server and is requested dynamically. The search engines do not see and do not index the comments data. To solve this issue Gigya provides a static HTML format of the comments with an up-to-date content that is readable by search engines and can be indexed.

To take advantage of this, please follow the steps below:

  1. Detect the Search Engine Crawlers: Find out whether the page is viewed by a search engine spider (bot). Identify the search engine using the HTTP_USER_AGENT field. You may find a PHP example here. Customers using this code should note that customizing pages for search bots can be a violation of search engine guidelines; for more information see https://support.google.com/webmasters/answer/66355.
  2. Inject HTML Comments data: If a search engine is identified, fetch the raw comments HTML by setting the dataFormat parameter of comments.getComments to'html':
  3. Print this HTML inside of the comments DIV container. 


Additional Information