Search modules are plugins that enable you to show search options that'll search through Jomres properties on pages other than the Jomres pages themselves. Currently they're specific to Joomla only, with the exception of mod_jomsearch_m0.
Obtaining search modules
Search modules are obtained through the Jomres Plugin Manager, which can be viewed via the Administrator area's control panel for Jomres.
Configuring search options
When Jomres is installed on a Joomla server typically a menu option is added to allow site visitors to view the (Jomres) component. If the component has more than one property registered on it, and the user isn't doing something specific like going to the booking form, then a search for properties is triggered.
The number of properties returned on a page is governed by the ''Administrator area -> Jomres -> Site Configuration -> Search Options -> Property List limit''. A search can have more than that number of results, and if there are more then more pages are offered to see those results.
If Jomres detects that a search hasn't been triggered through a search module then it will do a random search. A random set of properties will be returned and displayed, the number of properties returned is governed by the ''Administrator area -> Jomres -> Site Configuration -> Search Options -> Random search limit''. A common error is setting the ''Property List limit'' to the same number as the random search. If you do this then you'll never see the page links that take you to the next set of results.
Jomres has four main search modules available to it, imaginatively titled jomsearch m1 through to m4. These are highly configurable search modules and are installed via the Plugin Manager.
When a search module is installed it is installed to, like most modules, the /modules folder. It will also create a sub folder mod_jomsearch_mN where N = the number of the module. Here is srch.html which is used to format the output of the module.
There are many configuration options but to summarise the modules offer you the ability to mix and match the search options you wish to utilise. You have the choice of offering them as drop downs or links. If you choose to then you are able to offer combined searches to your site visitor. If you select links then you're defining specific searches (for example, you would be offering a search on a specific room type).
Note. Another common error is to offer searching by property name as one of the drop down options. If you do this then searches will always return the property named in that drop down, regardless of the other options chosen in the search form.
If you are in doubt of what a parameter does hover over it's label, there is extended information about an option that will be viewable in a popup.
Modifying search layout
The search modules each have their own unique template called srch.html which is stored in /modules/mod_jomsearch_mN/mod_jomsearch_mN. You can edit this template to obtain the layout you require for your site. m1 is optimised for positioning in a horizontal "top" module position which spans the top of a page, whereas m2, m3 and m4 are more suited to side column positions. The module templates themselves include all likely options for the available search parameters but you are unlikely to use all of the options (eg, you might want just the availability and the property type options) so it's expected that you'll want to edit the srch.html to achieve the layout that's specific to that module's position in the overall Joomla template.
Integrated search feature
You may sometimes see the integrated search feature referred to as mod_jomsearch_m0. This is because it's a modified feature that is configured the same as the other search modules mentioned above, but integrated into Jomres Core for users who either don't want search modules or because they're not using Joomla but still want to offer a search feature.
It is configured via the ''Administrator area -> Jomres -> Site Configuration -> Integrated Search feature''. The options are the same but the template that constructs the module's layout is in ''/jomres/templates/jomres/frontend'' and is called ''search.html''.
This document is copyright Vince Wooll/Woollyinwales IT, 2011. All rights reserved.