1. This site uses cookies. By continuing to use this site, you are agreeing to our use of cookies. Learn More.

[wmtech] Realtime Chat Conversations - Manual, Instructions & Installation / Upgrade Guide

Discussion in '[WMTech] Realtime Chat Conversations' started by wmtech, Feb 13, 2015.

Share This Page

Thread Status:
Not open for further replies.
  1. wmtech

    wmtech WMTech Staff XF Licensee

    Messages:
    175
    Likes Received:
    15
    Welcome to WMTech Quality Add-Ons!
    We care about our products!


    AUTOMATIC INSTALLATION INSTRUCTIONS:

    We recommend the use of an automated installation and upgrade system.
    Two of them are available for free to download at xenforo.com:
    Please try one of them!

    ** Note: If you use the product created by Waindigo, please enter the following line to your XenForo configuration file (/library/config.php ) to prevent any callbacks to Waindigo this add-on otherwise starts itself regularly:

    Code:
    $config['disableCallbacks'] = true


    MANUAL INSTALLATION INSTRUCTIONS:
    1. Download the add-on from our products section after licensing it for your forum(s). Please note, that we are enforcing our license. Please do not download, if you don't agree to it!
    2. Upload everything from the "upload" directory in our software package into your web servers forum directory.
    3. Install "addon-wmt_LiveChatConversations-1xx.xml" in your Xenforo ACP (ACP > Home > Install Add-On).
    4. Access "ACP > Home > Options > [WMTech] Realtime Chat Conversations" to check and setup the options of this add-on.
    5. Access "ACP > Users > User Group Permissions". Select the user group you wish to assign to use this add-ons features. There is one permission that needs to be set and it is located in the section named 'Personal Conversations Permissions':
      • [WMTech] RCC - Use Realtime Chat
        Set this to "Allow" to enable the chat messaging feature for this user group or user
    Now you can enjoy our add-on at your board!

    Special Installation Instructions (e.g. interactions with other add-ons):
    • None so far.


    UPGRADE INSTRUCTIONS:
    1. Download the new version of the add-on from our products section after licensing it for your forum(s). You may need to relicense even free add-ons, if your last version is older than 6 months. Please note, that we are enforcing our license. Please do not download, if you don't agree to it!
    2. Upload everything from the "upload" directory in our software package into your web servers forum directory overwriting all existing files with the new ones!
    3. Go to your Xenforo "ACP > Home > List Add-Ons" and select "[WMTech] Live Chat Conversations". At the dropdown arrow on the right, choose "Upgrade Add-On". A pop-up appears and let you select the XML file "addon-wmt_LiveChatConversations-1xx.xml" we provide in the upgrade software package.
    4. Access "ACP > Home > Options > [WMTech] Realtime Chat Conversations" to inspect existing options and setup any new options of this add-on.
    5. Access "ACP > Users > User Group Permissions". Select the user group you wish to check or inspect the permissions for.
    This completes an upgrade process and refreshes your board with the enhanced power of a new version.

    Special Upgrade Instructions:
    • None so far.


    ADMIN MANUAL:

    Available Options in ACP:
    Home > Options > [WMTech] Realtime Chat Conversations

    • Replace Pagination With 'Load More' ?
      If checked, the usual pagination links are removed and the conversation acts more fluid, like a chat. Members can actively load more older (or newer) messages without the need to reload the page if they click at the big "Load More" buttons.
      If not checked, the regular pagination links appear, resulting in the reload of the page, if the member wants to see older or newer messages.
      Default and recommended: On
      PLEASE NOTE: Members can actively force the pagination to be shown at any time if this is set to "On".

    • Redesign Conversation For Chat View?
      If checked, the conversation view pages at your forum are redesigned to be more suitable for a fluid chat. The discussion message flow gets very condensed and the elements shown at the page are very reduced.
      If not checked, the regular style comparable to a thread message is shown for personal messages.
      Default and recommended: On
      PLEASE NOTE: The CSS codes may need to be adapted if you use a custom style and condensed view (this setting "On"). Please ask your style designer for help with this easy task.

    • Animation For New Messages?
      With [WMTech] Realtime Chat Conversations activated, new messages written in the conversations appear automatically. To drive some attention to them, they appear with a different background color. You are able to customize the animation with this option.
      "None" gives you no different background color at all.
      "Fade Out Automatically" fades the background color out after a few seconds automatically.
      "Fade Out (Short Time)" fades the background color out almost immediatelly.
      "Fade Out (Long Time)" fades the background color out automatically after 1 minute.
      "Disappear After Mouse Over" lets the background color disappear after the member hovers with the mouse over the new messages only.
      Default: Fade Out Automatically

    • Check Interval (Seconds)
      This add-ons checks for new or edited messages in a conversation at a regular time interval and loads them automatically. You are able to select this interval here. We recommend this interval to be very low to give your members a real chat feeling. Only if you use a very powerless server in combination with many chatting members, you want to raise this Check Interval.
      Default: 15, Min: 5, Max: 900, Recommended: 5

    • Reset Interval (Hours)
      When using conversations as chat the page usually never gets reloaded and new messages are inserted automatically via AJAX. Under certain conditions this may lead to problems with some browsers after some time. You are able to set the hours after which a complete page reload will be forced in each conversation here. The optimum value depends on the browsers the majority of your members use. We recommend to start with 1 hour and optionally raise it, if you do not receive complaints.
      Default: 1, Min: 1, Max: 12, Recommended: 1

    Available Permissions in ACP:
    Users > Permissions > User Group Permissions
    Users > Permissions > User Permissions
    • [WMTech] RCC - Use Realtime Chat
      Select "Allow" to allow this user group or this user to use Realtime Chat Conversations.

    Available Phrases and Templates in ACP:
    Appearance > Templates
    • All public templates of this add-on start with "wmt_lcc_" The name of the templates is self-explanatory.
    Appearance > Template Modifications
    • This add-on uses several template modifications. All template modifications are VERY IMPORTANT for this add-on to be able to work. They are designed for the default style only! If you use any custom style, please check if all modifications have been applied correctly by looking at the numbers in the right column of the line with the modification name. If there is a grey or red number, the modification could not be applied thus making this add-on functionless. Contact us or your style designer to solve those issues!
      PLEASE NOTE: There are some template modifications created for some versions of XenForo only. They are marked clearly with the XenForo version they expect. If you use XenForo 1.4 and a template modification for XF 1.2 shows red or grey numbers, you can disregard it.
    Appearance > Phrases
    • All phrases of this add-on start with "wmt_lcc_" The name of the phrases is self explanatory.
    Development > Admin Templates (only available in "Debug Mode")
    • All admin templates of this add-on start with "wmt_lcc_" The name of the templates is self-explanatory.

    Special Usage Informations For Forum Admins:
    • If you use other add-ons enhancing or changing the personal conversation environment (like "Conversation Essentials") you need to check their template modifications on the "message" and "conversation_message" templates. If there are any of them, you may need to create additional template modifications applying the same changes to the "wmt_lcc_message" and "wmt_lcc_conversation_message" templates accordingly, if you use the condensed chat view of this add-on.


    USER MANUAL:

    This web site now features a Simple, Personal & Real Time Messaging option for our members!

    If you create a personal conversation with one or several members all of them will now get their messages delivered in real time automatically to their screens. Use it like your regular messaging software to chat without interruptions if all of you visit the conversation at the same time.

    The enhance your real time messaging experience the pagination has been removed and you are able to load older messages with the big "Load More" button at each end of the message stream. If you get lost, you always can switch on the familiar pagination links using the "Switch Pagination" button.

    If you don't like the condensed messaging view, you are able to switch back to the regular message design using the "Switch View" button. Best of all: Even then, new and edited messages are coming in automatically!
     
    Last edited: Sep 22, 2015
Thread Status:
Not open for further replies.

Share This Page