by Berdir: Fixed subscriber mail is not run through check_plain() on overview.
[project/simplenews.git] / README.txt
1
2 DESCRIPTION
3 -----------
4
5 Simplenews publishes and sends newsletters to lists of subscribers. Both
6 anonymous and authenticated users can opt-in to different mailing lists. 
7 HTML email can be sent by adding Mime mail module.
8
9
10 REQUIREMENTS
11 ------------
12
13  * Taxonomy module
14  * For large mailing lists, cron is required.
15  * HTML-format newsletters and/or newsletters with file attachments require the
16    mime mail module. 
17
18 INSTALLATION
19 ------------
20
21  1. CREATE DIRECTORY
22
23     Create a new directory "simplenews" in the sites/all/modules directory and
24     place the entire contents of this simplenews folder in it.
25
26  2. ENABLE THE MODULE
27
28     Enable the module on the Modules admin page:
29       Administer > Site building > Modules
30
31  3. ACCESS PERMISSION
32
33     Grant the access at the Access control page:
34       Administer > User management > Access control. 
35
36  4. CONFIGURE SIMPLENEWS
37
38     Configure Simplenews on the Simplenews admin pages:
39       Administer > Site configuration > Simplenews.
40
41     Select the content type Simplenews uses for newsletters.
42     Select the taxonomy term Simplenews uses to manage newsletter series.
43
44  5. ENABLE SIMPLENEWS BLOCK
45
46     With the Simplenews block users can subscribe to a newsletter. For each
47     newsletter one block is available.
48     Enable the Simplenews block on the Administer blocks page:
49       Administer > Site building > Blocks.
50
51  6. CONFIGURE SIMPLENEWS BLOCK
52
53     Configure the Simplenews block on the Block configuration page. You reach
54     this page from Block admin page (Administer > Site building > Blocks). 
55     Click the 'Configure' link of the appropriate simplenews block.
56  
57     Permission "subscribe to newsletters" is required to view the subscription
58     form in the simplenews block or to view the link to the subscription form.
59
60  7. SIMPLENEWS BLOCK THEMING
61
62     More control over the content of simplenews blocks can be achieved using 
63     the block theming. Theme your simplenews block by copying 
64     simplenews-block.tpl.php into your theme directory and edit the content.
65     The file is self documented listing all available variables.
66
67     The newsletter block can be themed generally and per newsletter:
68       simplenews-block.tpl.php (for all newsletters)
69       simplenews-block.tpl--[tid].php (for newsletter series tid)
70
71  8. MULTILINGUAL SUPPORT
72  
73     Simplenews supports multilingual newsletters for node translation,
74     multilingual taxonomy and url path prefixes.
75
76     When translated newsletter issues are available subscribers receive the
77     newsletter in their preferred language (according to account setting).
78     Translation module is required for newsletter translation.
79
80     Multilingual taxonomy of 'Localized terms' and 'per language terms' is
81     supported. 'per language vocabulary' is not supported.
82     I18n-taxonomy module is required.
83     Use 'Localized terms' for a multilingual newsletter. Taxonomy terms are
84     translated and translated newsletters are each taged with the same
85     (translated) term. Subscribers receive the newsletter in the preferred
86     language set in their account settings or in the site default language.
87     Use 'per language terms' for mailing lists each with a different language.
88     Newsletters of different language each have their own tag and own list of
89     subscribers.
90     
91     Path prefixes are added to footer message according to the subscribers
92     preferred language.
93
94     The preferred language of anonymous users is set based on the interface
95     language of the page they visit for subscription. Anonymous users can NOT
96     change their preferred language. Users with an account on the site will be
97     subscribed with the preferred language as set in their account settings.
98
99 9.  NEWSLETTER THEMING
100
101     You can customize the theming of newsletters. Copy any of the *.tpl.php 
102     files from the simplenews module directory to your theme directory. Both
103     general and by-newsletter theming can be performed.
104     Theme newsletter body:
105       simplenews-newsletter-body.tpl.php (for all newsletters)
106       simplenews-newsletter-body--[tid].tpl.php (for newsletter series tid;
107       where [tid] is replaced by the term id of the newsletter taxonomy term.
108     Theme newsletter footer:
109       simplenews-newsletter-footer.tpl.php (for all newsletters)
110       simplenews-newsletter-footer--[tid].tpl.php (for newsletter series tid)
111     The files are self documented listing all available variables.
112
113     Using the Display fields settings each field of a simplenews newsletter can
114     be displayed or hidden in plain text and/or HTML newsletters. You find 
115     these settings at: 
116       admin/content/node-type/my-node-type/display
117
118
119 10. SEND MAILING LISTS
120
121     Cron is required to send large mailing lists. Cron jobs can be triggered
122     by Poormanscron or any other cron mechanism such as crontab.
123     If you have a medium or large size mailing list (i.e. more than 500
124     subscribers) always use cron to send the newsletters.
125   
126     To use cron:
127      * Check the 'Use cron to send newsletters' checkbox.
128      * Set the 'Cron throttle' to the number of newsletters send per cron run.
129        Too high values may lead to mail server overload or you may hit hosting
130        restrictions. Contact your host.
131     
132     Don't use cron:
133      * Uncheck the 'Use cron to send newsletters' checkbox.
134        All newsletters will be sent immediately when saving the node. If not 
135        all emails can be sent within the available php execution time, the 
136        remainder will be sent by cron. Therefore ALWAYS enable cron.
137
138     These settings are found on the Newsletter Settings page under
139     'Send mail' options at:
140       Administer > Site configuration > Simplenews > Send mail.
141
142  11. TIPS
143
144     A subscription page is available at: /newsletter/subscriptions
145
146     If your unsubscribe URL looks like:
147       http:///newsletter/confirm/remove/8acd182182615t632
148     instead of:
149       http://www.mysite.org/newsletter/confirm/remove/8acd182182615t632
150     You should change the base URL in the settings.php file from
151       #  $base_url = 'http://www.example.com';  // NO trailing slash!
152     to
153       $base_url = 'http://www.mysite.org';  // NO trailing slash!
154
155 DOCUMENTATION
156 -------------
157 More help can be found on the help pages: example.com/admin/help/simplenews
158 and in the drupal.org handbook: http://drupal.org/node/197057