Quick start

Filter in the catalog

In the catalog category template (an msCategory resource), replace the msProducts call with the code below. On MODX 3 with MiniShop3 the call is the same.

[[!msCatalyst?
  &facets=`vendor, parent, option:color, ms:price|range`
]]

Uncached call

The exclamation mark is required. The snippet answers AJAX requests from the same page and reads the filters from the URL. A cached call would show every visitor the same selection.

Styles and the script are added automatically. The page needs </head> and </body> for that.

An example with every facet type:

[[!msCatalyst?
  &parents=`5`
  &facets=`vendor|sort=count, parent|label=menutitle, tv:color|lex=color_, option:size|first=5, ms:price|range|step=100, ms:weight|range|title=Вес (кг), ms:made_in|title=Страна`
  &sorts=`menuindex, pagetitle, ms:price:asc, ms:price:desc, publishedon:desc`
  &limits=`12, 24, 48`
  &searchFields=`pagetitle^3, ms:article^5, introtext, content, option:brand`
]]

All properties and the facet syntax are described on the msCatalyst snippet page.

Search in the header

[[!msCatalystSearch?
  &parents=`5`
  &searchPage=`5`
]]

More: msCatalystSearch.

SEO headings

<title>[[!+mscatalyst.title]]</title>
<meta name="description" content="[[!+mscatalyst.description]]">
<h1 data-msc-h1>[[!+mscatalyst.h1]]</h1>

Heading templates and indexing rules are described in SEO.

Loading the catalog

Open "Extras → msCatalyst", the "Sync" tab, and create a profile: a CSV or XLSX file, an API, a Google Sheet or 1C. The wizard walks you through source analysis, field matching and a dry run. More: Sync.