USER MANUAL - Magento Extensions by Fooman · PDF fileWe do not recommend using Fooman...
Transcript of USER MANUAL - Magento Extensions by Fooman · PDF fileWe do not recommend using Fooman...
USER MANUALFooman Speedster Advanced (Magento 1)
User Manual Quick Links
1. Installation2. Set up in Magento3. Troubleshooting
You can use these quick links, and the links on the left sidebar to navigate quickly around this User Manual.
3. T
ROUB
LESH
OOTI
NG1.
INST
ALL
2. S
ET U
P IN
MAG
ENTO
1. INSTALLATIONUltimate Guide to Installing Magento Extensions
Refer to The Ultimate Guide to Installing Magento Extensions and follow the installation steps. This best practice guide contains universal instructions for a smooth, trouble free installation of any Magento extension.
Additional InstructionsThe following additional instructions also apply to installing Fooman Speedster Advanced:
● If you have the classic Fooman Speedster extension installed, please uninstall it● Optional but highly recommended – implement the suggestions provided by
System > Tools > Theme Optimiser (if you use Magento 1.4, see the Notes section for guidance on how to achieve the same effect manually)
● If you use CANONICAL URLs by Yoast (v1.3 and below) or JQUERY BASE by Mxperts, refer the workarounds in the Fooman Support Centre
Is Fooman Speedster Advanced right for my Store?Fooman Speedster Advanced is a free extension which has been tested with the default Magento themes. However, there is always a risk that minifying and combining Javascript files can produce Javascript errors.
We do not recommend using Fooman Speedster without thorough testing on a test site if:
● Significant Javascript customisation work has been done on your store and the added non-default Javascript files do not follow best practice Javascript (you can test with http://jslint.com/)
● Your store already contains minified files● Your store uses Jquery (or has extensions installed which use Jquery) - although a
workaround is provided, almost 100% of reported errors are from stores which also use Jquery
Page 2
3. T
ROUB
LESH
OOTI
NG1.
INST
ALL
2. S
ET U
P IN
MAG
ENTO
Go to System > Configuration > Developer to get started.
1. Javascript Settings
Merge JavaScript FilesSelect “Yes” to enable merging of Javascript files under 'JavaScript Settings'.
Exclude from MinifyThis field allows you to exclude specific file(s) from the minification process, while still including the merged file in the original file loading order. It's not possible to exclude entire file directories.
Enter the relative URL of any Javascript files that you wish to exclude, separated by a comma. For example: To exclude the following file http://www.example.com/skin/frontend/base/default/js/opcheckout.js, enter skin/frontend/base/default/js/opcheckout.js
The default setting is to exclude js/mage/adminhtml/sales/packaging.jsbecause this known to cause issues. We recommend that you keep this as a default exclusion (you can still add additional exclusions).
TroubleshootingCertain files can cause issues when being minified and you want to exclude them from minification. A non-exclusive list of reasons include:
● Trying to minify already an minified Javascript file● Javascript which isn't coded nicely (eg. not using semi-colons and instead relying on implied
linebreaks for functionality – read more more on jslint.com) ● Using another Javascript library in addition to Magento's prototype library (eg. Jquery)
Page 3
2. SET UP IN MAGENTO
3. T
ROUB
LESH
OOTI
NG1.
INST
ALL
2. S
ET U
P IN
MAG
ENTO
2. CSS Settings
Merge CSS FilesSelect “Yes” to enable merging of CSS files under 'CSS Settings'.
Exclude from MinifyThis field allows you to exclude specific file(s) from the minification process, while still including the merged file in the original file loading order. Enter the relative URL of any CSS files that you wish to exclude, separated by a comma. It's not possible to exclude entire file directories.
Developer ModeIn Magento’s developer mode, Speedster Advanced will include the file names of the merged files in the combined output for easier troubleshooting.
Page 4
3. T
ROUB
LESH
OOTI
NG1.
INST
ALL
2. S
ET U
P IN
MAG
ENTO
Theme OptimiserWith version 1.4 Magento introduced the concept of static vs skin files (internally). The distinction is made as follows:
Speedster Advanced uses this internal distinction to separate the files into two files. The idea behind this is being able to load all library files and other files which you will require throughout the whole store only once. It is best described with an example. Imagine a customer visiting consecutive pages on the store:
To benefit from this Speedster Advanced feature you will need to optimise your theme. Everything that you want to have loaded on every page should reside in the /js folder (think libraries) and loaded via the default handle. All remaining files should live in the skin directories and included via a skin_js directive.
Currently the same separation does not make as much sense for CSS. Our current advice is to load all CSS as skin_css on the first load.
Page 5
3. T
ROUB
LESH
OOTI
NG1.
INST
ALL
2. S
ET U
P IN
MAG
ENTO
For FAQ and troubleshooting issues, please visit the Fooman Support Centre. You will find instructions on how to disable and uninstall Fooman Speedster Advanced, workarounds, and other troubleshooting advice.
Reporting BugsPlease note that we are unable to provide individual support for free Fooman extensions.
You can post a bug here. Before posting comments, please:
● Ensure you have read and followed all instructions and troubleshooting advice carefully● Clearly state at which stage of the installation process you are running into trouble (the
net tab of the firebug firefox extension is generally helpful in finding out what is not loading correctly).
Page 6
+ MORE
3. TROUBLESHOOTING