FoolLog iconReqText is a VirtueMart plugin to add the functionality of required customer input fields for a product. This is a feature the current versions of VirtueMart do not have. This plugin does not affect any source code of the VirtueMart package or it’s plugins. You can update VirtueMart at any time without the loss of the ReqText functionality (in most cases).

This plugin contains an add-on for the VMPRICES.JS script which “overrides” the mouse click from add-to-cart button when a ReqText field is set for a product. This is needed so the script can use it’s routines to check if a customer input field is required and shows the corresponding message.
The optimized JavaScript file does not cause any conflicts with the existing VMPRICES.JS script from VirtueMart. This way you can always use all the benefits of VirtueMart and the ReqText plugin together.


Why do I need ReqText?

icon 48 pluginWell, as stated above – the current version of VirtueMart does not offer the possibility to add customer input fields that must be filled (required) before ordering a product. Also missing is the option to add radio buttons or checkboxes. You can set the options for each product individually and this can be achieved using the Custom Fields option in the VirtueMart backend.

So when you require input for a product you can use this ReqText plugin. For instance when you sell personalized towels with the printed name of your customer, you need to know what the customer’s name is before you can deliver such an order. The customer selects the product in your webshop and before the Add To Cart button can be clicked a text field must be filled. If not the customer will be noticed about the missing text and the order is not placed in the cart, yet.

After filling all required fields the product can be added to the cart and all entered values are listed beneath the product in the cart.

AlertBecause the ReqText plugin is now suitable to use in Joomla! ™ version 3.x and 4.x it could be pictures in this manual do not match the Joomla! ™ environment you are using. But titles and buttons are very look-a-like throughout both versions. If needed this manual describes everything for both Joomla! ™ versions.

 


icon 48 downloadThe ReqText plugin is not a part of any component. The plugin can be downloaded from http://www.uwix.nl When you visit our website you can select the Download button and browse for the ReqText category. That’s the category which contains the latest version of the plugin.

You can use the ReqText plugin in combination with VirtueMart 3.x or VirtueMart 4.x which can be downloaded from http://www.virtuemart.org.

 

ReqText Requirements

ReqText is a VirtueMart plugin and not a stand-alone component for Joomla!™. The full list of requirements to use ReqText is:

  • Joomla!™ 3.x or 4.x and PHP compatible version.
  • VirtueMart 3.x or 4.x.
  • jQuery support activated for your site (default when using VirtueMart).
  • Administrator rights to Joomla!™ for installing extensions.
  • And of course some products added to your webshop. :-)

If you already have a site installed on a server you’ll have to make sure all folder rights are set correctly according the Joomla!™ and VirtueMart requirements.
The ReqText plugin uses the Poshy javascript library for displaying tooltips in different (popup) CSS styles. All credits go the Vadikom Web Ltd. for the development of this script. For more information go to http://vadikom.com.

AlertAlways make sure you test any configuration or add-on in a protected test-environment. It is NOT recommended to test a plugin like ReqText directly in a live environment. 

 


Installing the ReqText plugin

icon 48 configYou can install the ReqText plugin like any other extension in Joomla!™. But for those who haven't done that in a long time, please follow these steps:

  1. Login into the backend of your Joomla!™ website using Administrator credentials.
  2. Select in the backend overview the Extensions Manager or Install Extension (J3!).
  3. Click the Upload Package File tab and Browse next to the Extension Package file title. Select the ReqText plugin package which you have downloaded from out website.
  4. Click Upload & Install to load and install the ReqText plugin.

When everything went well you get a nice message “Installing plugin was succesfull.”.

 

Activate the ReqText plugin

Before you can use the ReqText plugin in your VirtueMart environment you need to be sure the plugin is activated (published) in Joomla!™. To do so do the following:

  1. Move your mouse at the top of the page and hover it above the title Extensions.
  2. In the dropdown menu which appears select the Plug-in Manager.
  3. In the displayed list of plugins it could be hard to find the ReqText plugin, so enter ReqText in the Filter field and click Search.
  4. If the installation went well you can see one item which is called ReqText For VirtueMart. Check if the status is set to published ( man publish ). If not click man unpublish to publish the plugin.

 


Enter the Download ID for subscribed updates

icon 48 clearWhen you want to download updates for the ReqText plugin through the Joomla! update feature you’ll need to enter your Download ID in the configuration of the plugin.
So, let’s do so:

  1. Move your mouse at the top of the page and hover it above the title Extensions or click the ReqText For VirtueMart plugin title if you’ve just followed the instructions for activating the ReqText plugin (if so continue at step 4).
  2. In the dropdown menu which appears select the Plug-in Manager.
  3. In the displayed list of plugins it could be hard to find the ReqText plugin, so enter ReqText in the Filter field and click Search.
  4. Click on the ReqText For VirtueMart title to open the plugin parameters.

On the plugin page you’ll see a panel/tab ReqText Updates which contains an input field called Download Id. This is where you’ll have to enter the Download ID which you can retrieve from our website http://www.uwix.nl after you’ve logged in. The Download ID can be found in the personal menu and is only valid for the duration of your subscription.

man config01

  1. Enter the Download ID you’ve found on the UWiX website or do a copy-paste of the ID in the input field.
  2. Select to use minified CSS files for faster loading of the tooltips styling for the frontend users. The smaller the files the faster your webpage(s) load. Remember this setting is only used in the frontend!

Click man save to store the Download ID in the plugin configuration. After doing this you can use the Joomla! update feature to download and install updates for the ReqText plugin according your subscription period.

 


Configure the ReqText plugin

icon 48 themesYou'll first need to add a new custom field to the products control panel before you can use it to add them in your products. This step is crucial because you'll need to set the default settings for a custom field and the type of input. So, let’s start using the plugin for one of your products just follow these steps:

  1. Click Components->VirtueMart at the top of your Joomla!™ backend or click the VirtueMart button in the top menu and select Control Panel (J!3).
  2. Click Products and select Custom Fields in the VirtueMart menu (at the left of your page).
  3. Click man new at the top right to open a new item form.

When the settings form is opened you'll get numerous fields to fill.

  1. Start by selecting Plug-ins in the Custom Field Type dropdown list ( man customselect ),
  2. At the bottom of the form the option Select a Plugin-in appears. Select ReqText For VirtueMart in that dropdown list. The additional parameters for the ReqText plugin will show on screen.
  3. Enter a title in the Title field at the top of the form.

AlertPlease click  man save  before you continue entering any settings. After doing this a few unnecessary items for this plugin will be hidden and new options will appear.

 


Custom field settings

So let's start filling the custom input fields which are needed to use the ReqText plugin correctly:

man config02

  1. You already have set the value for the Title. This title is used as plugin title in the backend of your VirtueMart environment and as title in the product description.

  2. The Show Title setting is used to enable or disable the displaying of the Title in the frontend product description.

  3. If the custom field is Published it can be used to add it to products. Disable it if you (temporarily) will not use the custom field.

  4. Set the Cart Attribute to Yes for the ReqText plugin to be of any use for the products and your customers during the ordering process.

  5. Enter a Description here if you want to give your customers more information about the required field. It will be displayed as separate text.

  6. Any Tooltip text will be used to display extra information in the form of a man tooltip symbol.

  7. Set the Cart Input to Yes. This option is only available in VirtueMart 3.

All other options can be filled to your preferences or leave them blank. If you need more information about using Custom Fields in VirtueMart you can start here: http://dev.virtuemart.net/projects/virtuemart/wiki/hints_for_the_use_of_the_product_customfields

 


ReqText field settings

You're now finished with setting the default Custom Field options. Let's have a look at the ReqText specific options:

man config03

  1. This is the title/description which will appear in the customers cart (and the cart overview) as a field title.

  2. Here you can select the pricing for this Custom Field. Should the price be charged per input, per letter or per selection? Ofcourse the Price Per Letter option will only work when using a Text or Textarea field type. And the Price Per Selection only works on the Radio,
    Checkbox or SelectList fields.

  3. You can choose the field type which should apply to this Custom Field. The following fields are available: Text, Textarea, SelectList, Radio, Checkbox and Datepicker (v1.2 and higher).

  4. The required popup tip can be styled using the following CSS styles:
    man tooltips
    Starting from ReqText version 1.5 the styling is set for each required field separatly. This way you can use multiple CSS styles for any required field for a product. But be aware that it could also work confusing for your customers if they see several different styled "Field Required" messages.

  5. Where shou;ld the tooltip appear: Left, Right, Top or Bottom of the required input field?

  6. Hide or show the "additional charge" for this field. When no charge is needed  and you have multiple required fields it can enhance your layout by setting this option to Yes.

  7. Set the field to be required or not. This can be changed separatly for each product where you use this ReqText Custom Field. This is the global setting for this ReqText Custom Field.

  8. Enter the different chioices for the SelectList. Separate each choice with Enter (new line).

  9. ! This value is important when you've set the Required Field to Yes !
    Enter the default selected value to check if the selection is different from this value. If the customer doesn't select another value the 'Required Field' tooltip will be shown. You can only set one default value to check.

  10. Here you can add custom prices for each selection. Enter a value for selections entered in the List Options field on a new line. Only enter the price value without any money currency and separate each value with Enter (new line).
    ! When no value is entered  (or not enough for every selection) 0.0 will be assumed by the plugin !

All these settings are the global plugin settings. Specific field type settings can be set when you add the ReqText custom field to the product which needs the required input. This way you can set individual selections for different products using one defined ReqText Custom Field.

Please enter a Shopping cart title and select the correct values for the other fields to complete the first step for using the ReqText custom field. Click man save&close to store the values and close the edit page.

AlertThe options 8, 9 and 10 are only used for the Checkbox, Radio and SelectList input fields. When you fill these fields in the custom fields tab of a product, those values are used. The values in this screen are global settings and will only be used for a product when no override settings are found!

 


Add the ReqText custom field to a product

The basic settings are now setup for your first ReqText field. So we’ll continue by adding the ReqText field to a product:

  1. Select Products in the VirtueMart Menu (man products at the left of your page).
  2. In the product overview select the product where you want to use the ReqText field. Select the product by clicking the Product Name. Assuming you've already entered all the correct information for your product, you'll have to click the Custom Fields tab.
  3. Near the Custom Field Type title you see a dropdown list. Click on it to open it and select your newly created ReqText custom field by it's name. In our example it's called ReqText Sample.

Now the ReqText settings are displayed beneath the dropdown list. Or, if you have already selected several custom fields, it's below the last custom field at the bottom of the page.
Let's see what options are possible in our example:

man textinput

  1. You can set the Text input field to be required (or not) for this product. If you leave this option set to ‘No’ your customers can always order a product even if they leave the input field empty.

  2. This is the hint which is displayed when the user needs to fill in the custom field. It is multi-lingual aware and by default it shows “Required Field”.

  3. This option can restrict the number of characters a customer can enter in the input field. When set to 0 or left blank no limit is set.

  4. If you set this field a user needs to enter the minimal number of characters before the product can be added to the cart. When set to 0 or left blank no limit is set.

  5. Here you can set the width of the input field. If you leave it empty (or set it to null) the default width is used (defined in template CSS or browser default).

  6. This feature allows you to set limitations to the input a user can enter. It is checked by a jQuery script when the user starts typing and before the result is saved into the cart.

Click man save&close to store the custom field settings for this product. Open the frontend of your webshop and browse to the product you have just editted. Check to see if the ReqText input field is correctly added to the product. You can test it by adding the product using man addtocart.

 


ReqText field types overview

Because you can define all sort of input fields we’ll explain the use of them in this chapter. All the possible fields are similar to the text input explained in the previous chapter.

 

Text input field

With this field the customer can add a single line for a product he/she wishes to order. The options for this field are also explained in the previous chapter but to let's go over them once again:

man textinput

  1. You can set the Text input field to be required (or not) for this product. If you leave this option set to ‘No’ your customers can always order a product even if they leave the input field empty.

  2. This is the hint which is displayed when the user needs to fill in the custom field. It is multi-lingual aware and by default it shows “Required Field”.

  3. This option can restrict the number of characters a customer can enter in the input field. When set to 0 or left blank no limit is set.

  4. If you set this field a user needs to enter the minimal number of characters before the product can be added to the cart. When set to 0 or left blank no limit is set.

  5. Here you can set the width of the input field. If you leave it empty (or set it to null) the default width is used (defined in template CSS or browser default).

  6. This feature allows you to set limitations to the input a user can enter. It is checked by a jQuery script when the user starts typing and before the result is saved into the cart.

 


Textarea input field

With the textarea input field you can let your customers enter a (large) text that doesn’t fit in one input field (like text ). The usage of the textarea is the same as the text input field with slightly different options to set:

man textarea

  1. You can set the textarea input field to be required (or not) for this product. If you leave this option set to ‘no’ your customers can always order a product even if they leave the input field empty.

  2. This is the hint which is displayed when the user needs to fill in the custom field. It is multi-lingual aware and by default it shows “Required Field”.

  3. If you set this field a user needs to enter the minimal number of characters before the product can be added to the cart. When set to 0 or left blank no limit is set.

  4. What is the maximum number of characters a customer can enter in the textarea? Keep in mind you you probably want a long text from the customer for the product to order. If not you can better use the text input field.

  5. How many rows of the textarea must be shown in the product details? Leave this value blank if you want the browser to decide for you. Rows represents the height of the textarea.

  6. How many columns (=characters) of the textarea must be shown in the product details? Leave this value blank if you want the browser to decide for you. Columns represents the width of the textarea.

  7. This option allows you to set limitations to the input a user can enter. It is check by a jQuery script when the user starts typing and before the result is saved into the cart.

 


SelectList input field

You can create a (required) select/dropdown list using this option. It looks similar to the default Custom Field list-type from VirtueMart, but there is a difference: you cannot select each option separately for each product using the same Custom Field item(s). If you have no clue what this means, that’s okay you probably won’t use this feature at the moment.

man select

  1. You can set the selectlist to be required (or not) for this product. If you leave this option set to ‘no’ your customers can always order a product even if they leave the input field empty.

  2. This is the hint which is displayed when the user needs to fill in the custom field. It is multi-lingual aware and by default it shows “Required Field”.

  3. Enter the different choices for the selectlist. Separate each choice with enter (new line).

  4. Also new is the ability to add custom prices for each selection. Enter a value for each selection entered in the list options field on a new line. Only enter the price value without any money currency. Separate each value with enter (new line).
    ! When no value (or not enough for every selection) 0.0 will be assumed by the plugin !

  5. ! This value is important when you’ve set the required field to yes !
    Enter the default selected value to check if the selection is different from this value. If the customer doesn’t select another value the ‘Required Field’ message will be shown to the customer. You can only set one default value to check.

AlertThe options 3, 4 and 5 will be used prior to the global settings of these fields you've setup in the "custom fields" area of the VirtueMart control panel. When you leave these fields emtpy the plugin falls back to the global settings of the "custom field".

 


Radio button input field

When using the radio button input field your customers can select one of the listed options for a product. Only one selection is possible and if the customer selection is the same as the default selected value the ‘Required Field’ message will appear, that is if the Required Field is set to yes.

man radio

  1. You can set the radio button input field to be required (or not) for this product. If you set this option to ‘no’ your customers can always order a product even if they haven’t select anything.

  2. This is the hint which is displayed when the user needs to fill in the custom field. It is multi-lingual aware and by default it shows “Required Field”.

  3. Enter the different choices for the radio button list. Separate each choice with enter (new line).

  4. Here you can add custom prices for each selection. Enter a value for each selection entered in the list options field on a new line. Only enter the price value without any money currency. Separate each value with enter(new line).
    ! When no value (or not enough for every selection) 0.0 will be assumed by the plugin !
  5. ! This value is important when you’ve set the required field to yes !
    Enter the default selected value to check if the selection is different from this value. If the selection is NOT different a ‘Required field’ message will be shown to the customer. You can only set one default value to check. Separate each value with enter (new line).

AlertThe options 3, 4 and 5 will be used prior to the global settings of these fields you've setup in the "custom fields" area of the VirtueMart control panel. When you leave these fields emtpy the plugin falls back to the global settings of the "custom field".

 


Checkbox input field

Give your customers the benefit of selecting multiple options for a product. With the checkbox input field you can list several values and if nothing is selected the ‘Required Field’ message is shown.

man checkbox

  1. You can set the checkbox input field to be required (or not) for this product. If you leave this option set to ‘no’ your customers can always order a product even if they leave the input field empty.

  2. This is the hint which is displayed when the user needs to fill in the custom field. It is multi-lingual aware and by default it shows “Required Field”.

  3. Enter the different options for the checkbox list. Separate each choice with enter (new line).

  4. Here you can add custom prices for each selection. Enter a value for each selection entered in the list options field on a new line. Only enter the price value without any money currency. Separate each value with enter (new line).
    ! When no value (or not enough for every selection) 0.0 will be assumed by the plugin !

The default selection of a checkbox list is set to none. If nothing is selected and the Required Field is set to yes, the customer will get a ‘Required Field’ message when clicking the man addtocart button.

AlertThe options 3 and 4 will be used prior to the global settings of these fields you've setup in the "custom fields" area of the VirtueMart control panel. When you leave these fields emtpy the plugin falls back to the global settings of the "custom field".

 


Date Picker field

Are you in need of a date input from your customer? The datepicker input field does that. You can set the start date to display in the calendar popup and if no date is selected the ‘Required Field’ message is shown.

man calendar

  1. You can set the checkbox input field to be required (or not) for this product. If you leave this option set to ‘no’ your customers can always order a product even if they leave the input field empty.
  2. This is the hint which is displayed when the user needs to fill in the custom field. It is multi-lingual aware and by default it shows “Required Field”.
  3. Enter the date where the date picker popup should start. You can also use the calendar icon to select a date. If you do not set this option the date of today is used as start date.

AlertWhen youve added the date picker input field to your product custom fields you must save the product first! Otherwise the start date calendar selection will not work properly.

 


Color Picker field

You can create a (required) color selection using this option starting from version 1.60 of the ReqText plugin. The color-codes from the color options list will be used to create color circles/squares in the front-end for your customers. Customers can only select one color per required color picker field.

 man colorpick

  1. You can set the color picker input field to be required (or not) for this product. If you leave this option set to ‘no’ your customers can always order a product even if they do not select any color.

  2. This is the hint which is displayed when the user needs to fill in the custom field. It is multi-lingual aware and by default it shows “Required Field”.

  3. Select or type the colors you want to display for the product. Use the red colored button at the right of this list to select your colors using a color picker. Separate each choice with enter (new line).

  4. ! This value is important when you’ve set the required field to yes !
    Enter the default selected value to check if the selection is different from this value. If the selection is NOT different a ‘Required field’ message will be shown to the customer. You can only set one default value to check. Separate each value with enter (new line).

  5. Showing color codes in HEX format isn’t really practical but sometimes needed. Here you can set the title for each color option as a popup hint. Separate each value with enter (new line).

  6. Here you can add custom prices for each color. You can enter a value for each color in the color options field on a new line. Enter the price value without any money currency and separate each value with enter (new line).
    ! When no value is set (or not for every selection) 0.0 will be assumed by the plugin !

AlertWhen a product requires multiple color selections from the customer, you can create multiple color picker input fields to do so. that way you can also label the colors using correct names to identify the color selection, e.g.: main color, border color, etc.

 


Quick steps for adding a Reqtext custom field

For all the users who haven’t got the spare time to read the full explanation how to add a ReqText custom field, here’s a shortcut list:

  1. Open the VirtueMart component.
  2. Select custom fields in the left menu of VirtueMart and click the new button.
  3. Select plug-ins at the Custom field type.
  4. Select ReqText for VirtueMart at the select a plug-in option.
  5. Fill in a title and click save.
  6. Enter all the necessary settings for the custom field including the ReqText fields. Remember to set the cart attribute to yes. And in case you’re using VirtueMart 3 you should also set the cart input to yes.
  7. Click save & close.
  8. Click products in the Virtuemart menu and select the product name where you want to add the ReqText input field.
  9. Open the tab custom fields.
  10. At the custom field type click on the dropdown list and select your newly created ReqText custom field.
  11. Enter all the required information and click save & close.

Now your customers see a (required) input field added to the product you’ve just configured. Make sure you check everything (in a protected test environment) before going online.

 


Frequently Asked Questions

icon 48 help thisAfter reading the this complete manual it could be you still have a few unanswered questions. We crunched our brains a bit more and started this chapter. If your question isn’t in this chapter you can always use our support tickets at http://www.uwix.nl.

 

• How to style the display of the ReqText required fields in the frontend?
The ReqText plugin uses the VirtueMart used styles to display all the information for a product. If you want to design your own style to display your products you’ll have to use template overrides.
Just go to http://www.virtuemart.org for more information how to create your own template overrides.

 

• Can I set an individual price for each selected option using the checkbox field?
Yes, starting from ReqText version 1.5 it is possible to set individual prices for each selected option. See the corresponding chapters to use individual pricing.

 

• Can I remove the added “no extra costs” added to the field options?
Yes, you can but it’s not a function from within the ReqText plugin. You’ll have to use the Joomla!™ language overrides tool for it (only applies for ReqText versions prior to version 1.2):

  1. In the Joomla!™ backend hover over extensions and click language manager.
  2. Click the overrides tab and click new.
  3. Under search text you want to change, type com_virtuemart_cart_price_free. Ensure value is selected and click search. Click on the found result.
  4. Under create a new override, update the text to reflect what you want it to read. Leave it blank if don’t want to display any text.
  5. Click save & close in the top right menu.

That’s it but keep in mind you’ll have to do this for every language which you’ve installed for the frontend customers/users.

 

• Will ReqText still work after I’ve updated VirtueMart to a newer version?
Yes, it will. Because the plugin is programmed to be a stand-alone add-on for VirtueMart and it does not alter any VirtueMart source files. So any update of the VirtueMart component should work.

Unless the VirtueMart team decides to rewrite the plugin support. In that case we’ll try to release an update for ReqText as soon as possible.

 

Is it really necessary to set the “Cart Attirbute” or “Cart Input” to “Yes”?
If you want the customer to add input to a product he/she wants to order, it is necessary. If the cart attribute is set to no the ReqText required field will not be shown at any time.

 

• The Download ID seems to be invalid but my subscription is not expired yet?
You have probably changed your username, password or e-mail address on our website recently. Is that the case? You can find a newly generated Download ID in your personal menu after you have logged in at http://www.uwix.nl. Use the new Download ID to enter in your ReqText plugin configuration. Now the updates should work as they should.
Still having trouble? Please contact use through our website to report the problem and we’ll assist you in the best ways we can.

 

• The required tip CSS looks screwed up. How can I fix it?
This has nothing to do with the used Poshy Tip CSS styles. Most likely your template contains CSS tags which overrides the tip CSS styles. Use a respected browser with a webdeveloper plugin to analyse which CSS tags “screw up” your tooltip.
You can also try to select another tip style for the required field in the ReqText plugin settings for the used required field.

 

• When I click the “Start Date” to set the Datepicker field the calendar popup does not show.
Because of the way VirtueMart uses custom fields plugins this option is only available when you save the product first. This only happens when you have just added the Datepicker required field as a new custom field for a product.

 

hitzero150x150HitZero is a Joomla!™ 3.x Plugin to reset the hit counter for single or multiple Joomla! articles.

When creating a new article for your site and you want to be sure it looks good so - if you are like us - you test it as an online user. Sometimes this needs to be done multiple times before releasing it for public users. The downside is that your article hit counter isn't set to zero anymore but you are the only one who has viewed it.

Not with this HitZero plugin! It can do what you want.


Why should I use HitZero?

icon 48 plugin

Allright, let's set the hit counter for your newly created article back to zero before activating the article...

Well, if you know your SQL queries this shouldn't be a big problem but it takes some unnecessary time to do so. And what if you do not have any knowledge of SQL queries? Then you're stuck.

That's where the HitZero plugin comes in. You can easily reset the hits counter for single or multiple articles with the click-of-a-button! No more diggin' in database tables and numerous MySQL queries. No more frustration of not be able to set the counter to zero! Just click the button in front of the article (in the back-end ofcourse) and you're done.


Download the plugin

icon 48 downloadThis plugin is not part of any component and can be downloaded from our download section. You can select the Download button and browse for the HitZero category. That's the category which contains the latest version of the plugin.

You do not need any subscription on our website to download or use this HitZero plugin. It's totally free of charge and you can use it on any website you like. If you need support for this plugin you can use our support pages for answers. If you want to request a help ticket you do need a Support Subscription on our site.

HitZero requirements

HetZero is a plugin and not a stand-alone component for Joomla!™. The full list (not a very big one) of requirements to use this plugin is:

  • Joomla!™ 3.8 and higher or 4.x and PHP compatible version (5.4 or higher).
  • Administrator account to login into Joomla!™ for installing extensions.

The HitZero plugin uses javascript/JQuery to add the buttons in the back-end article view of your website. The plugin isn't intended for use in the front-end of your website nor will it any code to your front-end webpages.


Installing the HitZero plugin

icon 48 configYou can install the HitZero plugin like any other extension in Joomla!™. But for those who haven't done that in a long time, please follow these steps:
 

  1. Login to the backend of your Joomla!™ website using Administrator credentials.
  2. Select in the backend overview the Extensions -> Manage menu option.
  3. Click the Upload Package File tab and click Browse next to the Extension Package file title. Select the HitZero Plugin package which you have downloaded from our website (or drag-n-drop it if possible).
  4. Click Upload & Install to load and install the plugin.

When everything went well you'll get a nice message "Installing module was succesfull.". But, you're not done yet.

  1. Click Extensions -> Plugins to open the plugins overview.
  2. In the Search field you'll have to type "Hitzero" and click the search button.
  3. Open the plugin parameters by clicking the title which contains HitZero.
  4. Set the parameter(s) to your needs and also set the Status to Enabled to activate the plugin.
  5. Click Save & exit to store your plugin settings.

That's it. Now you can start using the HitZero plugin functions in your article view.


How to use the plugin?

icon 48 article addWhen the HitZero plugin is installed and published correctly it will add (by default) two buttons in the Article overview section in the back-end of your Joomla!™ website.

 

• Clear hits for multiple articles.
The clearbtn button is added to the toolbar at the top of the Article view and this can reset the hit counter for multiple articles at once. Follow these steps to do so:

  • Select the articles you want to reset by clicking the checkbox in front of them in the article list.
  • Click the Clear All Hits button in the toolbar.
  • A confirmation screen will popup answer with Ok to set the hit counter to zero for the selected articles.

• Clear hits for a single article.
You can also use HitZero for a single article so you can work 'fast'. At the front of each article there's little toolbar with options like publish, archive, etc. HitZero adds a little button (curved arrow) to reset the hits quickly for that single article. In a few simple steps you can reset the hits to zero:

  • Click the curved arrow button ( curvedarr ) at the right of the star in front of the article you want to reset. 
  • A confirmation screen will popup answer with Ok to set the hit counter to zero for the selected articles.

That's all there is to it. Plain easy and anyone with the correct user rights can use it.

Alertwhen you have reset the hit counter to zero for a single or multiple articles this cannot be undone!

If you want to restore the number of hits you'll have to keep track of the number of hits for that article yourself. And you'll have to execute the correct sql-queries yourself. HitZero cannot do this for you!


Frequently Asked Questions

icon 48 help thisAfter reading this manual it could be you still have a few unanswered questions. Maybe this chapter can help you a bit. If your question isnt answered in this FAQ you can always use our support forum.


• The plugin does not seem to work?
You should check a few things:

  1. Did you Enable the HitZero plugin in the backend?
  2. Do you have articles that have a hitcounter larger than zero? If not HitZero has nothing to reset and will not do anything.

• The curved arrow button is grayed out.
When the hit counter of an article is already zero there is no need to reset it. That is the reaso why the button is grayed out and it will become active if the hit counter is bigger than zero.
But you can change this behaviour by changing a plugin parameter:

  1. Login to the backend of your Joomla!™ website using Administrator credentials.
  2. Click Extensions -> Plugins to open the plugins overview.
  3. In the Search field you'll have to type "HitZero" and click the search button.
  4. Open the plugin parameters by clicking on the HitZero plugin title.
  5. Set the Disabled HitZero button to No.
  6. Click Save & Close to store the configuration.
  7. When you open the Article overview the button is enabled even for articles with a zero hit count.

 

Extension Update IconExtension Update Notification (ExtUpNotification) is  a Joomla!™ 3.1.x Plugin to send e-mails to one or more SuperUsers when an update of an installed extension is available.

We have created this plugin because our customers really like the Joomla! Update Notification plugin which is standard available upon a Joomla! installation. But our customers (and we ourselfs too) missed the feature to be notified about any available extension update on our installed Joomla! websites.
So why not use the Joomla! Update notification Plugin code as a base for such plugin? Well, we did so and we're glad to have it released in public for all of users!

Do you want to know how this plugin can ease your website maintenance? Well, continue reading, it's not that hard to use this plugin.


Why should I use ExtUpNotification?

icon 48 plugin

There's a good change you do not even need this plugin if you visit you're websites backend on a daily base. But what if you do not have the time to log in every day to check for any extension update? Well, this plugin does the check for you and sends you an email with the extension that have an update ready for download.

All the necessary items are listed in the e-mail, including the links with extra information about the specific update (if the developer have one available). That way you can deside when you want to install the extension update and know about them as soon as they become available (checked by your own site).

Enjoy the ease of maintenance!


Download the plugin

icon 48 downloadThis plugin is not part of any component and can be downloaded from our download section. You can select the Download button and browse for the ExtUpNotification category. That's the category which contains the latest version of the plugin.

You do not need any subscription on our website to download or use this ExtUpNotification plugin. It's totally free of charge and you can use it on any website you like. If you need support for this plugin you can use our support pages for answers. If you want to request a help ticket you do need a Support Subscription on our site.

ExtUpNotification requirements

ExtUpNotification is a plugin and not a stand-alone component for Joomla!™. The full list of requirements to use this plugin is:

  • Joomla!™ 3.1.x and PHP compatible version.
  • Administrator account to login into Joomla!™ for installing extensions.
  • Some 3rd party extensions which need an update in the near future. :-)

The ExtUpNotification plugin uses no javascript nor will it add any to your template. It only loads as a system plugin which checks for updates - ones a day when your site is visited by any internet user.


Installing the ExtUpNotification plugin

icon 48 configYou can install the ExtUpNotification plugin like any other extension in Joomla!™. But for those who haven't done that in a long time, please follow these steps:
 

  1. Login to the backend of your Joomla!™ website using Administrator credentials.
  2. Select in the backend overview the Extensions -> Manage menu option.
  3. Click the Upload Package File tab and click Browse next to the Extension Package file title. Select the ExtUpNotification Plugin package which you have downloaded from our website.
  4. Click Upload & Install to load and install the plugin.

When everything went well you'll get a nice message "Installing plugin was succesfull.". But, you're not done yet.

  1. Click Extensions -> Plugins to open the plugins overview.
  2. In the Search field you'll have to type "extupnotification" and click the search button.
  3. Open the plugin parameters by clicking the title which contains Extension Update Notification plugin (UWiX).
  4. Set the parameters to your needs and also set the Status to Enabled to activate the plugin. Remember: if you do not fill any email address and the plugin is activated it will send an notification e-mail to ALL super users known in the backend of your website. That is if an update of any extension is found.
  5. Click Save & exit to store your plugin settings.

That's it. Let's start using the ExtUpNotification plugin.

AlertThis plugin is installed with only English translation files. If you want to translate it to your own language you'll have to create your them using the Joomla! standards. More information can be found at http://docs.joomla.org.


How to use the plugin?

icon 48 article addThe usage of our plugin is quite simple. Once you've set the parameters to your needs and made it active the plugin does it's job.

Every time a user visits your website the plugin will check if it already searched for new updates that day and will send a notification e-mail to the set email address(es) from it's parameters. If no check is needed or no update is found there will not be send any notification e-mail.

AlertThe ExtUpNotification plugin will not check any extension which has a "disabled update site" flag set in the backend of your website. To let the plugin notice updates of a disabled extension you'll have to enable it again using the Joomla! Update Extension page.


Frequently Asked Questions

icon 48 help thisAfter reading this manual it could be you still have a few unanswered questions. Maybe this chapter can help you a bit. If your question isnt answered in this FAQ you can always use our support forum.


• The plugin does not seem to work?
You should check a few things:

  1. Did you Enable the ExtUpNotification plugin in the backend?
  2. The plugin will only check once a day for updated extension and will also e-mail once about it.
  3. Disabled Update sites for extensions are not checked for updates! Maybe that's the reaseon the plugin does not seem to work? Check the Joomla! Extension Update page in the backend of your site.

 

upagebreak iconUPagebreak is  Joomla!™ 3.1.x Plugin to add some extra options to the default Pagebreak plugin installed with a default Joomla!™ installation.

This plugin was first created for internal use to provide some better options when writing online documentation using the standard articles. After we've tweaked the default plugin to our own needs we realized we are probably not the only ones who could use that plugin. So, here it is: an alternative for the default Pagebreak plugin to use for all of you - totally free of charge!

Want to know a bit more what this plugin can do for you? Well, continue reading - and by the way - the buttons below this line are the result of this new UPagebreak plugin...


Why should I use UPagebreak?

icon 48 plugin

There's a good change you do not even need this enhanced plugin but when you want be a more in control of the Previous and Next buttons in your articles we recommend installing our plugin.

You can set the alignment of the Previous and Next buttons but also add a Top button for easy reloading of the active page (when using a table of contents).

That's it - for now no more extra added options are available for this plugin, but it get's the job done.


Download the plugin

icon 48 downloadThis plugin is not part of any component and can be downloaded from our download section. You can select the Download button and browse for the UPagebreak category. That's the category which contains the latest version of the plugin.

You do not need any subscription on our website to download or use this UPagebreak plugin. It's totally free of charge and you can use it on any website you like. If you need support for this plugin you can use our support pages for answers. If you want to request a help ticket you do need a Support Subscription on our site.

UPagebreak requirements

UPagebreak a plugin and not a stand-alone component for Joomla!™. The full list of requirements to use this plugin is:

  • Joomla!™ 3.1.x and PHP compatible version.
  • Administrator account to login into Joomla!™ for installing extensions.
  • Some articles where you can use the UPagebreak plugin. :-)

The UPagebreak plugin uses no javascript nor will it add any to your template. The only code that is added to your webpages is the CSS styling needed for the article navigation as set in the plugin parameters.


Installing the UPagebreak plugin

icon 48 configYou can install the UPagebreak plugin like any other extension in Joomla!™. But for those who haven't done that in a long time, please follow these steps:
 

  1. Login to the backend of your Joomla!™ website using Administrator credentials.
  2. Select in the backend overview the Extensions -> Manage menu option.
  3. Click the Upload Package File tab and click Browse next to the Extension Package file title. Select the UPagebreak Plugin package which you have downloaded from our website.
  4. Click Upload & Install to load and install the plugin.

When everything went well you'll get a nice message "Installing module was succesfull.". But, you're not done yet.

  1. Click Extensions -> Plugins to open the plugins overview.
  2. In the Search field you'll have to type "upage break" and click the search button.
  3. Open the plugin parameters by clicking the title which contains UPagebreak (UWiX).
  4. Set the parameters to your needs and also set the Status to Enabled to activate the plugin.
  5. Click Save & exit to store your plugin settings.

To prevent strange things to happen on your webpages you'll have to disable the default Pagebreak plugin - otherwise these plugins will collide.

  1. Type "page break" in the Search field and click the search button.
  2. Click the "Content - Page Break" title to open the plugin parameters.
  3. Set the Status to Disabled to deactivate the default plugin.
  4. Click Save & exit to store the plugin settings.

That's it. Let's start using the UPagebreak plugin.

AlertThe title of the plugin may be different for the language you are using in your backend. You can always try to search for "New page" translated in your own language on your site. Or you can filter the plugin list to the "content" type and check the list for an element called "pagebreak".


How to use the plugin?

icon 48 article addThe usage of our plugin is quite simple. Start by typing your article like any other article in Joomla!™. When you need a pagebreak you can use the New page button below your text-editor in the backend. This button is default set to enabled during a Joomla!™ installation and can be used in combination with the UPagebreak plugin.

Each new pagebreak will be added to the Table of Contents (ToC) in the frontend in the article. Navigation buttons will be set at the bottom of the article before each pagebreak. The parameters you've set in the UPagebreak plugin will be used for the layout of the buttons.

AlertCSS styling like the "page x of x" is done by your template stylesheet and CAN NOT be set in the UPagebreak plugin.


Frequently Asked Questions

icon 48 help thisAfter reading this manual it could be you still have a few unanswered questions. Maybe this chapter can help you a bit. If your question isnt answered in this FAQ you can always use our support forum.


• The plugin does not seem to work?
You should check a few things:

  1. Did you Enable the UPagebreak plugin in the backend?
  2. Are you sure you've Disabled the default Pagebreak plugin in the backend?
  3. Is there any CSS styling in your template stylesheet that messes up the navigation buttons?


• The 'page x of y' can not be set in the plugin parameters.
This is a very true fact! You CAN NOT change the CSS styling of the 'page x of y' in the UPagebreak Plugin. You really need to dig into your template CSS stylesheet(s) to fix this.


• The 'page x of y' can not be set in the plugin parameters.
Check to see if the New Page button plugin is activated in the backend:

  1. Login to the backend of your Joomla!™ website using Administrator credentials.
  2. Click Extensions -> Plugins to open the plugins overview.
  3. In the Search field you'll have to type "Button - Page Break" and click the search button.
  4. Make sure the found plugin is enabled. You can check for the published icon in front of the plugin.
  5. If there's a red cross in front of the plugin it's not enabled. Click the cross to enable it.
  6. When you return the edit your article a button should now be present at the bottom of your editor.

 

bcrumbscss(150x150)BreadCrumbs CSS for Joomla!™ is a module which replaces the default Joomla! breadcrumbs module. It supports all default breadcrumbs options but makes it much nicer to look at.

With the BC-CSS module you can use animated styles for the breadcrumbs when a user hovers the mouse over them. The animations are fully written in CSS3 so you do not need any extra javascript files loaded to your pages.
This module can also cut off your breadcrumbs so they fit better on your webpages. When a user hovers above the cutoff breadcrumb the full breadcrumb will be show so your users always find what they are looking for.

Ofcourse you can also use the default Joomla! breadcrumbs style and set the extra options of this module like; clickable Home, cut off breadcrumbs, alternative Home link, etc.

AlertWe did our best to make the module as compatible as possible but it could always be something does not work as configured in combination with your template. If that is the case, please use the support pages for assistance.


Why do I need BreadCrumbs CSS?

icon 48 moduleWell, you do not really need our BreadCrumbs CSS module but it looks more slick on your website. Breadcrumbs are most of the time boring to see but needed for a good navigation experience for your visitors!

To use some nice animation trics you can integrate CSS declarations into your template style sheets but when you want to use some different animation on other pages it get's a bit harder to do. So why not use a module that does all the work for you? Also you cannot use CSS to "cut-off" the longer breadcrumbs and our BreadCrumbs CSS module can! You can set the maximum length of a breadcrumb before it is "cut-off" by the module and even follow-up characters can be added at the position of the cut-off.

When using our module it is possible to change the Home url or maybe you do not want the Home link to be clickable - so that can be set too. And sometimes the breacrumbs module starts a bit too far to the left in your template. And yes, you can fix that using your template style-sheet but for your convience you can add padding (form the left) from within the module settings. Did we already mention it's fully CSS3 compatible and only loads the needed (read configured) CSS3 style and animations?

As you can read there are some nice reasons why you should try our BreadCrumbs CSS module.

AlertThis module is only supported for Joomla!™ 3.3.x and higher. It does NOT use any javascript functions like our other module called BreadCrumbs Advanced (Plus). There are no plans whatsoever to integrate any javascripts into future releases of this BreadCrumbs CSS module.


Download the module

icon 48 downloadThis module is not a part of any component and can be downloaded from our download section. You can select the Download button and browse for the BreadCrumbs CSS category. That's the category which contains the latest version of the module.

You'll need a BC-CSS subscription if you want to download the module. And ofcourse we'll give you support when you need it! From the moment you've purchased the ReqText plugin you'll recieve full support for one year. This also includes the downloading of new versions and bugfixes for the BC-CSS module. And best of all; you can use the BC-CSS module on any site you develop for the period of a life time!

BreadCrumbs CSS requirements

BreadCrumbs CSS is a module and not a stand-alone component for Joomla!™. The full list of requirements to use this module is:

  • Joomla!™ 3.8 and higher or 4.x and PHP compatible version.
  • Administrator account to login into Joomla!™ for installing extensions.
  • Internet browser that supports CSS3 styling (like the latest FireFox or Chrome).
  • Some reserved module position in your template to set the BreadCrumbs CSS module. :-)

The BreadCrumbs CSS module uses no javascript nor will it add any to your template. The only code that is added to your webpages is the CSS styling set by you in the module configuration. And only the necassary CSS is added to the page so it wil not 'overload' your site and keeps loading fast.


Installing the BreadCrumbs CSS module

icon 48 configYou can install the BreadCrumbs CSS module like any other module in Joomla!™. But for those who haven't done that in a long time, please follow these steps:
 

  1. Login to the backend of your Joomla!™ website using Administrator credentials.
  2. Select in the backend overview the Extensions -> Manage menu option.
  3. Click the Upload Package File tab and click Browse next to the Extension Package file title. Select the BreadCrumbs CSS module package which you have downloaded from our website.
  4. Click Upload & Install to load and install the module.

When everything went well you'll get a nice message "Installing module was succesfull.".


Configure the Basic settings

icon 48 themesWhen you're ready to continue after installing you'll need to configure the module so it displays correctly in the front-end of your webiste. We'll keep it simple so just follow the next steps:
 

  1. Login to the backend using Administrator credentials - if not logged in already.
  2. Select in the backend overview the Extensions -> Modules menu option.
  3. A list of all the installed/used modules is shown. To find the BreadCrumbs CSS module quickly type "bread" into the search field and press Enter.
  4. If the installation of the module succeeded you should see a module called BreadCrumbs CSS. Click on that name to open the module configuration overview.
    The tab Module is default loaded and contains all the basic settings for the module. As you can see some extra settings are present and we advice you to play with these options and check the results in the front-end.
  5. At the right of the screen the Position field is empty. Click it to select (or type) the module position you want to use for the display of the BreadCrumbs CSS module (e.g. position-2).
  6. Below this Position field there's a field called Status which is filled with the Unpublished option. Click this field and select Published.
  7. Open up the tab Menu Assignment and set the Module Assignment to "On all pages". Otherwise no breadcrumbs will be displayed in the front-end.

Update the module

And to make sure you'll receive updates of the module during your subscription period you'll also need to enter the Download ID which you can retrieve from our website. Follow these steps to find the Download ID and enter it at the Update Module tab:

  1. If you're not yet logged in please do so on this website using the Login option at the top of the screen.
  2. After you are succesfully logged in browse to the Personal menu item at the top of the screen and select My Download ID's.
  3. You can create a new ID for each site where you want to use the module. It's wise to create a new ID for websites you do not own (site of your customer) - that way you can keep the Main ID for yourself.
  4. For now we use the Main ID to copy and paste - so select it using the mouse and use CTRL-C or the right mouse button and Copy to copy the ID to your clipboard.
  5. Go back to the backend of your site and browse to the BreadCrumbs CSS Module parameters (like in the steps at the start of this page).
  6. Open the Update Module tab and select the Download ID field. Now press CTRL-V on your keyboard or right-click your mousebutton and select Paste from the opened menu.


save&close Now you can click the Save & Close button to store the settings for the module. The module is now activated, but you should do one more thing before testing it in the front-end: unpublish the default breadcrumbs module by clicking the publish button in front of it in the list.

So, visit your front-end to see if everything is configured correctly. Just browse to some pages on your site to see if the BreadCrumbs CSS module works correctly. And don't worry, it is correct the breadcrumbs look exactly the same as the default module. We haven't set the any special styling yet!

Let's continue, shall we?


How to select a CSS style?

icon 48 bannerWell, you can use a lot of CSS styled breadcrumb effects and there is no better way than showing them instead of describing them.

When you open the module parameters for the BreadCrumbs CSS module there's also a Style options tab present that contains all the settings for the effects. You can set a breadcrumbs style by selecting it using the Select a CSS style dropdown menu. Below this menu you can set all the parameters for the choosen style. 

Because a picture is better than words here's an overview of the possible effects in the BreadCrumbs CSS Module:

Letter-spacingLetter-spacing Text ShadowText Shadow Text GrowText Grow
Text RotateText Rotate Text BlinkText Blink Text RollText Roll
Text CloneText Clone Text BlurText Blur Bounce Up/DownBounce Up/Down
Bounce Left/RightBounce Left/Right ShockedShocked Border FadeoutBorder Fadeout
Border Bottom LeftBorder Bottom Left Shadow DownunderShadow Downunder  
Be aware these animations use full CSS3 styling and are made compatible as much as possible for all browsers. Some effects may behave 'weird' on certain browsers like Internet Explorer/Edge. This has nothing to do with the sample animations above - so we cannot fix that. The only advice we'll give you is to use a CSS3 compatible browser (e.g. FireFox or Chrome).


After you have selected your desired CSS3 style do start playing with the values for the effects. You can set animation speed, animation timing, scale size, opacity, effect color, etc. The specific CSS options only apply to those described in italic below each parameter label.

AlertOne important thing to remember is that the styling of your breadcrumbs are not overruled by the BreadCrumbs CSS Module. So if you experience strange hover effects like different backgrounds, underlines, etc. we advice you to check your template CSS styles where this could be defined for the breadcrumbs or hyperlinks.


Frequently Asked Questions

icon 48 help thisAfter reading this complete manual it could be you still have a few unanswered questions. We've crunched our brains a bit more and started this chapter to help you out. If your question isnt answered in this' FAQ you can always use our support forum.


• The effect of the breadcrumbs does not look like it supposed to?
You should check a few things:

  1. See if any breadcrumbs CSS styles are defined in your template style sheet.
  2. Are you using a browser which is fully CSS3 compatible? We know there are some issues in Microsoft Edge™ and Internet Explorer versions. Also older browser versions are not updated to use CSS3 styling.
  3. Really sure you did set any 'weird' color selection in the module parameters? ;-)


• I cannot see any Breadcrumbs on any of my pages?
There could be multiple reasons for this so check the following:

  1. Is the module Published in the backend?
  2. Did you assign the correct module position to the BreadCrumbs CSS module (template dependant)?
  3. Is the BreadCrumbs CSS module the only one published? If not Unpublish the other ones.
  4. Have you set the BreadCrumbs CSS module to display on all pages on the Menu Assignment tab? If that is set to No Pages nothing shall be displayed in the front-end of your website.

If all of the above is set correctly try reinstalling the module (don't worry all your settings will be as is) and follow the installation steps one-by-one (once again).


• The shadow color is hardly or not at all visible?
Make sure you've set  a contrasting shadow color according to the background color of your template. If you use multiple templates on your site you'll have to add another BreadCrumbs CSS module for the display on the pages with a different template, if you want different shadow colors.

FoolLog iconThe FoolLog component for Joomla!™ 3.3.x is a combination of a component and plugins that can log all sorts of user interaction on your website. With this component it's easy to monitor what's going on on your webiste and keep track of editting history.

Get a bit more in control of your Joomla!™ website by logging important actions made by your managers, authors, editors, publishers and (super)administrators. Or by any other User group you've implemented on your website, for that matter.
A lot of events can be monitored by the FoolLog component because it's using a system and a content plugin to do so. Actions like creating a new article, saving menu-items, login/logout by users, deleting items, installing new extensions are a few examples of what FoolLog can monitor.

Ofcourse the FoolLog plugins can monitor the frontend and the backend of your website. Well, as long as the taken action is supported in the front- or backend, ofcourse.

If your website is maintained by multiple users you can use the FoolLog component to keep track of (editting) history. What is done and by whom? But you do not have to be a multinational company to use this component. Do you run your website by yourself or maintain multiple website on your own? Then use FoolLog for your own maintance history!

Or can you remember everything you did on your website(s)?


Why do a I need a license to use FoolLog?

icon 48 statsDeveloping a component and plugins on this scale consumens a lot of development time. And ofcourse it's always nice to enjoy good extensions without any purchase costs but to keep this a high quality extension more time needs to be invested in the future.

The costs for a license of the FoolLog component aren't that high if you can easily track errors, see user search statistics or who installed what extension. You even get a full year of free support through our Ticket System and a full year of free updates for the component! Also you can download addons, plugins for third party components to log in the near future.

The costs for the FoolLog license are € 45,00 (without tax) and you can download the component instantly after your paypemt is received. By the way, you can use the component for an unlimited time and on any website you develop/install. As mentioned it gives you a full year access to our Ticket Support system for the FoolLog component.

AlertThis component is only supported for Joomla!™ 3.4 and higher and PHP 5.4 and higher. We cannot support any help requests if your below one of these versions. Be sure your hosting provider has the correct versions installed.


Download the component

icon 48 downloadThis component can be downloaded from our download section immediately after you've subscribed for the FoolLog license. You can select the Download button and browse for the FoolLog category. That's the category which contains the latest version of the component, ofcourse.

Download the component by selecting the latest version and install it like any other Joomla!™ Extension.
 

FoolLog requirements

FoolLog is a stand-alone component for Joomla!™ and by default it installs two plugins; a system plugin and a content plugin. The requirements to use this component are:

  • Joomla!™ 3.4 or higher.
  • PHP 5.4 or higher.
  • Administrator account to login into Joomla!™ for installing extensions.
  • Internet browser that supports CSS3 styling (like the latest FireFox or Chrome).
  • A little experience with the configuring of plugins.

The FoolLog component and it's plugins should function correctly with:

  • Joomla!™ 3.4, 3.5, 3.6 and 3.7
  • PHP 5.4, 5.5, 5.6, 7.0 & 7.1.

AlertIf you encounter any problems downloading or installing the component on one of the above given versions, please use the Ticket Support forum to get our help. We'll try to solve the issue(s) as soon as possible.


Installing the FoolLog component

icon 48 configYou can install the FoolLog component like any other extension in Joomla!™. But for those who haven't done that in a long time, please follow these steps:
 

  1. Login to the backend of your Joomla!™ website using Administrator credentials.
  2. Select in the backend overview the Extensions -> Manage menu option.
  3. Click the Upload Package File tab and click Browse next to the Extension Package file title. Select the BreadCrumbs CSS module package which you have downloaded from our website.
  4. Click Upload & Install to load and install the module.

When everything went well you'll get a nice message such as "Installing of component was succesfull".

Also installed is a System - FoolLog plugin and a Content - FoolLog plugin. These are activated automaticly after the succesfull installation of the FoolLog component package. If not it's reported when installing the FoolLog package and you'll have to Enable them manually.


Configure the FoolLog settings

icon 48 themesWhen you're ready to continue using the component you'll need to configure the System - FoolLog plugin so it knowns what to log in your Joomla!™ environment. We'll try to keep it simple so just follow the next steps to get into the configuration options:
 

  1. Login to the backend using Administrator credentials - if not logged in already. tab plugin
  2. Select in the backend overview the Components -> FoolLog menu option.
  3. On the top right of your screen you click the log settings button button.
  4. What you'll see is a page with several tabs containing the log configuration settings:
      tab user tab extension tab save tab publish tab delete tab search 

The configuration tab's will be described in detail on the next pages of this documentation. After you've set all the settings to your needs you clearly have to click save and close button to save your work.


Plugin tab

tab pluginThe first tab called "Plugin" contains the settings for the Joomla!™ default notifications/exceptions thrown by Joomla!™ itself and 3rd party components.

The Joomla!™ notifications/exceptions are those nice colored bars which appear when you've for instance saved and article or when some function isn't working on your site. They look a lot like this:
message noticenoticewarning messageerror message

And this is what the settings do (most titles says it all):

  • Log Joomla! notifications: you can activate the notification logging by selecting each seperate option and set this option to Yes. If this option is set to No none of the notifications are logged by the FoolLog plugin.
     
  • Log Message notifications: will log any message notification.
  • Log Notice notifications: will log any notice notification.
  • Log Warning notifications: will log any warning notification.
  • Log Error notifications: will log any error notification.
     
  • Log notifications in: log in the frontend only, in the backend only or log on both sides.

AlertIt is our strong advice to only log for Warnings and/or Errors to prevent database clutter and slowing down the loading of your website. If you really, really, really need to log the Messages and Notices you can better do so for a very short period of time!

 

User Logging tab

tab userAll the log settings concerning users can be set on this tab. Let's describe shortly what they'll do:

  • Log Usernames: should the username be stored in the log records?
  • User passwords: should the user password be stored in the log records (only when wrong password is entered)?
  • Succesfull login: log a succesfull login?
  • User logout: log a user logout?
  • User registration: log if a user has registered on your site?
  • User save: log if user details are editted/updated/saved?
  • User delete: log if a user is deleted/trashed?
     
  • Usergroup save: log if a usergroup is editted/updated/saved?
  • Usergroup delete: log if a usergroup is deleted/trashed?
     
  • Log notifications in: log in the frontend only, in the backend only or log on both sides.

All logs will contain time, date, username, article/extension title, etc. so you can always check who-did-what.


Extension Logging tab

tab extensionOnly a few settings for extensions can be set here. And the logging only applies to the backend because you cannot manage extensions from the frontend of a Joomla!™ website.

  • Extension installation: should the installation of extensions be logged? This includes Plugins, Modules, Packages, Libraries, etc.
  • Extension uninstallation: should the uninstallation of extensions be logged? Also this includes Plugins, Modules, Packages, Libraries, etc.
  • Extension update: should extension updates be logged? Also includes.... ya know...

 

Save Logging tab

tab saveA lot of items can be set here to check when they are saved or better said saved or updated. Most of the settings are pretty straight forward and we'll not describe them seperatly otherwise we'll keep on repeating ourselfs ;-)
The sum of all options results in the following:

  • Article, Category, Menu item, Banner, Contact, Usernote, Newsfeed, Redirect, Smart Search, Tag, User Acces Level save: logs all save/update state for all of these items.
  • Module save: will log save/update sate for a module configuration.
  • Plugin save: will log save/update state for a plugin configuration.
  • Style save: will log save/update state in template style configuration.
  • Language save: will log save/update state for language configuration.
  • Component options save: will log save/update state for component options.
  • Field and Field group save: logs all save/update state for all of these items [Joomla!™ 3.7 and higher only].
     
  • Log content save in: log in the frontend only, in the backend only or log on both sides.

All logs will contain time, date, username, article/extension title, etc. so you can always check who-did-what.


Publish/Unpublish Logging tab

tab publishYour Joomla!™ website can show content if it's set to published and hide the content when it's set to unpublished. To see who set any content item to a published or unpublished state you can use the options in this tab.
To prevent a complete a self repeating list we only describe the common options in a sort of one-liner and describe the other special ones seperatly:

  • Article, Category, Menu, Banner, Contact, Usernote, Newsfeed, Redirect, Smart Search, Tag, Plugin, Module, Language (un)publish: log the state of the content item in the FoolLog component.
  • Field, Field group (un)publish: log the state of the field items in the FoolLog component [Joomla!™ 3.7 and higher only].
     
  • Log state changes in: log in the frontend only, in the backend only or log on both sides.
     
  • Extension (un)publish: this is a special feature added for the FoolLog component. Joomla!™ has not a build in "dispatch-function" for extensions to get the publish state. So we've added one ourselves. Please do read the caution message if you encounter any problems logging for the publish state of extensions. This option will log the publish state of Extensions.
  • Update site (un)publish: this is a special feature added for the FoolLog component. Joomla!™ has not a build in "dispatch-function" for Update sites to get the publish state. So we've added one ourselves. Please do read the caution message if you encounter any problems logging for the publish state of Update sites. This option will log the publish state of Update sites.

All logs will contain time, date, username, article/extension title, etc. so you can always check who-did-what.


Delete/Trash Logging tab

tab delete When your editors remove an article or any other content most of the times it get's "stored" as trash so you can, in case of any mistake, retrieve them back from this Trash state. It's nice to know if an article (or any other content item) is trashed or deleted and when that happend.

  • Article, Category, Menu, Banner, Contact, Usernote, Newsfeed, Redirect, Smart Search, Tag, User Access Level remove: log if one of these items are trashed, archived or deleted.
  • Module remove: log if a module is trashed, archived or deleted.
  • Style remove: log if a template style is deleted.
  • Language remove: log if a content language is trashed or deleted.
  • Field and Field group remove: log if one of these items are trashed, archived or deleted [Joomla!™ 3.7 and higher only].
     
  • Log content delete in: log in the frontend only, in the backend only or log on both sides.

AlertNotice: the FoolLog component cannot restore any trashed or deleted Joomla!™ content item. It will only log if one of these actions are performed.

 

Search Logging tab

tab searchAlways wanted to know what search words (or phrases) your users are looking for on your site? Ever wondered you need a different article title so users do not have to use the search function every time they want to read something? Well, start logging what your users are searching for by activating the log options here!

  • Search in frontend: will log any search word/phrase and record information about the user (if a user is logged in, ofcourse).
  • Log searches in: well, this can only be done in the frontend, so nothing to set here (added for future use).

 

AlertThis option will log ALL user search words/phrases. It's not fool proof and will clutter your database. For security reasons a small delay before logging the next search attempt is build into the plugin to prevent a log overflow.
It is our advice to log for searches only for a small amount of time (a few days or one week) to keep your website performance at a high level.


FoolLog Updates

icon 48 clearIf you have a FoolLog subscription you want to be sure you can access the updates released for a the component a whole year long! To do so you'll have to enter the Download ID which you can retrieve from our website. Follow these steps to find the Download ID and enter it at the Update Module tab:

  1. If you're not yet logged in please do so on this website using the Login option at the top of the screen.
  2. After you are succesfully logged in browse to the Personal menu item at the top of the screen and select My Download ID's.
  3. You can create a new ID for each site where you want to use the module. It's wise to create a new ID for websites you do not own (site of your customer) - that way you can keep the Main ID to yourself.
  4. For now we use the Main ID to copy and paste - so select it using the mouse and use CTRL-C or the right mouse button and Copy to copy the ID to your clipboard.
     
  5. Go back to the backend of your site and select FoolLog component from the Components menu at the top of the backend page..
  6. Select in the right corner of your browser window the options button button.
  7. Select the Download ID field and press CTRL-V on your keyboard or right-click your mousebutton and select Paste from the opened menu.

Now you can click the save and close button button to store the settings for the component. The updates for the FoolLog component can now be downloaded and installed using the Joomla!™ update function.


Let's get started.

icon 48 bannerAssuming you've set all configurations items to your needs the logging is already started on your website! To let you taste a bit of what is possible we've taken some screenshots from our test environment to show you what data FoolLog can collect for you.

First open the FoolLog component page:

  1. Login to the backend using Administrator credentials - if you're not logged in already.
  2. Select in the backend overview the Components -> FoolLog menu option.

Now you have arrived to the FoolLog component page. It'll give you an overview of all logged items sorted on date (if you've set the loggin settings correctly, ofcourse).

com overview01

 

The buttons

We'll go over each part of the overview to explain what you're looking at. First we start with the FoolLog component buttons: Archive, Trash, CSV Export and Purge.

Archive
You need to make a selection log records first before you can use this button. Your records will be removed from the overview list but not deleted nor trashed either. The records are set to an archive state - hidden but recoverable. For further details how this archive works we advise you to check this link: Moving an Arctile to the archive.
Trash
Well, you can put the records you do not need into the trash can. It works a bit like the trash under your desk, you can throw something in it but you can grab it back out in case you've made a mistake. If you want to know how to use the trash and restore function in your Joomla!™ website  you could check this link: How to manage trash and restore.
CSV Export
It could be possible you want to use the log records in your own analysis using Excel or any other software package which supports CSV import. Than this button comes in handy! Well, explain it better in this manual at chapter CSV Export.
Purge
After a period of logging you might want to clear the logging records from certain dates or types. This is where the Purge button comes in. Further explanation can be found in chapter Purge Records.
Download CSV
Only when you've created an export file using the CSV Export button this button will appear: download csv button. When you click the blue part of the button it will - how convieniant - start the download of the export file you created with the export button. If you do not want to keep the export file on your online server you'll have to click the orange part, the minus, to delete the file on your server.
You can always create a new export file by using the CSV Export button, ofcourse.

At the right of your screen you see the buttons: Log Settings and Options. These represent the options for the component and what should be logged by the system and content plugins.

Log Settings
This option is already explained in the chapter Configuration settings. So, if you want any more info about this button - please read it (again) in this manual.
Options
The component options button contains only your Download ID field when you've got a FoolLog subscription. How to fill it is explained in chapter Update settings in this manual.

 

Filters

At the left of the screen you can see two page options: FoolLog Overview and FoolLog Statistics. The first is the page you're looking at when starting the FoolLog component and the second is a little overview of log statistics.
Below these options the filters are shown. It should all work familiar like other Joomla!™ components you're using.

- Select Status -
Filter the overview on the status of log records which can be Archived, Trashed or All.
- Select Category -
Filter the overview on the category of log records. Only categories which are logged will be shown. So if nothing is logged for let's say the category Install this category isn't shown in the filter list.
- Select Logtype -
Filter the overview on the logtype of log records. This can be used to show all items with a Save logtype to see what's created lately.
- Select Priority -
Filter the overview for al log priority. This can be named Info (most used), Warning, Failure or Error. These priorities are used for matching log records ofcourse. When anything goes (a bit) wrong it will be logged as Warning, Failure or Error and anything else will be logged as Info.
- Select Site End -
Filter the overview of log records for the frontend or backend log records only.
Clear Filters
To reset all filters you can use this button. The overview will show all log records again.

The remaining items of the FoolLog overview are self explaing (most of it). Use it like any other view in a Joomla!™ component with one exception: you cannot edit a logged record - there's no point in doing so because you need the actual log data.

TagAlthough you cannot edit a log record you can always click on the plus icon with your mousebutton.You'll see a little dropdown with more information about the log. You can even find which options for a component is changed! Ain't that a nice feature?

 


Export log records to CSV

Sometimes you'll need the log data in another way than the FoolLog component can provide. This is where the CSV Export button is created for.
This function will generate a default CSV (text)file where you can set the delimiters and enclosed characters to your preferences. The format complies to the definitions as described on the Wikipedia page CSV (comma-seperated values).

When clicking the CSV Export button a popup window will appear that looks like this:

exportcsv popup

Columns separated with
Here you can set the field seperation character. Default it's a comma but if you need another character you can change it here.
Columns enclosed with
This is the character which will be used to enclose your field values. It's highly recommended to use this option because exported fields contain mostly more than one word. This option will keep it 'together' when exporting/importing.
Columns escaped with
This character is used to escape special characters used in the export fields. For instance the field:  "Isn't exporting great?" will result in "Isn\\'t exporting great?" (assuming you're using the default escape characters).
Put column names in 1st row
Most of the import programs require a complete field naming list at the top of your CSV export file. It's default set to "Yes" so that's include by default. Select "No" if you want to leave the column export names out.
Export 'extra' DB-field
The FoolLog database table contains an extra information field with data which isn't fully shown in the backend view. Here you can choose to export that field to your CSV file.
Export filename (readonly)
This field only shows you the name of the CSV export file as it is used by the FoolLog component.
Save path (readonly)
This field shows you the save path used by the FoolLog component. This is the folder/directory where the FoolLogCSVExport.txt file is stored.

 

Export selection

The selection fields at the left of the popup window give you the abillity to choose what type of logs must be exported.

Categories to export
This is where you select what log categories you want to export. You can select multiple categories. Leaving this field empty will export ALL categories.
Log types to export
The log types can be selected for export. You can also select multiple log types but leaving this field empty will export ALL log types (if they are linked to the selected categories).
Site End to export
Here you can select to export only log records for the front-end or back-end. Leaving this field blank will export records for the front-end AND the back-end.

TagLeaving one of the fields empty means all types are exported depending on the previous selected field. For instance: when you select Content in the category field this will be the main field for the export query.
When you've also selected options in the log type field this field will be used for the second condition in the query. If no result is found for the Log type field only the export of the category values will be the result. The third query option used is the Site end field which only returns results in the front-end, back-end or both.

So, all that is left to do when you've set you export settings; click the export button button to start the export. After the export is succesfull you can download the CSV by clicking the download csv button button (the blue part of the button that is). If the Download CSV button is not shown you can try to refresh your webpage using F5 on your keyboard. The button still not visible? Than something has gone wrong with the export, please check folder rights on your website.


Purge log records

A separate button to purge FoolLog records? That's weird, we can just trash items and than delete them, isn't it?
Yes, so true but this purge option gives you more and faster control which records should be deleted. Be aware, we're talking about DELETING and not TRASHING!

Clicking the Purge button will result in a popup like the one below:

purge popup

Begin date
Select the start date for the FoolLog records to be deleted. Clicking the calendar icon will open a nice calendar for easy selecting the correct date.
End date
Select the end date for the FoolLog records to be deleted. Clicking the calendar icon will also open a popup calendar for you to select a date.

Click the purge button button to start the deleting of records with the dates you've set.export. If the purge isn't working as you've expected please make sure you've set the dates correctly.

TagWhen you execute the purge command all logs in the selected date range are permantly, indefinitly and really gone! There's no other way of getting that data back unless you have a backup from your database (recently made).

*** UWiX cannot be held responsible for any loss of log data on your website ***


Filter overview on date

We've added an extra filter options for the log overview. The abillity to filter on certain dates so you can narrow logged actions down to, let's say, a single day or week.
The fields needed for this are at the top of the toolbar next to the search bar. So let's see how it works:

filter bars

 

 

Begin date
Select the date where the FoolLog records listing should start. Clicking the calendar icon will open a nice calendar for easy selecting the correct date.
End date
Select the date where the FoolLog records listing should end. Clicking the calendar icon will also open a popup calendar for you to select a date.

Click the filter btn button to start viewing the filtered list with the dates you've set.export. If the list isn't working as you've expected please make sure you've set the dates correctly or try it again by resettig the filter with the reset btn button.

Now the view is adjusted to the dates you've set to filter. That way you can check what things are logged during a certain period.


Statistics

 You can also select another FoolLog page by clicking FoolLog Statistics at the left of your screen. This will open some graphs which can show you some statistics which are logged over a longer time period.
8 statistics

At the left of the screen you can see two page options: FoolLog Overview and FoolLog Statistics. Below these options the filters are shown. It should all work familiar like other Joomla!™ components you're using.

- Select Category -
Filter the overview on the category of log records. Only categories which are logged will be shown. So if nothing is logged for let's say the category Install this category isn't shown in the filter list.
- Select Year -
Filter the overview on the selected year of log records. Only available if any log records are present and ofcourse logs for multiple years should be logged in those years by the plugins.
- Select Month -
Filter the overview for a selected month of the selected year. This option will only show records if the log records match the month and year selected. If nothing is shown in the graphs it's most likely no logs for the selected date are present.

Then there are two more icons at the top of the graphs graphs.  That's where you can select the graph type for the bottom graph. The year overview graph can only be shown in a bars-like style.
And that's all you can do in the Statistics page for now. But if you do have suggestions please post them as a suggestion in the FoolLog Support Forum so we could put it on our feauture-implementation list.


What can be logged using FoolLog?

icon 48 menu addThe FoolLog component can log over 65 Joomla!™ user actions or messages. And when possible we'll implement the Log capability for our future extension too. The HitZero plugin can already be logged using FoolLog.
In the future we'll release plugins to log 3rd party extension actions. When you've a FoolLog subscription you can download these plugins to enhance the logging of your website.

 

 Joomla!™ actions

ComponentResourceLogged actionsFrontend or backend
Global Notifications Message, Notice, Warning & Error notifications Both
Users    User Login, logout, registration, add, edit, remove Both
Usergroup Add, edit, remove Backend
User Note Add, edit, remove Backend
User Level Add, edit, remove Backend
Field Add, edit, remove, trash, archive, publish and unpublish Backend
Field Group Add, edit, remove, trash, archive, publish and unpublish Backend
Installer Extension Installation, uninstallation, update, publish 1, unpublish 1 Backend
Update Sites publish 1 and unpublish 1 Backend
Content Article Add, edit, remove, trash, archive, publish and unpublish Both
Featured Article Add, edit, remove, trash, archive, publish and unpublish Both
Field Add, edit, remove, trash, archive, publish and unpublish Backend
Field Group Add, edit, remove, trash, archive, publish and unpublish Backend
Categories Category Add, edit, remove, trash, archive, publish and unpublish Backend
Menus Menu Add 2, edit 2, remove 2 Backend
Item Add 2, edit 2, remove, trash, publish and unpublish Backend
Banners Banner Add, edit, remove, trash, archive, publish and unpublish Backend
Client Add, edit, remove, trash,archive, publish and unpublish Backend
Contact

Contact Add, edit, remove, trash, archive, publish and unpublish Backend
Field Add, edit, remove, trash, archive, publish and unpublish Backend
Field Group Add, edit, remove, trash, archive, publish and unpublish Backend
News Feeds News feed Add, edit, remove, trash, archive, publish and unpublish Backend
Redirects Redirect Add, edit, remove, trash, archive, publish and unpublish Backend
Smart Search Search Filter Add, edit, remove, publish and unpublish Backend
Tags Tag Add, edit, remove, trash, archive, publish and unpublish Backend
Modules Module Add, edit, remove 2, trash 2, archive, publish and unpublish Backend
Plugins Plugin Edit, publish and unpublish Backend
Templates Style Add (copy), edit, remove Backend
Languages Content Language Add, edit, remove, trash, publish and unpublish Backend
Config Component Edit Backend

 

 UWiX extensions

ExtensionResourceLogged actionsFrontend or backend
HitZero Arcticle Hits reset Backend

 

 3rd party extensions

ExtensionResourceLogged actionsFrontend or backend
Advanced Module Manager
by Regular Labs
Modules Add, edit, remove, trash, archive, publish and unpublish Both
JDownloads by Arno Betz Categories Add, edit, remove, publish and unpublish Backend
Downloads Add, edit, remove, publish and unpublish Backend
Licenses Add, edit, remove, publish and unpublish Backend
Templates Add and edit Backend
User groups Edit (log changes) Backend
JEvents by GWE Systems Ltd. Events Add, edit, remove, publish and unpublish Backend
Event repetitions Add, edit and remove Backend
Event Translations Add and edit Backend
JoomShopping by MAXXmarketing GmbH Addons Install and uninstall Backend
Categories Add, edit, remove, publish and unpublish Backend
Configuration Update (also for Config SEO and config Static Page) Backend
Coupons Add, edit, remove, publish and unpublish Backend
Currencies Add, edit, remove, publish and unpublish Backend
Delivery Times Add, edit and remove Backend
Manufacturers Add, edit, remove, publish and unpublish Backend
Orders Add, edit and remove Backend
Order Status Add, edit and remove Backend
Payment methods Add, edit, remove, publish and unpublish Backend
Products Add, edit, copy, remove, publish and unpublish Backend
Shipping methods Add, edit, remove, publish and unpublish Backend
Shipping Prices Add, edit and remove Backend
Taxes Add, edit and remove Backend
Users Add, edit, remove, enabled and disable Backend
User groups Add, edit and remove Backend
Kunena by Team Kunena Attachments Upload, remove Both
Categories Add, edit, remove, publish and unpublish Backend
Topics/Replies Add, edit, trash, restore, remove, sticky, unsticky, lock and unlock Frontend
Userprofiles Update Frontend
ZOO by YOOtheme Items Add, edit, remove, publish and unpublish Both
Categories Add, edit, remove, publish and unpublish Both
Comments Add, remove, approve and unapprove Both

1This is an override function - please read the red caution box in the plugin configuration on the Publish/Unpublish tab.
2 Only supported when using Joomla!™ 3.4 or later.

 


Frequently Asked Questions

icon 48 help thisAfter reading this manual it could be you still have a few unanswered questions. Maybe this chapter can help you a bit. If your question isnt answered in this FAQ you can always use our support forum.


• The plugins does not seem to work?
You should check a few things:

  1. Did you Enable the Content - FoolLog by UWiX plugin in the backend?
  2. Did you enable the System - FoolLog by UWiX plugin in the backend also?
  3. Have you done any action that should be logged like saving an article?
  4. Have you changed any user rights to prevent any logging for a certain user(group)?

 

• The Download CSV button is missing.
The Download CSV button will only be shown if a exported file is available for download. This will only be the case if you've pressed the CSV Export button earlier.

If clicking the CSV Export button does not show the Download CSV button, please check the following:

  1. Be sure the website has write permissions on the media/com_foollog/export folder.
  2. Does the current user has any right limitations for creating an export file?.

 

 • When installing an extension multiple logs are created, why?
Extension packages can contain multiple installation files for seperate plugins/components/modules. So it is very likely possible such installation logs multiple installed packages. This is also the case when installing a new language in your Joomla!™ website.

So don't worry, the FoolLog plugins does the job correctly. Now you know exactly what is installed in your Joomla!™ website for any package.

 

 • Will FoolLog work in Joomla!™ 4?
We've already tested the installation and usage of the FoolLog component and it's plugins in the Joomla!™ 4 public Alpha release and all seems to work fine.

We will keep on testing every new release in Joomla!™ version 4 but we can only guarantee it'll work perfectly when the final release of Joomla!™ 4 is released. Only than it's possible to adjust code so everything will work as it should in this new Joomla!™ version.

 

Subcategories