forked from cjw-network/cjw_newsletter
-
Notifications
You must be signed in to change notification settings - Fork 0
/
INSTALL
138 lines (99 loc) · 3.81 KB
/
INSTALL
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
cjw_newsletter INSTALL
=====================
Copyright (C) 2007-2010 by CJW Network www.cjw-network.com
coolscreen.de - enterprise internet
JAC Systeme - http://www.jac-systeme.de
Webmanufaktur - http://www.webmanufaktur.ch
System requirements:
====================
- ez 4.x
- ezComponents
- php ( php 5 cli version )
Steps for installing the newsletter:
====================================
(1.) Activate the extension e.g. cjw_newsletter in settings/override/site.ini.append.php
[ExtensionSettings]
ActiveAccessExtensions[]=cjw_newsletter (have to be before ezwt if used)
ActiveAccessExtensions[]=ezwt
(2.) Update autoload/ezp_extensions.php
php bin/php/ezpgenerateautoloads.php -e -v
(3.) Create db tables
=> mysql mydb < cjw_newsletter/sql/mysql/schema.sql
(4.) Assign newsletteradmin design in your admin siteaccess
only if your ez version is < ez4.2.0
[DesignSettings]
SiteDesign=jac-example_admin
AdditionalSiteDesignList[]=newsletter_admin_ez4.0.0
AdditionalSiteDesignList[]=admin
(5.) Check if your menu.ini.append.php is override in siteaccess if yes then
you have to add the new newsletter tab manually
menu.ini.append.php
[TopAdminMenu]
Tabs[]=newsletter
(6.) Clear cache
(7.) Import newsletter contentclasses
cjw_newsletter/packages/cjw_newsletter_classes-1.0.1.ezpkg
(8.) Create a Newsletter Root object (e.g. cjw_newsletter_root ) which is used for all newsletter content
(9.) Create a new section 'CJW Newsletter' and select navigationpart 'CJW Newsletter'
(10.) Assign Section 'Cjw Newsletter' to Newsletter Root object created in (8.) or (7.)
(11.) Create Newsletter Structure
Newsletter Root
- Newsletter System
- Newsletter List 1
- Newsletter Edition 1
- Newsletter Article 1
- Newsletter Article 2
- Newsletter Edition 2
- Newsletter List 2
(12.) Check roles for useraccess
(13.) Create cjw_newsletter.ini.append.php for NewsletterSetting e.g.
Check:
======
- PhpCli
- TransportMethodCronjob
- TransportMethodPreview
- TransportMethodDirectly
- EmailPrefix
- Sender settings
...
(14.) Update default Newsletter Skin or create a new one
e.g. override default templates
my_design
+ templates
+ newsletter
+ skin
+ default
+ outputformat
- text.tpl
- html.tpl
A new skin can be created by defining in cjw_newsletter.ini.append.php, The available list is shown when
editing an newsletter list object
[NewsletterSettings]
AvailableSkinArray[]=my_custom_skin
Filestructure for custom newsletter
===================================
my_design
+ templates
+ newsletter
+ skin
+ my_custom_skin
+ outputformat
- text.tpl
- html.tpl
!!!! Don't forget to clear the cache after adding new templates !!!!!
(15.) Check SiteURL settings in site.ini of siteaccess which is used for render the newsletter
this setting is used to create absolute links to images
# site.ini.append.php
[SiteSettings]
# URL of site, often used to link to site in emails etc.
SiteURL=example.com
(16.) Activate the ts files in cjw_newsletter
# this settings you should copy to your siteaccess site.ini
# so you have the fully control which ts files are loaded
[RegionalSettings]
TranslationExtensions[]=cjw_newsletter
(17.) Creating all mails for a newsletter edition which is ready for sendout
php runcronjobs.php -s siteaccess cjw_newsletter_mailqueue_create
(18.) Sending out all mails which are in the mail queue create by (15.)
php runcronjobs.php -s siteaccess cjw_newsletter_mailqueue_process
Enjoy :-)