Documentation

  1. Settings
    1. Chat
    2. Support
    3. Spam
  2. Support-User
    1. Add User
    2. Chat
    3. Language
  3. Answers
    1. Keyword-based
    2. Types
    3. Existing
  4. Questions
    1. Page-related
    2. Parent
    3. Fallbacks
  5. More
    1. User
    2. Shortcode
    3. Theme
  6. Code
    1. Translation
    2. Frontend
    3. Backend
Thanks for using weebot! We assembeld some information for you and hopefully this helps you with your questions.

Settings

You will find the Settings in your Wordpress-Backend: "Settings" -> "weebot"

Chat

Option Information
Theme This is the Frontend-Style of the Support-Chat.
Seconds After this amound of seconds the chat will be visible in the frontend.
Chat width The width of the Support-Chat as a CSS-Value.
Active This will activate the Support-Chat.
Footer Adds the Support-Chat to the Page. (Disable this, if you want to add the Support-Chat just to some sites).
Welcome Message Define an individual welcome message for users with an empty chat log.
Chat-Log Messages This amount of messages will be loaded into the chat-log on initial load.
Page parameter Remove URL-parameters for page-related answers.
Page hashtag Remove URL-hashtag for page-related answers.
Fallback Search Do a search as fallback, if no supporter is online and no answer was found.
Fallback Email If the visitor wants to, he can get the answer via email.
Only logged users Show Chat only to logged in visitors.
Crossdomain Allows the Access to the Support-Chat from different Domains (eg for landing Pages). To add the Support-Chat to another Domain just copy the Stylesheet-Path and the Script-Path to the Website (jQuery required).
Crossdomain Allows the Access to the Support-Chat from different Domains (eg for landing Pages). To add the Support-Chat to another Domain just copy the Stylesheet-Path and the Script-Path to the Website (jQuery required).
Allow Screenshots Allows the user to send screenshots.
Allow File Uploads Allows the user to upload and send files.

Support

Option Information
Support-User Add available (online) Support-User to chat.
Hide Hide Chat for Support-User in frontend.
Popup Show new Support-Messages in frontend.
Show Supporter Shows Supporter if user has an empty chat log.

User

Option Information
Online Track online users.

Spam

Option Information
Active Activate Spam Check.
Text Length Minimum Chars for a text.
Words Activate Word Check.
Included Words One of these words should be in the text (comma separated).
Excluded Words All of these words should not be in the text (comma separated).
Excluded Strings All of these strings should not be in the text (comma separated).

Support-User

Support-User have to be registered Wordpress-User. There is no Support-User set by default!

Add User

You can add Support-User by navigating to the "Users"-Page in your Wordpress-Backend.

Here you can look for the User, which should become a Support-User. You will see a new Column named "weebot" in the "Users"-Page.

If you change the Value in the "weebot"-Column on the "Users"-Page to "Yes", the User will become a Support-User.

If you change the Value back to "No", the User will be removed as a Support User.

Chat

By default, the Support-Chat for incoming Messages will be active in the Frontend and Backend.

You can disable the Chat for the Frontend and/or Backend by changing the Settings of "weebot".

If the Chat is disabled Support-Users can still respond to messages by navigating to the "Questions"-Page of the "weebot"-Plugin and clicking on "Create Answer" for the specific Question.

Language

If you use "weebot" for multiple Languages in the Frontend then you should set up a Support-User for each language by changing their Backend-Language.

The Backend just shows messages for the chosen Language.

We recommend this Plugin for changing the Language for specific Backend-Users: Admin Language per user

Answers

You can create multiple Types of Answers and predefine Answers for Keywords!

Keyword-based

You can create Answers, which are based on Keywords. This means, if a defined amount of Keywords are found in the Message then the Keyword-based Answer will be responded.

Option Information
Keywords The words, which should be in the question (space separated)
Minimum hit-count Minimum hit-count of keywords that match with words of the question.
Minimum words Minimum amount of words, which should be included in the question.
Maximum words Maximum amount of words, which should be included in the question.
Type The type of the response.
Action The answer, question or filename.
Page If the page you want to choose is not available, visit it once on the frontend, so it will be indexed.

Types

There are multiple Types of Responses/Answers.

Gossip This Type of Answer will not be remebered by "weebot". So if the same Question, which was responded with Gossip, will be send again, you have to create a new Answer.
Answer This Type is perfect for a simple Answer. An Answer will be remembered by "weebot".
Question If you need more Information to a previous message, than respond with Question. The Following User-Message in this Chat will have a Parent-Question. A Question will be remembered by "weebot".
URL If you want to Respond with a Weblink then you could use URL. URL as Respond will be remembered by "weebot"
File If you want to create a server-side generated Answer than you can choose a File. The File should be located in "weebot" "/public/template/chat/answer/file" saved as a ".phtml"-File. You have access to global Wordpress-Functions and to all Functions of "weebot-Public" and the Question and User is transfered to your File via the Variable "$parameter"

Existing

To avoid that you have to create the same Answer multiple times for "different" Messages, which would respond to the same Answer, you can just pick an existing Answer.

Questions

Questions (Messages) are generated by your Customers and will be automatically answered by "weebot" if there is already an Answer for this Question or if a Keyword-based Answer will match.

Page-related

There is the option for each Question that it is page-related. So you can provide different Answers for the same Question on different Pages. By default a Question is not page-related.

Parents

If you choose the Type "Question" as your Response/Answer, the next User-Question in this Chat will be related to a "Parent". So you can provide multiple Answers to the same Question on different Question-"Parents".

Fallbacks

If there is no supporter online and no Answer exists to the Question, then there will be a Search-Fallback and Email-Fallback for the Question. The Email-Fallback allows the User to get the Answer emailed.

More

Some information about the User-Page of "weebot"-Plugin and how to use Shortcodes!

User

The User-Page lists all Users of the "weebot"-Plugin. You can delete Users here and view the Chat-log of Users.

Shortcode

If you dont want to enable the Chat on all Pages in your Frontend then you can activate "weebot" just for chosen Pages by adding the following Shortcode:

Theme

The Theme of the Support-Chats (Frontend) can be changed in the Options-Page of "weebot".

New Themes can be added in the Plugin-Directory "/public/template".

For the Themes you can add parameter in the info.yml-File, like a parent-Theme (example Theme "dark")

Code

The Plugin-Files are documented in the Source-Code!

Translation

By default you have an english- and german-Translation-File. You can simply add new languages by creating a new language-File in the "language"-Directory of "weebot". We recommend to create new (or edit existing) Languages with the following Plugin: Loco Translate

Frontend

All Frontend-related Files can be found in the "public"-Directory of "weebot". You will find more documentation in the Source-Code of each file.

Backend

All Backend-related Files can be found in the "admin"-Directory of "weebot". You will find more documentation in the Source-Code of each file.