Skip to main content Link Menu Expand (external link) Document Search Copy Copied

Validate

Given a list of collections, this routine will examine each blog entry in the list of collections and report any categories that do not have a match in the official list of categories.

Used On Pages

About Us -> Invalid Categories

Usage

collectionControl(Selector, Collection Slug, Display Type, Attributes)

Parameters:

Parameter Description
Selector Required.
jQuery selector identification where the resulting html code will be generated. Note that the selector must be unique on the page.
Collection Slug Not used
Display Type Required.
Identifies the display type requested. For collection validation must be "validate". These are case sensitive parameters.
Attributes Optional.
Identifies parameters to override default values. The parameters are passed in a object array of key/value pairs. Each display type has different default values as described below.

Attributes:

All attributes are optional, the defaults are defined.

Attribute Description Default
collections Required. This parameter is a javascript array of the collections to be included in the validation. Null

Example code block for control

This example displays invalid categories found in the blog entries for all of the listed collections.

NOTE:, The list of collections must be a valid javascript array of collections slug names.

<script>
$(document).ready(function() {
  collectionControl(
    "#validateCategories",
    "",
    "validate",
    {collections: [
        "announcements",
        "distance-learning-1",
        "outreach-1",
        "field-trip-options",
        "site-features",
        "public-education",
        "promotions",
        "jobs-list",
        "team-members",
        "flex-boxes",
        "giving-opportunities",
        "reference-data"
        ]
    }
  );
})
</script>
<div id="validateCategories"></div>

Reference Data

reference-data blog: categories

Return Value:

None