ProcessWire ListerPro
=====================

Copyright 2017 by Ryan Cramer Design, LLC

PLEASE DO NOT DISTRIBUTE
========================

This is a commercial ProcessWire module that is authorized only for 
use on websites or applications owned and/or developed by a single 
develeloper/owner (developer license) or company (agency license). 
Support is provided only to the purchaser.

This service/software is authorized for use only for the sites it was
purchased for. It should not be distributed beyond the sites you
registered it for, except for staging and/or development servers
related to the site. If you did not purchase this copy of ListerPro,
you should obtain a copy from the ProcessWire store at: 
http://processwire.com/talk/store/ 


ABOUT LISTER PRO
================

ListerPro enables you to find, filter, list and manipulate pages based 
on any of their properties. It presents an AJAX-driven table of 
matching pages and you have full, dynamic control over what columns 
are displayed in the table, and their order. Unlike the regular Lister, 
ListerPro enables you to create your own custom Listers, perform 
manipulations on pages, customize to your heart's desire, and much 
more. ListerPro is a truly unique, powerful and easy-to-use tool that 
will significantly enhance the way you work with ProcessWire. 

Read more about ListerPro at:
https://processwire.com/api/modules/lister-pro/


REQUIREMENTS
============

ProcessWire 2.7.2 or newer. 


HOW TO INSTALL LISTER PRO
=========================

The ZIP file that this module comes in can be uploaded directly to
your admin in Modules > New > Upload. If your modules file system is
not writable, you can also install it this way: 

1. Copy the ListerPro files into this directory:
   /site/modules/ProcessPageListerPro/

2. In your ProcessWire admin, go to Modules and "Refresh".

3. Click "Install" for the ListerPro (ProcessPageListerPro) module.

Following installaton, enter your product key in the field provided 
and 'submit'. If you have any trouble getting your product key to 
validate just send a PM to ryan in the forums at 
http://processwire.com/talk/ or email ryan@processwire.com. 

ListerPro immediately replaces your Pages > Find screen, as well as
your Access > Users screen. But where ListerPro really gets fun is
in creating your own Listers. Continue to the next section for 
instructions on how to do this. 


HOW TO ADD A NEW LISTER
=======================

1. In your admin, go to Pages > Find (or any existing Lister). 

2. Click the Config tab. Scroll to the bottom and click the 
   "Add a NEW Lister" field. 

3. Type in the name for the new Lister and click Save. Your new Lister 
   is created.

Following the above 3 steps, you are on the configuration screen for the new 
Lister. Configure it as you'd like and hit Save. You will see the link to 
your new Lister in the top navigation under Pages > [your Lister's title].

If you want to move your new Lister somewhere else: Click Pages in the top 
navigation and then click "Admin" then "Pages" in the tree. You will see your 
Lister page there. Click it and select "Move" and then drag it wherever
you'd like in your admin. Do not move it out of the admin. 


HOW TO ADD A LISTER PRO ACTION
==============================

ListerPro comes with several ready-to-use actions. You may also download 
additional actions from the ListerPro support board. ListerPro actions are 
actually just ProcessWire page actions, which is a predefined module type 
in ProcessWire. These actions are ProcessWire modules like any other. 
Install them the same way you would any other module.

Once installed, the actions will show up on all of your ListerPro "Config" 
screens under the "What actions do you want to allow" section. Check the 
box next to any actions you want to allow with each Lister.

Most actions also come with their own permission that the user needs to 
have in order to execute the action. The actions table on the Config 
screen will tell you what permission is required. What this means is 
simply that the user must have that permission checked in one of their 
roles before the action will be available to them. However, because of 
the inherent power (and thus potential danger) in most page actions, 
you may want to limit these actions to superusers. 


UPGRADES
========

Upgrades are made available through the ProcessWire ListerPro support
board at http://processwire.com/talk/. If you can't see the support board
there, please email ryan@processwire.com or send a PM to ryan from the
ProcessWire forums.

To install an upgrade you would typically just replace the old files
with the new. However, there may be more to it, depending on the version.
Always follow any instructions provided with the upgrade version in
the support board.


LISTER PRO VIP SUPPORT
======================

Your ListerPro service includes 1-year of VIP support through the ProcessWire
ListerPro forum. In order to activate this service, you need to sign up for
a forum account at http://processwire.com/talk/ (if you don't already have one).

Please send a private message (PM) to 'ryan' or contact us at:
http://processwire.com/contact/ and let us know what your forum name is so
that we can upgrade your member access. However, the access should be 
automatically assigned after your purchase. 

VIP support is also available by email: ryan@processwire.com


HAVE QUESTIONS OR NEED HELP?
============================

Send an email to ryan@processwire.com. You may also post in the ProcessWire
forums at http://processwire.com/talk/.


TERMS AND CONDITIONS
====================

You may not copy or distribute ListerPro, except on site(s) you have registered it
for with Ryan Cramer Design, LLC. It is okay to make copies for use on staging
or development servers specific to the site you registered for.

This service/software includes 1-year of support through the ProcessWire ListerPro
Support forum and/or email. Please notify us of your forum name so that we can
upgrade your access to the members-only ListerPro Support forum.

In no event shall Ryan Cramer Design, LLC or ProcessWire be liable for any special,
indirect, consequential, exemplary, or incidental damages whatsoever, including,
without limitation, damage for loss of business profits, business interruption,
loss of business information, loss of goodwill, or other pecuniary loss whether
based in contract, tort, negligence, strict liability, or otherwise, arising out of
the use or inability to use ProcessWire ListerPro, even if Ryan Cramer Design, LLC /
ProcessWire has been advised of the possibility of such damages.

ListerPro is provided "as-is" without warranty of any kind, either expressed or
implied, including, but not limited to, the implied warranties of merchantability and
fitness for a particular purpose. The entire risk as to the quality and performance
of the program is with you. Should the program prove defective, you assume the cost
of all necessary servicing, repair or correction. If within 7 days of purchase, you
may request a full refund. Should you run into any trouble with ListerPro, please
email for support or visit the ListerPro Support forum.


Thanks for using ListerPro!

---

ProcessWire ListerPro
Copyright 2017 by Ryan Cramer Design, LLC

