HNL Version 1.2
From MontegoScriptsWiki
Main Page>>HTML Newsletter>>Installation and Configuration
Contents |
REQUIREMENTS FOR THIS VERSION
- PHP-Nuke 6.5 - 7.6 (tested on 7.4, 7.5 and 7.6, but believe should work on the others listed)
- 2.9 Patchset from Chatserv (tested on 2.9 ONLY)
- Will add support for higher level patchsets as they become available for the above PHP-Nuke versions ONLY.
- Tested on IE 6.0 and Firefox 1.0.2.
NEW INSTALLATIONS
1) FIRST (and always) BACKUP YOUR FILES and mySQL Database. 2) Then unzip the files and upload to the appropriate directories shown below: html/hnlinst.php ---> PHP-Nuke_root/hnlinst.php html/modules/HTML_Newsletter ---> PHP-Nuke_root/modules/HTML_Newsletter html/images ---> PHP-Nuke_root/images html/blocks ---> PHP-Nuke_root/blocks NOTE: if you are installing this on a pre 7.5 version of Nuke, also upload the following: html/admin ---> PHP-Nuke_root/admin 3) Then chmod PHP-Nuke_root/modules/HTML_Newsletter/archive to 0777 to allow the temp file and the archived Newsletters to be written there. 4) Then login to you site as the administrator using admin.php (http://www.yoursite.com/admin.php). 5) Then run the install script called hnlinst.php (http://www.yoursite.com/hnlinst.php). (This will install the tables you will need in your database.) 6) Then remove hnlinst.php from your server when done. 7) Configure the tool per your own liking. Most of the configuration options have a pop-up help icon next to them. 8) You are now able to remove templates, rename current template directories, or add new ones. Be sure to use underscores in place of spaces in your directory names. If you intend on changing the template/directory names, you must do so prior to sending a newsletter using that template; otherwise, if changed afterwards, the archived newsletter will have broken links everywhere.
UPGRADE INSTRUCTIONS
1) FIRST (and always) BACKUP YOUR FILES and mySQL Database.
2) Then unzip the files and upload to the appropriate directories shown below.
html/hnlinst.php ---> PHP-Nuke_root/hnlinst.php
html/modules/HTML_Newsletter ---> PHP-Nuke_root/modules/HTML_Newsletter
html/images ---> PHP-Nuke_root/images
html/blocks ---> PHP-Nuke_root/blocks
NOTE: if you are installing this on a pre 7.5 version of Nuke, also upload
the following:
html/admin ---> PHP-Nuke_root/admin
3) Remove the old folder: PHP-Nuke_root/images/HTML_Newsletter
NOTE: we have tried to keep the module components as self-contained as
possible so as not to "clutter up" your Nuke installation.
4) Then login to you site as the administrator using admin.php (http://www.yoursite.com/admin.php).
5) Then run the install/upgrade script called hnlinst.php (http://www.yoursite.com/hnlinst.php).
- Upgrading from 1.0/1.1 to 1.2 is a FOUR STEP PROCESS: 1) upgrade the tables within
the PHP-Nuke database, 2) convert your previously archived newsletter files
to the 1.2 method of using PHP scripts in order to be able to apply permissions and
keep from newsletters being accessed directly, 3) update the newsletter "meta data"
to your satisfaction, and 4) clean up old newsletters.
- STEP 1 - Upgrade DB:
- Choose the option called "Upgrade HTML Newsletter 1.0 to 1.2 tables".
NOTE: 1.1 did not have any database changes.
- If successful, you will be prompted to Goto "Archived Newsletters Upgrade" or
to Goto "HTML Newsletter Configuration". If you choose to upgrade your current
newsletter files, clicking on that link will take you back to the options list
again... move on to STEP 2.
- STEP 2 - Upgrade Archived Newsletters:
- Choose the option called "Upgrade Archived Newsletters to 1.2"
NOTE: the tool will convert each of your .htm/.html newsletter files to a
.php file that will ensure they cannot be accessed outside of the Nuke block
or module and so they will work with the 1.2 system. This process will take a
MINIMUM of one second each, so take this into consideration if you have many
newsletter files to convert. If the script times out, you may need to copy
some newsletters down to your local PC or other directory and then convert in
"batches", placing the next "batch" of newsletters back up to your archives
directory and re-running this Upgrade option.
- If successful, you will be prompted to Goto "HTML Newsletter Configuration". Click
on this link to go to the next step.
- STEP 3 - Update newsletter "meta-data":
- Since all the upgrade tool "knows" is your newsletter filename, file create
date and contents, it is possible that the newsletter "meta-data" may need to
be updated by you manually so that the newsletter lists in the block or module
display to your liking.
- All newsletters which started with "mm" ("Mass Mail") newsletters will be
categorized under the category called "Mass Mail". The remaining newsletters
will be categorized under the category called "Archived Newsletters". Any
newsletter can be moved to a different category at ANY TIME by the admin.
- The first step should be to determine what categories you want to have and adjust
the Categories accordingly using the provided admin tool.
- The second step should be to update each Newsletter to have the appropriate
category, sender name, and date sent to be of your liking. Unless you know what
you are doing, I would not modify any other newsletter property even though we
provided the ability to do so.
- STEP 4 - Clean Up Old Newsletters
- The "Upgrade Archived Newsletters" function does NOT remove your old .htm/.html
files just in case something goes wrong -- you will still have your old
newsletter files within the arhives directory. Once you are satisfied that
the conversion is complete and the newsletters are showing up the way you want
them to, manually REMOVE YOUR OLD .htm FILES FROM THE ARCHIVES DIRECTORY!!!!
- NOTE: Previous newsletters left in their 1.0/1.1 state as .htm files are viewable
by everyone and anyone DIRECTLY - i.e., outside of the nuke structure. Therefore,
it is highly recommended that you convert your archived newsletter files or
remove them entirely. Also, the 1.2 version will NOT show these in the block or
module list of newsletters to view.
6) Remove hnlinst.php from your server when done.
7) Configure the tool per your own liking. Most of the configuration options
have a pop-up help icon next to them.
For on-going development status check out the Work Board and Support Forums at Montego Scripts
