Documentation

Much of this works like the built-in Page List. The biggest differences is that:

  • You can choose more than one page type
  • You can filter by most page attributes (this is where things might get complicated)
Additional documentation can be found here.

Search

You can use this block to do site search. You can show/hide various parts of the search functionality in order to breakup your search (such as the search box in the header and the results in the main section of the page.

  • Show or hide the basic search box
  • Show or hide attribute criteria (choose which attributes you want to allow to be used for searching)
    • Select boxes can also be shown as checkboxes for multiple selections
    • These criteria are normally shown in alphabetic order, but can be setup in any order you want.
  • Show or hide user configurable sorting
  • Show or hide the search results
When you select an attribute to be used in the search, the filters will automatically be configured.

Filters

Note: In order for the filters to work correctly, this addon requires that the 'Index Search Engine' job is run on a regular basis. If your site does not get a lot of updates, you may run this manually. However, if your site gets updated regularly or has submissions by multiple people, you may want to run this job once or twice per day via cron job or the Nontab Scheduler.

Keywords

Select specific keywords to filter the pages. Keywords are found in the title, description, content and tags.

Related to Content from Area

This functionality chooses the top 5 keywords from the given Area of the page and filters pages based on their relevance to those keywords.

Page Attribute Filters

These filters allow you to choose pages based on their attributes. The filters are additive.

The options are:

Text/Textarea

  • Is empty / Is not empty
  • Contains / Does not contain
  • Is exactly
  • Starts with / Ends with
  • Matches / Does Not Match the current page value
  • Matches / Does Not Match the value in the querystring
Checkbox
  • True / False
  • Matches / Does Not Match the current page value
  • Matches / Does Not Match the value in the querystring
Datetime
  • Has a date / Does not have a date
  • Is before today / Is after today
  • Is before / Is after
  • Is on or before / Is on or after
  • Is before current page value / Is after current page value
  • Is on or before current page value / Is on or after current page value
  • Is between (inclusive and exclusive) / Is not between (inclusive and exclusive)
  • Matches / Does Not Match the current page value
  • Matches / Does Not Match the value in the querystring
For datetime attributes, you can use dynamically generated dates, such as:
  • now (to show pages with a date before the current timestamp)
  • -15 minutes (to show pages with a date that is within the last 15 minutes)
  • -2 hours (to show pages with a date that is within the last 2 hours)
  • -1 day (to show pages with a date that is within the last 24 hours)
  • -7 days (to show pages with a date that is within the last week)
for the following selections:
  • Is before / Is after
  • Is on or before / Is on or after
  • Is between (inclusive and exclusive) / Is not between (inclusive and exclusive)

Image/File

  • Is empty / Is not empty
  • Contains / Does not contain
  • Is exactly
  • Starts with / Ends with
  • Matches / Does Not Match the current page value
Number
  • Has a value / Does not have a value
  • Is less than / Is greater than
  • Is less than or equal / Is greater than or equal
  • Is less than the current page value / Is greater than the current page value
  • Is less than or equals to the current page value / Is greater than or equals the current page value
  • Is between (inclusive and exclusive) / Is not between (inclusive and exclusive)
  • Matches / Does Not Match the current page value
  • Matches / Does Not Match the value in the querystring
Rating
  • Has a rating / Does not have a rating
  • Is less than / Is greater than
  • Is less than or equals / Is greater than or equals
  • Is less than the current page value / Is greater than the current page value
  • Is less than or equals to the current page value / Is greater than or equals the current page value
  • Is between (inclusive and exclusive) / Is not between (inclusive and exclusive)
  • Matches / Does Not Match the current page value
  • Matches / Does Not Match the value in the querystring
Select
  • Has a selection / Does not have a selection
  • Is a specified value / Is not a specified value
  • Matches all options of the current page attribute
  • Matches some of the options of the current page attribute
  • Does Not Match any of the options of the current page attribute
  • Matches / Does Not Match the value in the querystring

'Page Selector' Custom Attribute

  • Is empty / Is not empty
  • Page Name Contains / Does not contain
  • Page Name ss exactly
  • Page Name Starts with / Ends with
  • Matches / Does Not Match the current page value
  • Matches / Does Not Match the current page ID

Custom Templates

If you have any custom page list templates you'd like to use, you will have to:

  1. Create a new folder at the root level called 'page_list_plus'
  2. Copy your existing templates into the new folder
  3. Update the templates accordingly. Many times all that will need to be done is to add the code for displaying the List Title and the 'View All' link

I was going to have an automated import of existing templates from the Page List block, but decided that it would be safer for most people to not have that capability.

Page Attribute Blacklist

The Page Attribute Blacklist on the dashboard allows you to 'blacklist' (not show in the edit Page List Plus dialog box) any page attribute you'd like.

Take this scenario:

  • Say you have an attribute that defines the dimensions of an image on the page. It is called 'Image Size'
  • You don't need to filter or sort on the dimension
Here's how to resolve that:
  • Go to 'Page List Plus' in your dashboard
  • Check the box next to 'Image Size'
  • Save the Blacklisted attributes
  • 'Image Size' will no longer show in the Page List Plus edit dialog, either under filter or sorting.