TYPOlight Extension - Catalog Extension: adds new features

The Catalog module is a wonderful back-end module, but it lacks a little in the front-end. Sure we've got the Cataloglisting module, and it works, but to get yourself a really professional looking catalog try this extension to an extension.

This module requires the installation of the Catalog Module.

Download

Site Examples

Discussion Forum

Features added to the existing Catalog Module

This module adds additional functionality to the Catalog module. Note certain features are only available with version 0.8.3 which is compatible with Catalog 0.3.0.

Back-end Features

  • Permissions have been implemented in the Catalog 0.3.0 module (and removed from Catalog Extension)
  • Adds selectable Alias Field used for JumpTo links and Catalog Reader (v0.8.3 only)
  • Adds selectable Title Field used as Page Title override in Catalog Reader (v0.8.3 only)
  • Adds a JumpTo page to the Catalog, which will use alias if defined as catalog field
  • Adds [x] Searchable to the Catalog: provides the JumpTo page for each entry to the Search Indexer

Front-end Features

Catalog Filter

  • Filter Module is simple point-and-click form builder
  • Almost all fields can be used as a filtered list, except URL, FILE (these were too difficult to achieve successfully) and LONGTEXT (as a dropdown with lots of rich text won't be of any value)
  • Each field can now be ordered and separately changed to: none, links list, radio, select drop-down
  • Set-up a Field Filter Tree with auto-hide children and children become self-filtered by parents. This is ideal for situations like: Area, City (click on area and it only shows cities in that area)
  • Tags can be set to display as multiple selects (radio becomes a checkbox control, and select becomes a multi-select)
  • Date filter section, order and chose which date fields and the types or past periods (day, week, month, 6 months or year)
  • As this is a separate module, you can place the filter in the right/left nav bar, but it must appear on the same page as the Catalog List module to create the filter URL for the list module to respond
  • Multiple catalog filters are supported on the same page, each can display only a certain part, e.g. one for filter on 1 field to create categories, another for the search and other filter specs in the right nav.
  • You can also set-up a JumpTo page, to which the filter will jump when clicked on a filter field, range, date, search or sort field. JumpTo is also Filter Tree View aware, e.g. it does not jump unless you are clicking on the last field in the filter tree (the final selection in your menu, which then jumps to your results). This allows you to set-up a category list on another page than the results.

Catalog List

  • Select which the order and visibility of listed fields
  • Thumbnails size override for one single image field and one multi image field with new size parameters
  • Supports a custom WHERE clause to exclude/include regardless of above filter specs (e.g. archived!=1 AND published=1)
  • Supports a custom default ORDER BY clause, which is replace by the sort order
  • Set the Query Mode (AND/OR)
  • Set the Tags Mode (AND/OR)
  • Select which fields are searched when search string is provided
  • Enable Conditional listing mode, where nothing is listed until the filter conditions are fulfilled, e.g. both Genre AND Formats chosen, then the list is shown
  • Must be on the same page as the Catalog Filter module above to filter the list
  • List Module is SEO-bases and supports paging (which is NOT SEO)

Catalog Reader

  • Select which the order and visibility of listed fields
  • Catalog Reader Module is placed on the JumpTo page (just like News), configured in the back-end catalog
  • replaces page title with title if defined as catalog field
  • Adds a reference variable to the items array so you can output the referenced catalog's info
  • Above reference now also checks if reference is another catalog and provides a jumpTo URL (link and id) so users can jump to another category's detailed description.

Catalog Featured

  • Select which the order and visibility of listed fields
  • Thumbnails size override for one single image field and one multi image field with new size parameters
  • Custom where clause
  • Limit items (0 to show all)
  • Option to disable randomizer feature ORDER BY RAND() and enter your own order by clause

Templates

  • catalog_simpletable.tpl ⇒ simulates the Listing module (to a degree)
  • catalog_simple.tpl ⇒ use with Catalog Listing (mainly)
  • catalog_full.tpl ⇒ use with Catalog Reader (mainly)
  • catalog_full_ref.tpl ⇒ use with Catalog Reader (with select/tag referenced array)
  • filter_default.tpl ⇒ default for Catalog Filter
  • filter_widgets.tpl ⇒ empty template with debug to show how to build your own filter with Catalog Filter

Installation

Download install package from and unzip it to your typolight/system/modules directory (where all the other modules are) in your TYPOlight installation. There are 4 folders:

  • catalog_ext (the main module)
  • backend_filterwiz (support BE widget)
  • backend_checkwiz (support BE widget) REQUIRED for TL 2.5.9 and below, included in TL 2.6

After unpacking run yourdomain.com/typolight/install.php and select the option to create the entries in the database tables of tl_catalog_types, tl_module, tl_user_group, tl_user.

The Catalog Extension Module should now be properly installed.

How to use

A brief description would be that it works similar to the News Module, e.g. create a catalog which contains your catalog items, with some additional fields (see back-end above)

Once you've setup the back-end, you can build the front-end with the 3 modules:

  • Catalog Filter module to show a filtering menu
  • Catalog List module to show the database filtered on the parameters submitted from the catalog filter module
    • also supports a basic condition filter, e.g. archived!=1 AND published=1
    • if an alias text field is present, it will be used instead of the id to jumpTo the catalog reader, e.g. prince-of-persia (alias value) ⇒ jumpTo will be catalog-reader/items/prince-of-persia.html
  • Catalog Reader (like news reader) module to view a single catalog item using the id/alias as parameter

Back-end Module Screens

Catalog Types - additional config fields

Catalog Filter Module - detailed screen

Front-end Module Screens

Catalog Filter - Area [ul css hovermap], City [dropdown] and Sort [dropdown]

Changelog

v0.8.6 2008-09-04 for catalog 0.3.x

  • added: reference array check to see if reference table is another catalog and includes the remote jumpTo (parentJumpTo, parentLink, parentUrl) to jump to the remote catalog's detail page
  • fixed: verifies if images exist before creating links to them in method “formatValue” (used to generate a php error in function.php)
  • fixed: routines to select aliasField, titleField in catalog_ext (for JumpTo and Searchable)

v0.8.5 2008-08-21 for catalog 0.3.2 beta

  • fixed: moved aliasField, titleField back to catalog_ext (from catalog)

v0.8.4 2008-08-19 for catalog 0.3.1

  • fixed: moved permissions HOOK location to catalog (bug)

v0.8.3 2008-08-14 special release for compatibility with catalog 0.3.0

  • moved: permissions to Catalog 0.3.0 module
  • added: selectable title and alias fields in catalog type
  • added: page title override in Catalog Reader using title alias field selected above
  • added: search index uses alias field selected above instead of id

v0.8.2 2008-07-31

  • added: new image size override options to Catalog List and Catalog Featured

v0.8.1 2008-07-17

  • updated: fixed some bugs in filterWizard back-end control
  • updated: split out checkboxWizard in preparation for TL 2.6
  • updated: provides parsed filter widgets in array
  • updated: provides widgets as array for custom filter development (filter_widgets.tpl)

v0.8.0 2008-07-17

  • added: jumpTo feature in Catalog Filter
  • added: added tree view filtering in Catalog Filter with auto-hide and self-filtering
  • added: new catalog_full_ref.tpl, to display reference fields
  • updated: custom internal widget creation (no longer using TL widgets)
  • updated: improved classes in templates
  • updated: all templates now generate valid XHTML
  • updated: catalog_full.tpl removed reference display
  • updated: rearranged display of some module fields
  • updated: new language strings used for “all” filter labels (select vs. others)
  • updated: minor bug fixes

v0.7.1 2008-06-30

  • bugfix for Catalog List
  • added Catalog Featured Module: select order and visible fields, custom where clause, limit items, and option to disable randomizer feature and use your own order by clause

v0.7.0 2008-06-26

  • all fields, except url and file can now be used as a filter, range or sort field
  • a new back-end control created (filterWizard) to allow ordering of fields, plus selection of type of form control, e.g. none (not visible), link list, radio buttons, select drop-down
  • tags can now be multi-selected (radio becomes checkbox and select becomes multi-select)
  • multiple new options in catalog list: query mode, tags mode
  • ranges now support dates with date control automatically added (if you have the javascript in your page template)
  • sort control type can now be selected (as filters above)
  • search fields have been moved to listing
  • added visibilty/order fields in catalog list and catalog reader
  • added conditional listing to Catalog List
  • new easy date selection support: last day, last week, last month, last 6 months, last year

v0.6.0 2008-06-12

  • archive bundle had multiple version files, fixed to latest version bundle

v0.5.10 2008-06-12

  • fixed a bug in ModuleCatalog, error when optional tags have no value set – thanks markus for highlighting this bug

v0.5.9 2008-06-07

  • added default sort order in Catalog List module, with default sort drop-down

v0.5.8 2008-06-07

  • added filter template support
  • added a new TL inputType called checkboxWizard, which allows you to select the fields and re-order then with up/down arrows

v0.5.7beta 2008-05-28

  • small bugfix, thanks ruud

v0.5.6beta 2008-05-28

  • added support for all field types that make sense in filter, search, range and sort, e.g. you can now sort on a select field (looks up the remote value and sorts on that)
  • checkbox implementation is a first draft
  • fixed tags lookups in all areas, e.g. 18, 8, 88 are all unique now
  • added support for single and multi-image formats, automatically builds galleries
  • fixed the display of files and urls, so they work correctly (internal vs. remote links)
  • missing: date range/filter support (coming in next version)

v0.5.4beta 2008-05-21

  • initial beta release

Author

Module and Instructions created by thyon from thyon design

extensions/catalog_ext.txt · Last modified: 2008-09-12 17:19 by thyon