radon8472 / schedulepages Goto Github PK

Readme file for: ProcessWire Schedule Pages Module

Copyright 2011 by Jasper Metselaar ([email protected])
Licensed under GNU/GPL v2, see http://processwire.com/about/license/

This module allows makes it possible to schedule (un)publication of
pages. This version of the plugin module relies on the LazyCron
module by Ryan Cramer.

Module is intended for:

ProcessWire 2.x and 3.x
Copyright (C) 2011 by Ryan Cramer
Licensed under GNU/GPL v2, see LICENSE.TXT

http://www.processwire.com
http://www.ryancramer.com


Usage:
======
1.  Place the SchedulePages.module file into the
    site/modules folder and install the plugin from the admin
    area.
    You can choose how often the cron requires to run. (thanks to
    Apeisa)
2.  The LazyCron module will be installed (if you haven't already).
    This module is part of the Processwire core, but it isn't
    activated by default.
3.  Add the following date fields to your template:
    publish_from
    publish_until
    Note: the fields are already created during the
	installation of the module
4.  That't all. LazyCron will run take care of (un)publishing
    your pages that have a the publish dates set.
    Please note: LazyCron hooks are only executed during
    pageviews that are delivered by ProcessWire. They are not
    executed when using ProcessWire's API from other scripts.


Update via composer:
====================
You can load this module by adding this to your composer.json in processwire and run `composer update`
`
{
  "require": {
    "formmailer/schedule-pages": "^1.2.2"
  },
  "repositories": [
    { "type": "github", "url": "https://github.com/formmailer/SchedulePages"  }
  ]
}
`
Feel free to use your own github url when you have forked this module



Version history:
================
1.0.0  Original version
1.0.1  Minor bugfixes
1.1.0  Added debug feature and fixed a publication bug
1.1.1  Added full language support and renamed $time variable to $currenttime
1.2.0  Added feature: Always use “Publish From Date” field to store publishing
       timestamp
1.2.1  The publish_from field is now automatically cleared when the page is
       manually unpublished. This prevents the page from being unintentionally
       re-published on the next cron run.
1.2.2  Minor bugfix. Duplicating pages was not working.