modx CMS

Instructions

Note : Do not start the module before the end of the installation


1/ copy txnewsletters directory in " assets/modules/ "

2/ create " assets/upload/ " directory if not exist with read/write right for www/php user
(upload folder is where the imported CSV file will be placed)

3/ log in manager as admin
create a new snippet named "TXNewsletters" with "<strong>0.9</strong> - TXNewsletters subscribe / unsubscribe form snippet" as snippet description
and copy "txnewsletters.snippet.tpl" as content

4/ create a new module named "TXNewsletters" with "<strong>0.9</strong> TXNewsletters - Newsletter manager module" as module description
and copy " txnewsletters.module.tpl " as content

- in " configuration tab > module configuration "

check the "Enable parameter sharing" option and copy following line to initialize modules variables :

&emailFrom=Sending Email;text;newsletter.no-reply@domain.lan &newslettersBaseId=Newsletters directory (id);text;1 &nbPerPage=Item per page;text;15 &idPageSubscribe=Page Subscribe;text;1 &idPageUnsubscribe=Page Unsubscribe;text;1

thoses variables should be updated later with your website specific information

- in module dependencies tab, add " TXNewsletters " snippet dependancy to share params with

5/ in snippet configuration > properties tab, select "TXNewsletters" in "Import module shared parameters" list

6/ now you should create modx documents / template for newsletters and subscription pages, something like following :

+ newsletters (directory)
| + newsletter 1 (page) // with a newsletter template
| + newsletter 2 (page) // with a newsletter template
+ newsletter subscription (page) // with subscribe template

=> newsletter template should have "{link_unsubscribe}" added in an link, something like this : "<a href="{link_unsubscribe}">click here for unsubcribe</a>"
the tag "{link_unsubscribe}" will be replaced with an encoded unsubscribe link by the module before sending

=> subscribe template page should have this snippet call "" to generate subscribe form
if you choose to have a different page for unsubscribe, the template page should have this snippet call ""

Some css styles for subscribe / unsubscribe forms are in the chunk "txnewsletters.styles.chunk.tpl", you can add
this chunk to subscribe / unsubscribe templates or copy content directly into your website stylesheet

7/ Define module parameters to fit your website implementation :

// Email used as from field when sending newsletters
&emailFrom=Sending Email;text;newsletter.no-reply@domain.lan

// MODx Page Id of the newsletters directory
&newslettersBaseId=Newsletters directory (id);text;1

// Number of items to display per page in the backend module
&nbPerPage=Items per page;text;15

// MODx Page Id of the page where the subscribe form will be
&idPageSubscribe=Page Subscribe;text;1

// MODx Page Id of the page where the unsubscribe form will be (could be the same as subscribe page)
&idPageUnsubscribe=Page Unsubscribe;text;1

8/ you can personalize xml data in assets/modules/txnewsletters/conf/conf.xxx.xml to change data/form to fit your needs.
XML structure should be the same in every language, only labels must be translated.

(XML definition guide will be available soon on the MODx wiki but you can see some examples in conf directory to start with.)

9/ now start the module in manager and click on the button to automatically create table in database (table is generated from the xml definition file)

TXNewsletters module is now installed.

To regenerate table from a new xml definition file
drop table "txnewsletters_usersdata"
update xml file
restart module and click on the button again.