JLex Helpful Documentation

This documentation contains guides and how-tos for managing your JLex Helpful website.

Requirements

Before we begin, ensure that you have met the System Requirements in order for JLex Helpful to operate correctly. You may find the most basic requirements for JLex Helpful below:

Joomla

Every information related to PHP & MySQL is presented on Joomla’s page, click here to see details

Important: This extension work only in Joomla 3

PHP Requirements

JLex Helpful runs on PHP and it requires PHP to exist on the site.

  • 5.3+ and above.
  • GD Library. In order to manipulate images that are uploaded on the site.
  • CURL Library. In order for JLex Helpful to perform outgoing connections.

PHP Settings

Minimum version: 5.3.x

MySQL Requirements

JLex Helpful requires a minimum version of MySQL 5+

Checking System Requirements

You may review these requirements from the management system: System → System Information → PHP Settings

You can also create a very simple PHP script and include the codes below in your php file.

<?php
// This is a very simple method to load up php's settings.
phpinfo();
?>
            

Recommended Hosting Providers

We have ran a couple of tests on these hosting providers and we recommend them because we've ran a couple of tests on them and they seem to be pretty good at it. (At your own risk)

  • CloudAccess - Official Joomla! demo provider. They know what they are doing.
  • SiteGround - Optimized to run on Joomla! sites.
  • Rackspace - Pretty good support and fast.

Download & Installing

Downloading

In order to download the setup files, you will need to access your account dashboard.

Please click to Get latest version

Setup - Downloading

Installing

In backend, access to Extension Manager > Install tab > Select file and install.

Setup - Installing


Integration


Beginning

Create a section

Step 1. From Administrator UI, go: Extensions > JLex Helpful > Section > New

Step 2. There is field's position in Section config:

Step 3. Setting params for basic fields.

Step 4. Add a row/option - Requested.

  • Type: Button or Icon. If set Icon you must provide URL of icon
  • Show result: No or Yes. If set Yes, the result will show above Button or Icon. See:

    Notice: It depend to your theme that you set.

  • Message: It will be shown when user given your opinion.
  • Callback: Yes or No. Use Yes if you want to collect more data/opinion from visitor.

Step 5. Add custom HTML - Optional and save form.

Create an item

Description

{{jlexhelpful name="PARAM 1" key="PARAM 2" section_id="PARAM 3" }}

  • PARAM 1: Title of object (not heading). This title will be followed in JLex Helpful > Dashboard menu.
  • PARAM 2: Unique key. Only contain: A-z, 0-9 and _,- and dot(.) mark. Normally: <COMPONENT>_<ID OF ITEM>
  • PARAM 3: ID of Section item. See image: (JLex Helpful > Section)

Important: Put above code Anywhere that you want.

Example

{{jlexhelpful name="FAQs item" key="content_1" section_id="1" }}
{{jlexhelpful name="Documetation item" key="k2_2" section_id="1" }}
{{jlexhelpful name="Tom and Jerry item" key="video_3" section_id="1" }}

Results manager

At back-end, go JLex Helpful > Dashboard to manager results of these items.

In order see detail, click to link of item:

* Overview

Notice: Check the box if you want to connect period of main chart.

* Details


Advanced

Multiple languages

In order turn on multiple language, you must set Multiple language in Section config is Yes.

Also, all heading, label, message must encode to ASCII without space, contain only A-Z, 0-9 and (_) mark.
Example

  • Yes >> JH_YES
  • How helpful did you find this answer >> JH_HOW_HELPFUL_DID_YOU_FIND_THIS_ANSWER

Once section saved, you will see Edit button in Section manager.. Click link to begin translate.
Select language and begin translate:

Themes manager

In order create new theme, we recommend you should copy folder components/com_jlexhelpful/theme/ and rename it. Then editing html.php file

Important: Please keep class attribute of element.

There is some popular element's class:

  • ._tp_bar_h : The width of element will change the style.width property from 0% to 100% (<span style="width:60%"></span>)
  • ._tp_bar_v : The height of element will change the style.width property from 0% to 100% (<span style="height:60%"></span>)
  • ._tp_count : Count selected for each item.

Video user guide