Cool comments ajax system

Contents

1. 0 - SUMMARY

2. 1 - INSTALLATION

3. 2 - UPDATE COOL COMMENT

4. 3 - ADMINISTRATION

5. 3.1 - Dashboard

6. 3.2 - Settings

7. 3.3 - Comments

8. 3.4 - Containers

9. 4 - Login Facebook

10. 5 - Create reCAPTCHA

11. 6 - PHPMailer

12. 7 - Language

1. 0 - SUMMARY

Please, read you this section carefully.  

In this section, you learn how to install and to use the application in your web.

  1. Here, you select the link "New"
  2. You will view a new window
  3. In this window, you write the name of container and press the insert button
  4. You copy of the section code
  5. Press the "Copy code" button
  6. Finally, you must paste the code on the web and  create a div with the id "coolCommentDiv" (<div id="coolCommentDiv"></div>) and place it where you want the plugin to appear

Remember: when you do a new installation the options of "Active Comments", "Facebook" and "Notifications" are disabled.

2. 1 - INSTALLATION

  1. Unzip folder
  2. Rename the admin-coolComment/assets/config/example_config.php file to config.php
  3. Open config.php and set your database configuration.
    Use the following code to connect the database in config.php
  4. $config = array(                    
        //type installation demo or production
        "installation" => "production",                       
        //data from the database
        //with this error Warning: mysqli_connect(): (HY000/2002): Can't connect to local MySQL server through socket '/var/lib/mysql/mysql.sock' (2)
        //test with host "127.0.0.1"   
        "db_host" => "localhost", 
        //here, you have to write your name of user of your database
        "db_username" => "coolComments",
        //here, you have to write the password of your database
        "db_password" => "********",
        //here, you have to write the name of your database
        "db_database" => "coolComments",    
        // server url and base path, usually you don't need to change this
        "base_url" => $urlBase,
        "base_path" => __DIR__,                
    );
    
  5. Upload the content to the directory you want
  6. Access the next url http://www.your-domain/directory path/admin-coolComment/you will view the page of installation.
    For example: http://www.myweb.com/coolComments/admin-coolComment/
  7. On this page you must insert an email and a password to perform the installation


  8. Finally, you have finished the installlation

3. 2 - UPDATE COOL COMMENT

If you have an old version of "Cool comments ajax system", you must follow the steps of the INSTALLATIONsection, the update will be done automatically.

The only configuration that will not be saved will be the data of the PHP Mailer, this data should be rewritten in the administration in the "Email" section

4. 3 - ADMINISTRATION

To access the Administration you must go to the path where you installed the plugin.

For example: http://www.your-domain/directory path/admin-coolComment/

In the administration, you have sections diferents:

  1. Dashboard
    This is the homepage, when you enter in the aplicattion, after you write your login and password, you see is page.
    In the page have three elements, there are Settings, Comments and Containers. In the setting, you configure the count of administrator, you have custom settings and you can design the options of comments. In the Comments you can to see the comments of user and you can to configure options of comments. In the containers. you can to create and to see containers.
  2. Settings
    - You can set a username for entry in your administration
    - You can set a new password
    - Receive alerts for each new comment
    - Activate antispam measures
    - Comment monitoring
    - Change language
    - Change the style of comment management
    - Activate Facebook login
    - Configure email
  3. Comments
    You can to see all comments, the comments approved. The comments pending and the comments spam. 
    You can delete the comments.   You can active the comments.
  4. Containers
    You can see the containers that you have created. Also, you have the option to create a new container for other website.
    1 - Here, you select the link "New"
    2 - You will view a new window
    3 - In this window, you write the name of container and press the insert button
    4 - You copy of the section code
    5 - Press the "Copy code" button
    6 - Finally, you must paste the code on the web where you want to show the comments

5. 3.1 - Dashboard

This is the homepage, when you enter in the aplicattion, after you write your login and password, you see is page.

In the page have three elements, there are Settings, Comments and Containers.

In the setting, you configure the count of administrator, you have custom settings and you can design the options of comments.

In the Comments you can to see the comments of user and you can to configure options of comments.

In the containers. you can to create and to see containers.

6. 3.2 - Settings

This section is divided into 5 tabs. In each of them you can modify the options of this plugin.

  1. General
    - Your email: The administrator's email, where all the plugin emails arrive
    - Password: The password to enter the administrator can be changed by pressing the "Change password" button
    Options
    - Alert email: Send email for new comment
    - Url user: Users can add their url
    - Response notification: Alert user for response
    - Active comments: Disable comments no approve
    - Show user image: Show the user's picture in the comments
    reCAPTCHA
    - Active reCAPTCHA
    - Key reCAPTCHA
    Create reCAPTCHA
  2. Language
    - Language: Choose the language of Cool Comment
    - Language datatables: Choose the language of DataTables
    - Timezone: Choose the time frame of the Cool Comment
    Bad words
    - Filter bad words: Disable filter bad words
    - Censored word: String to replace the word bad
    - Bad words: List of bad words
  3. Style: Change the styles of the administration and the comment page
    - Layout Cool Comment (admin): Choose between boxed or fluid
    - Theme Cool Comment (admin): Choose theme Cool Comment
    - Header Fixed
    - Footer Fixed
    Colors
    - Main button color
    - Color hover main button
    - Color line
    - Color background
    - Color background comment
    - Color background comment 1nd child
    - Color background comment 2nd child
    - Color text
    - Color text button
    - Color inside comment
    Colors mobile
    - Color background comment
    - Color background comment 1nd child
    - Color background comment 2nd child
    Image comment
    - Change icon
  4. Social login
    Gravatar
    - Active Gravatar
    What is gravatar
    Facebook 
    - Active facebook
    - Facebook App ID
    - Facebook Callback URL
    Create App Facebook
  5. Email
    - Send email with: Set the sender's email
    - Alias email: Set the name of the sender
    Email template
    - Image of the email header
    - Text footer email template
    Config PHPMailer: For more information about PHPMailer: https://github.com/PHPMailer/PHPMailer
    - Active PHPMailer: If it is disabled, will use the function mail() of PHP by default
    - Email template coding
    - Hostname of the mail server
    - Username to use for SMTP authentication
    - Password to use for SMTP authentication
    - Set the SMTP port number: Likely to be 25, 465 or 587
    - Set the encryption system to use: ssl (deprecated) or tls
    - Enable SMTP debugging
    - Whether to use SMTP authentication
    - Opportunistic TLS 


7. 3.3 - Comments

You can to see all comments, the comments approved. The comments pending and the comments spam. 

You can delete the comments.  

You can active the comments.

You can see the information of each comment, such as the date, if someone has answered this comment, the user.


8. 3.4 - Containers

You can see the containers that you have created. Also, you have the option to create a new container for other website.

1 - Here, you select the link "New"
2 - You will view a new window
3 - In this window, you write the name of container and press the insert button
4 - You copy of the section code
5 - Press the "Copy code" button
6 - Finally, you must paste the code on the web where you want to show the comments

9. 4 - Login Facebook

Follow the steps to create a Facebook APP: https://developers.facebook.com/quickstarts/?platform=web

Create an application with the name you want

Write the captcha

Choose session start with Facebook

Choose Web

Fill in the form data

Fill in these data, they are important

Configure the options as they come in the image, in the field of "URI of valid OAuth redirection", paste the value that you have in the Admin in the section Setting-> Social login "Facebook Callback URL"



10. 5 - Create reCAPTCHA

reCAPTCHA is a free service that protects your site from spam and abuse. It uses advanced risk analysis techniques to tell humans and bots apart. With the new API, a significant number of your valid human users will pass the reCAPTCHA challenge without having to solve a CAPTCHA. reCAPTCHA comes in the form of a widget that you can easily add to your blog, forum, registration form, etc

GET STARTED

We just have to follow the steps and paste our site key in the adminsitracion, in the "Key reCAPTCHA" field

11. 6 - PHPMailer

PHPMailer is a code library to send (transport) emails safely  and easily via PHP code from a web server (MUA to the MSA server).

Sending emails directly by PHP code requires a high-level familiarity to SMTP standard protocol (RFC 821, RFC 2821 and RFC 5321) and related issues (such as Carriage return) and vulnerabilities about Email injection for spamming. From 2001 PHPMailer is one of the popular  solutions for these matters on PHP.

You can see examples of use here

12. 7 - Language

Cool comment's plugin is written in English, though you are of course welcome to translate them to your language. To do the translation in your language you have to do it in two ways, with Poedit and with jquery-i18n

Using Poedit

Inside the Cool comment files you will find cool_comment.po and cool_comment.mo files in /assets/locale/en_GB/LC_MESSAGES. This .po file is basically a list of all the text strings used in the plugins files in English language, and .mo file is just the compiled export from .po file. Unfortunately, you need to translate the files manually, and then you need to save each file in the appropriate path, taking into account the language code

For example: 

/assets/locale/fr_FR/LC_MESSAGES/cool_comment.po 

/assets/locale/nl_NL/LC_MESSAGES/cool_comment.po 


You can find the right naming on this page.

So this is the full steps of translating the theme using Poedit:

  1. Get Poedit, you can get here http://poedit.net/
  2. We will create a new translation with poedit. Open poedit. File - > New front POT/PO file...
  3. When you are done translating all needed strings save each file in the appropriate path, taking into account the language code for example france: /assets/locale/fr_FR/LC_MESSAGES/cool_comment.po 
  4. Now in the administrator you must choose the language that you have created.

Using jquery-i18n

It is also possible to translate other texts that are not available from Poedit, to translate these text you just have to go to the folder of the file that you have created and copy the file "Messages.properties" of the language en_GB and open it with a text editor.