The configuration is read from app/code/local/Elite/Vaf/config.ini. We use the ini configuration format.
A default file is located in Vaf/config.default.ini - you should copy this file & rename to config.ini, and edit the settings as you desire.
Where possible, a comment (prefixed with a semicolon ';') will appear describing a setting, within the config.ini. For a full description of a setting, please refer to this extended configuration guide.
Controls how the extension modifies your category pages. Also see related settings homepagesearch/exclude_categories and categorychooser/ignore which are settings that control behavior related to categories on other store pages.
disable - Disable filtering on all category pages.
This is if you want the vehicle search to "be seperate" from your main store, for "window shopping" style. If disable is set to true, the extension will provide the make/model/year search form and filter on all category pages by default, unless white/black listing is in effect.
Example usage: disable = true
mode - Change the category mode for when user clicks through to a category page.
Defaults to "default". Alternatively specify "group" for 'group view' on every category page.
whitelist - Allows you to control for which categories filtering is enabled. Should be a comma separated list of category IDs.
blacklist - Allows you to control for which categories filtering is disabled. Should be a comma separated list of category IDs.
For instance if only one of your categories is applicable to the make/model/year search. Works according to these rules:
- If whitelisting is specified, and the customer is on the category specified, the they will see the filter.
- If blacklist is specified, and the customer is on the category specified, the they will not see the filter.
- If neither is specified, the value of "disabled" will control wether the customer will see the filter.
whitelist = "4,3,2"; only enable the search on this category
blacklist = "1,2,3" ; do not enable the search on this category
requireVehicle - Allows you to require user to select a vehicle before seeing products. Should be a comma separated list of category IDs. Optionally set to "all" to match all category IDs.
requireVehicle = "1,2,3"
requireVehicle = "all"
The splash page that is shown can be edited in vaf/splash.phtml
Control how the extension's front-end search functionality works for the customer
loadingText - text to show in the drop-down while the ajax is processing
Set text you want to appear in each dropdown while the ajax is loading, if left blank or ommited defaults to "loading". You may set it to an empty string ("") to have no loading text.
- searchButton - Changes the operation of the submit button. Defaults to "button". Set to "button" to show a submit button. Set to "link" to show a submit link. Set to "hide" and there will be no submit button (it will auto-submit after any change of vehicle).
- clearButton - Changes the clear button. Defaults to "button". Set to "button" to show a clear button. Set to "link" to show a clear link. Set to "hide" and there will be no clear link.
- defaultText Text to use as the default option prompting user to make selection. Defaults to "-please select-" if you do not override it. Use %s to put the current level. Example "- Pick %s -" will cause each drop down to read "- Pick Make -", "- Pick Year -",etc.
- labels Set to false if you don't want labels in front of the select boxes. Defaults to true.
unavailableSelections - What to do with unavailable selections? show, hide, disable. Default = show.
Before the user completely makes all selections you have several drop downs that are just blank. Several popular automotive shops have the feature for drop downs to be "hidden" or disabled before the selection is ready. Set this option to "show", "disable", or "hide". If you do not set it, it will default to "show".
insertBrTag - Wether or not to insert a <br /> tag between each level. Set to true/false. Defaults to true.
loadingStrategy Loading strategy (ajax/non ajax). Defaults to "ajax". Set to "offline" for smaller data sets to get faster, smoother loading.
submitAction - Where to submit the search form. Valid options are to set this to: "homepagesearch". Setting it to any other value will cause the value to be treated as a URL. In this way you can have the form post to a URL of your choice (like a specific category or CMS page). If the user is on a category page, the form will submit to the same page (filter the current results) unless you also set the 'submitOnCategoryAction' setting. If at any time the category chooser is active on any given page, the form will ALWAYS post the category that the user selects.
submitOnCategoryAction - Where to submit the search form when the user is viewing a "category view" page. You may either set this to "refresh", or "homepagesearch", or a specific URL. If not specified, this value defaults to refresh. If at any time the category chooser is active on any given page, the form will ALWAYS post the category that the user selects.
submitOnProductAction - Where to submit the search form when the user is viewing a "product view" page. You may either set this to "refresh", or "homepagesearch", or a specific URL. If not specified, the value of "submitAction" is used on the product page, if it were specified. If at any time the category chooser is active on any given page, the form will ALWAYS post the category that the user selects.
submitOnHomepageAction - Where to submit the search form when the user is viewing the home page. You may either set this to "refresh", or "homepagesearch", or a specific URL. Defaults to "homepagesearch". If not specified, the value of "submitAction" is used on the home page, if it were specified. If at any time the category chooser is active on any given page, the form will ALWAYS post the category that the user selects.
categoriesThatSubmitToHomepage - List category IDs separated by comma that should always submit to the "homepage search results"
categoriesThatRefresh - List category IDs separated by comma that should always refresh on submit
- vehicleTemplate - Customize how the vehicle is displayed, for example if your schema is "year,make,model" it would default to displaying vehicles like "2000 Honda Civic" but with this you could have it show "2000 Civic" by setting the vehicleTemplate to "%year% %model%"
- storeVehicleInSession - Set to false to not store the vehicle in the user's session. Defaults to true.
Controls behavior of the vehicle link directory module
Controls how the extension modifies your products & shopping cart.
requireVehicleBeforeCart - Require the user to choose a vehicle before adding product to cart
Set to true to require the user to choose a vehicle before adding product to cart. If enabled users will be presented with an intermediate page, and asked to choose their vehicle from a list of compatable vehicles before adding the product to the cart. The default behavior is for this to be turned off, unless you set it to true.*
* Will only affect categories that are enabled. Will only affect product that are in enabled categories. If product is in both a blacklisted & whitelisted category, it will be treated as if it is whitelisted.
* Will only occur if the product actually has fitments mapped to it, if not there would be no possible choices and it would not make sense to show it.
Control the "My Garage" Functionality
Home Page Search
Control how your customer uses the extension to search from the home-page.
mode - Change the search results display mode
Valid values are "group", "category" or "grid".
grid will enable a sortable native Magento grid grouping all products in one giant group.
category will enable a category listing (See "category view").
exclude_categories - Specify comma delimited category ids to exclude those category's product from being included in the homepage search. Works for group view only (see 'mode' setting above).
You can allow your customer to choose from a list of "top level" categories to search in when using the vehicle search. If not used, searches will cover all categories.
onHomepage - Show the category chooser on the homepage
Set to true to place a chooser on the homepage. Set to false and the customer will never see a category chooser on the homepage. If not specified, the system would default to the below option "onAllPages". If neither option is specified, there will be no category chooser on any page. If both options are specified, the value of "onHomepage" will always take presdence for the homepage.
onAllPages - Show category chooser on pages other than homepage
Set to true to place the chooser on all pages. Note that if "onHomepage" (see previous option) is specified as well, it's value will take presedence on the homepage.
allOptionOnHomepage - Show "all" as the first option of the category chooser (for homepage)
Set to true to have "All" as a category option on homepage. Follows same rules as onHomepage & onAllPages regarding precedence
allOptionOnAllPages - Show "all" as the first option of the category chooser (for all pages)
Set to true to have "All" as a category option. Follows same rules as onHomepage & onAllPages regarding precedence
allCategoryOptionText - text to show for the "all categories" option
Set to the text you want to use in place of "All" on the category chooser, if ommited or blank, "All" will be used by default.
ignore - Category IDs to ignore
Ignores any category IDs listed, they will not show up in the "category chooser". List them out seperated by comma. If you do not put an ignore paramater then all categories will be listed by default.
Automotive Search Engine Optomization
Control how the extension affects your search engine optimization (SEO).
htmlSitemap - Enable an HTML sitemap? Set to true or false.
rewriteProductName - Rewrite Product Names. If set to true the name of the vehicle will be appended to the product name. Will only affect products in whitelisted (and/or non blacklisted) categories.
globalRewrites - When rewritten globally, the product title will appear rewritten eveywhere [globally], including but not limited to the page's html title tag and shopping cart. If this option is not activated, you must use a snippet for each place you want the product's title to appear rewritten.
productNameTemplate Change how product titles are altered
Template for changing how product titles are changed. Defaults to '_product_ for _vehicle_'
rewriteLevels Change how URLs are generated
For example, if your schema is make/model/year you could set this to "make,model" to not have a page for each year. You must only omit levels off the end.
Controls the optional logos module.
disable - Disable the module. Set to true or false.
extension - Defaults to 'PNG', set to the file extension that will become the filename suffix for your logos.
level - Defaults to "make", or if there is no level called "make" in your schema, your root (first) level. Specify this setting to override which level is used for the logo's filename.
Controls the import/export module.
allowMissingFields - Defaults to false. If set to true, import files will be accepted with less than all the "levels". Missing levels will be treated as if they were included but every row set to "Base".
Y2KMode - Defaults to true, enables Y2k Mode. Converts 2 digit years to 4 digit years as per the Vehicles List Import documentation.
Y2KThreshold - Defaults to 25. If a two digit year is less than this number, it assumed to mean 21st century; otherwise 20th century.
populateWhenSelectVehicle - Wether to preselect tire size when selecting vehicle. Set to true or false. Defaults to true.