Wp commentator doc 1 6

Commentator !

General informations and documentation.

Commentator Wordpress Plugin

A general information document to help you use and customize the plugin.

! ! !

This document covers a full description of the basic informations.

If you have any further questions, you can contact me via my Codecanyon profile page.

!

by Yukulelix

1

Commentator !

General informations and documentation.

Installation

3

With your FTP client

3

From your Wodpress dashboard

3

Getting Started

3

Open the settings panel

3

Change an icon

3

Change a color

3

Max Threaded comment count

4

Pagination

4

Save my settings

4

Social Auth

5

Google

5

Facebook

5

Twitter

6

Linkedin

6

UserPro Integration

6

Features request and further help

6

by Yukulelix

2

Commentator !

General informations and documentation.

1. Installation

!

1.1. With your FTP client

Find the WordPress Plugin folder within the downloaded archive.

Extract the Plugin folder to your desktop.

With your FTP program, upload the Plugin folder to the wp-content/plugins folder in your WordPress directory online.

Go to Plugins screen and find the newly uploaded Plugin in the list.

!

1.2. From your Wodpress dashboard

Go to your Wordpress Admin Panel, and click on Plugin » Add New. Then click on the Upload Tab. Browse the file and upload it (zip files only).

Go to Plugins screen and find the newly uploaded Plugin in the list.

!

2. Getting Started

Click Activate Plugin to activate it.

Once installed and activated, your wordpress comment sections should already be replaced by the basic commentator ones.

To customize them, please follow this paragraph instructions.

!

2.1. Open the settings panel

Your Wordpress Admin should have a new « Commentator » tab inside the built-in comments tab.

From their, you can open the settings panel !

! !

2.2. Change an icon

To change an icon, we provided to you an super simple modal icon chooser.

Click on the icon to modify ▹ the modal should open.

Click on the icon you wish to use instead in the modal

▹ the modal should close and the new icon should appear

!!

2.3. Change a color

by Yukulelix

3

Commentator !

General informations and documentation.

To change a color, we provided a simple jQuery color picker, to do so : Click on the color to modify ▹ the little color picker should appear.

Choose your color with the color picker

▹ the little box color should change to the new chosen color

!

2.4. Max Threaded comment count

You can simply change the maximum possible threaded comments with the first text input. Enter simply a number from 1 to whatever you want :) !

!

2.5. Pagination

V1.3 added comments pagination support to commentator. We decided to support the native wordpress pagination. The options are located in Settings > Discussions :

!

2.6. Save my settings

Don’t forget to save your settings with the « save changes » button !

!

Click on reset to defaults to reset your settings to commentator default ones !

! !

Then click on credentials on the left menu.

by Yukulelix

Create a new client id for your app

Edit your settings

4

Commentator !

General informations and documentation.

3. Social Auth 3.1. Google To get your google api keys, you need to go at : https://code.google.com/apis/console/ #access

! ! ! ! ! ! ! ! ! ! !

In Authorized redirect url, you must add your website url + wp-content/plugins/commentator/hybridauth/? hauth.done=Google For my demo, I added http://yukulelix.com/commentator/wp-content/plugins/ commentator/hybridauth/?hauth.done=Google Go to Consent screen on the left menu and add a name to your app.

Now just copy your Client ID and Client Secret in Commentator Settings !

!

3.2. Facebook

To use facebook, you need a developer account.

Go there : https://developers.facebook.com/apps to create it.

!

Create your first app ! ! !

Fill the form and add at the end : with your base URL I added http://yukulelix.com/commentator/ for my demo

!

You can now add your app id and app secret in commentator settings

by Yukulelix

5

Commentator ! !

General informations and documentation.

3.3. Twitter

To use twitter, go to : https://dev.twitter.com/apps.

! !

Create a new app : ! !

In the settings tab, fill website and callback url with your website base, I used http:// yukulelix.com/ for my demo.

!

Check the box : « Allow this application to be used to Sign in with Twitter » !

In the oath tool tab, copy your Client ID and Client Secret in Commentator Settings ! !

3.4. Linkedin

To use twitter, go to : https://www.linkedin.com/secure/developer

!

Create a new app. ! fill website url with your website base, I used http://yukulelix.com/ for my demo. !

Copy your ID Key and Secret Key in Commentator Settings ! !

4. UserPro Integration

Little guide to get started fast :

!

• In Commentator settings, in the social tab, deactivate social signin.

• Put this code in « Section of content before the commenting section » in the general tab : [userpro template=register]

!

You’re good to go :) ! ! !

5. Features request and further help

If you need anything that’s not provided by this documentation or if you have any features request, please contact me at support@yukulelix.com !

by Yukulelix

6

Commentator !

General informations and documentation.

Cheers !

by Yukulelix

7