Installation / update
What are the system requirements?
- Joomla 2.5 or 3 fully and correct installed
- PHP 5 or later
Error: 'Could not create directory, Warning! Failed to move file'
Check your directory premissions:
'help' > 'System info' > 'Directory Permissions'
All least these folders should be writeable:
- administrator/components/
- administrator/language/en-GB/
- plugins/system/
- tmp/
You can also enable the FTP layer and try to install again.
Error: 'Path does not point to a valid folder' 'Could not find a Joomla! XML setup file' 'File...does not exist'
You are probably dealing with a corrupt download. Both Symantec and McAfee are known to corrupt downloads with certain settings. They can also corrupt the extensions send and received by email. So try this: go to the download area, disable the firewall/virusscanner, download the file, enable the firewall/virusscanner.
How to install?
- Download the latest version of the component.
- Go to 'Extensions' > 'Manage' > 'install'.
- Click 'browse' and select the file which you just downloaded.
The file name starts with 'com_adminhelppages'. - Click 'Upload File & Install'.
The extension is being uploaded and installed.
Installed will be:
- component Admin-Help-Pages
- plugin system - Admin-Help-Pages
If the plugin is not installed (probably wrong folder rights for /plugins/system/) download the plugin and install separately.
How to update?
- Download the component.
free-version trial-version
pro-version - Install the component over the old component (no need to uninstall first).
This will also update the Admin-Help-Pages system plugin.
Do I lose my settings and configuration when updating or upgrading?
No. All configuration and settings will remain in the database.
If you are updating from free- to trial-version, or trial- to pro-version, just install the new version over the old version.
End faq
Configuration
How to link a help button to a help page?
If you want to link a specific help button from a toolbar on an admin-page to a help-page
- Open the 'Help Button Manager'
components > Admin-Help-Pages > Help Button Manager - Find the adminpage the help button is on and click in the 'action' column.
A modal window opens. - Select 'link help button to help page'.
- Select the help pages in de dropdown.
- Click 'save'.
If the admin page is not in the list of admin pages, you can add it by clicking on 'new'.
How to hide a help button?
If you want to hide a specific help button from a toolbar on an admin-page:
- Open the 'Help Button Manager'
components > Admin-Help-Pages > Help Button Manager - Find the adminpage the help button is on and click in the 'action' column.
A modal window opens. - Select 'hide help button'.
- Click 'save'.
If the admin page is not in the list of admin pages, you can add it by clicking on 'new'.
Help button does not hide / 2 help buttons / button link incorrect
First make sure you are setting actions for the correct page. Actions set on a more specific url override actions set on a less specific url. Example:
when on this page:
option=com_menus&view=items&menutype=usermenu
the actions set for the above url will overrides actions set on this url:
option=com_menus&view=items
So in the 'Help Button Manager' make sure there is no other action set which might be overriding the url you are trying to set.
Second, if the action is set 'per usergroup' please read this FAQ.
Third. If none of the actions as set in the 'Help Button Manager' seem to work on pages from one (3rd party) component, but they do seem to work on other pages (like the article manager). It is porbably because that component has coded that help buttonin a not so Joomla friendly way. In that case, the script needs help to identify the help button. Please enter the URL of the page the help button is linking to in the action modal window.
Setting help-button actions per usergroup
In the 'Help Button Manager' the help button action for an admin page can be set to 'per usergroup'. For each usergroup an action can be set. If an admin-user is assigned to more than one usergroup (check page 'users' for that), the action associated with the top usergroup of the user assigned groups is executed. You can set the order of the groups in the configuration. You will probably want the most important groups at the top.
End faq
Pre/post sale
On how many websites can I use the pro-version?
There is no limit. Use it on as many sites as you like.
Is the pro-version encrypted?
no.
Does the pro-version need Ioncube?
No. The pro version is un-encrypted and does not need Ioncube. Only the trial version is encrypted. The free and the pro-version are not encrypted and do not need Ioncube on the server.
Is there a trial-version available?
No. You can try the free version. It shows in red which functionality would work in the pro version. Which will give you a pretty good idea of how this could work on your site.
free-version pro-version, what is the difference?
free | pro | |
---|---|---|
number of help pages | 5 | no limits |
I purchased this extension, how to download?
After payment is confirmed you login and click in the right column on 'my extensions'. Then click on your purchase and download the files.