interface/main/calendar/modules/PostCalendar/INSTALL

   1 $Id$
   2 ========================================================================
   3 Installation
   4 ========================================================================
   5
   6 PLEASE ALSO READ THE DOCUMENTATION AVAILABLE ONLINE AT
   7
   8         http://www.postcalendar.tv/wiki
   9
  10
  11 To install PostCalendar simply unzip/untar the distribution inside your
  12 PostNuke html directory. This will create the ./modules/PostCalendar
  13 directory and should contain all the files of the distribution.
  14
  15 ***NOTE: You'll need to CHMOD 777 the following directories:
  16
  17         ./modules/PostCalendar/pntemplates/compiled
  18         ./modules/PostCalendar/pntemplates/cache
  19
  20 This allows Smarty to compile and cache your templates. If you're
  21 on a windows platform, just make sure the directory has read/write
  22 permissions for the web server.
  23
  24 If you would like to change the path of these directories, you can
  25 change the value of $this->compile_dir and $this->cache_dir in the
  26 pcSmarty.class.php file to point to wherever you'd like templates to be
  27 compiled. Moving this out of the webroot might not be that bad of an
  28 idea. (I have not tested this as of yet)
  29
  30 Now, enter the administration portion of your PostNuke site:
  31
  32     * Select MODULES Administration
  33     * Click on the REGENERATE link
  34     * Find the PostCalendar entry in the list
  35     * Click INITIALISE
  36     * After the list reloads, click ACTIVATE
  37
  38 You should now have a fully functioning PostCalendar installation.
  39
  40 You'll want to enter your site's Administration and configure
  41 PostCalendar before you start to enter events. The installation
  42 will set defaults for the calendar so that it works, but in
  43 order to better suit your needs, it's best to change these as
  44 early as possible.
  45
  46 ========================================================================
  47 Upgrading
  48 ========================================================================
  49 To upgrade PostCalendar you should first make a backup of you current
  50 Database tables (using a tool like phpMyAdmin) and also backup your
  51 current PostCalendar installation.  This will be useful in the event
  52 an upgrade does not work for you.
  53
  54 Next, unzip/untar the PostCalendar distribution inside your Postnuke
  55 html directory.  This will create the modules/PostCalendar directory
  56 and place all the necessary files there.
  57
  58 ***NOTE: You'll need to CHMOD 777 the following directories:
  59
  60         ./modules/PostCalendar/pntemplates/compiled
  61         ./modules/PostCalendar/pntemplates/cache
  62
  63 This allows Smarty to compile and cache your templates. If you're
  64 on a windows platform, just make sure the directory has read/write
  65 permissions for the web server.
  66
  67 If you would like to change the path of these directories, you can
  68 change the value of $this->compile_dir and $this->cache_dir in the
  69 pcSmarty.class.php file to point to wherever you'd like templates to be
  70 compiled. Moving this out of the webroot might not be that bad of an
  71 idea. (I have not tested this as of yet)
  72
  73 ***NOTE: DO NOT USE THE POSTNUKE MODULE ADMIN INTERFACE
  74          TO UPGRADE POSTCALENDAR.  DOING SO WILL BREAK
  75                  THE UPGRADE PROCESS. FOLLOW THE STEPS BELOW
  76
  77 Enter the administration portion of your PostNuke site:
  78
  79     * Select POSTCALENDAR Administration
  80     * Click on the Upgrade PostCalendar Link
  81
  82 If all went well, you should see a CONGRATULATIONS message.
  83 If not, you should see an ERROR message.
  84
  85 You should see link that says 'Upgrade PostCalendar 3.0x'
  86
  87 You should now have a fully functioning PostCalendar installation.
  88
  89 You'll want to configure PostCalendar before you start to enter events.
  90 The installation will set defaults for the calendar so that it works,
  91 but in order to better suit your needs, it's best to change these as
  92 early as possible.  You should also check your old events and edit
  93 them if necessary.  Events that have no end date should have the
  94 appropriate repeating option for 'no end date' selected as this will
  95 greatly speed up your calendar.
  96
  97 ========================================================================
  98 Menu Configuration
  99 ========================================================================
 100 You can link to PostCalendar by entering {PostCalendar} in a menu block.
 101
 102 Using [PostCalendar] will also work, but this is for old style modules.
 103 Using the method above will produce much better results.
 104
 105 Goto your Block administration and edit/create the Menu block to hold
 106 your link to PostCalendar.
 107
 108 The Menu Block editing screen should look something like this:
 109
 110 +--------------+----------------+-------------+--------+--------+-------+
 111 | Title        | URL            | Description | Delete | Insert | Blank |
 112 +--------------+----------------+-------------+--------+--------+-------+
 113 | PostCalendar | {PostCalendar} | My Calendar |        |        |       |
 114 +--------------+----------------+-------------+--------+--------+-------+
 115
 116 ========================================================================
 117 Admin Settings
 118 ========================================================================
 119
 120 ========================================================================
 121 Blocks Configuration
 122 ========================================================================