_ _ _ _ _____ _____ | \ | | | | | ||_ _| / __ \ | \| | ___ __ __ ___ | | ___ | |_ | | _ _ __ __ `' / /' | . ` | / _ \\ \ /\ / // __|| | / _ \| __|| || | | |\ \/ / / / | |\ || __/ \ V V / \__ \| || __/| |_ | || |_| | > < ./ /___ \_| \_/ \___| \_/\_/ |___/|_| \___| \__|\_/ \__,_|/_/\_\ \_____/ v. 2.1.4. (c) 2007 Matthieu LACROIX - http://www.php-astux.info/newslettux-en.php ------------------------------------------------------------------------------- ENGLISH VERSION NewsletTux is a mailing-list script with complete administration that enables to manage several newsletters profiles and writers. CAUTION : NewsletTux makes it possible to send emails to several people. It is obvious that using NewsletTux doesn't goal to develop unwanted emails. By using NewsletTux, you approve its using for information and not spam. I) Installation : easy and quick ! ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1 - Upload all archive content on your server ; (I advise you to create a new directory, called for example newslettux2) - in the following paragraphs, I'll assume "newslettux2/" is the directory where you install NewsletTux) 2 - Go to http://yourwebsite/newslettux2/admin/install.php Follow the 5 steps installation. 3 - Delete (or rename) the install.php file if the script hasn't done it for you, otherwise someone else may reinstall NewsletTux for you ! (so it's important ...) II) Configuration : friendly and intuitive ! ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Connection : http://yourwebsite/newslettux2/admin/index.php Login : your email input during installation Mot de Passe : the one you input during installation At your first connection, all is configured either with values from the installation, or default values. 1 - You must first create a new newsletter profile to use NewsletTux : Go to "Newsletters profiles" > "List newsletters profiles" and add a new one. 2 - Install the script on your web site (cf. following paragraphs) 3 - You can upgrade some subscribers as "admin" or "writer". Just edit their profile ("Manage subscribers" > "List subscribers") to give them permissions. Admins do not require writing permissions. For security reasons, vital administrative functions (database for example) are not accessible to admins and writers. III) Forms presentations : ~~~~~~~~~~~~~~~~~~~~~~~~~~~ You can choose between 2 bodies for subscription form. To make this choice, go to "Configuration" > "Configuration of subscriptions". a) NewsletTux 1.X like form = "normal" form (default form) In this form, the visitor sees all newsletters profiles, he can choose his subscription formats. b) The simple form : an only field (for email) with 2 buttons : "subscribe" and "unsubscribe". For this form, choose formats (for newsletters profiles) to which will subscribe new subscribers. CAUTION : for compatibility issues, prefer the text format. NEW IN 2.1.0. version : overlod of simple form ---------------------------------------------- Since 2.1.0. version of NewsletTux it's possible to hide "subscribe" and "unsubscribe" buttons from the simple form. This is what I call "overload". The principe is explained below (paragraph IV - Advanced configuration) III) Integrate into Web site : ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Whatever may be the chosen form, inserting it in your website is very easy. 1 - you have to create a page in your website (or take an existing one) named with ".php" extension. (For example, http://www.yourwebsite.ext/my_newsletter.php) 2 - Then, open "form-newslettux.php" and configure it (the area to configure is highlighted). In this file, you have 2 variables to fill in : NTUX2_ROOT and DOCTYPE. * For Doctype, choose between HTML (default) or XHTML according to your page. * for NTUX2_ROOT, the explanation is a bit more difficult. The job is to fill in, in relative path, the NewsletTux directory starting from where you include "form-newslettux.php", as if you were doing a relative link href to the file "form-newslettux.php". Insofar as an example is more talkative than a long discuss, I describe below 3 examples. Try to see which one represents best your website, otherwise ask on the forum detailling your path. 3 examples of configuration for NTUX2_ROOT : EXAMPLE 1 : ----------- http://www.yourwebsite.ext |- home.html |- contact.php |- my_newsletter.php | |- newslettux2/ |- admin/ |- img/ |- languages/ |- lib/ |- sql/ |- upload/ | |- form-newslettux.php In this example, starting from "my_newsletter.php", we need to open the subdirectory "newslettux2/" to access "form-newslettux.php" NTUX2_ROOT is equals to 'newslettux2/' For your information : the relative path to "form-newslettux.php" is : newslettux2/form-newslettux.php EXAMPLE 2 : ----------- http://www.yourwebsite.ext |- home.html |- contact.php | |- newslettux2/ |- admin/ |- img/ |- languages/ |- lib/ |- sql/ |- upload/ | |- form-newslettux.php |- my_newsletter.php In this example, starting from "my_newsletter.php", we are already in the "newslettux2/" directory to access "form-newslettux.php" NTUX2_ROOT equals then './' (understand "dot slash") For your information : the relative path to "form-newslettux.php" is : ./form-newslettux.php EXAMPLE 3 : ----------- http://www.yourwebsite.ext |- home.html |- contact.php | |- files/ | |- my_newsletter.php | |- newslettux2/ |- admin/ |- img/ |- languages/ |- lib/ |- sql/ |- upload/ | |- form-newslettux.php In this example, starting from "my_newsletter.php", we are in the "files/" directory. We need to open parent folder the open the subdirectory "newslettux2". NTUX2_ROOT equals then '../newslettux2/' (understand "dot dot slash") For your information : the relative path to "form-newslettux.php" is : ../newslettux2/form-newslettux.php For more information, please visit the webpage (french) : http://www.php-astux.info/chemins-relatif-absolu.php That's all for "form-newslettux.php" configuration. 3 - Into the page of your website, copy and paste this code : (replacing "XXX" by NTUX2_ROOT content that we have just filled) where you want the form to appear and that's done ! 4 - Report the address of the form page in the administration : "Configuration" > "Manage subscriptions" > "Subscription form URL" for my 3 examples : EX. 1 = http://www.yourwebsite.ext/my_newsletter.php EX. 2 = http://www.yourwebsite.ext/newslettux2/my_newsletter.php EX. 3 = http://www.yourwebsite.ext/fichiers/my_newsletter.php This is the page where the subscription will be processed (because this page contains the subscription form). The address is used as a link to unsubscribe, so watch after it. ~~ That's all folks ! ~~ IV ) Advanced configuration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1. RSS feed ------------ NewsletTux 2 offers a way to export as RSS feed your newsletters. You can choose between specifications RSS 2.0 or Atom 1.0 The explanations in the "newslettux_rss" file may be enough for you to configure it easily. To display a RSS feed of newsletter profile 1, use (and give) this link : format RSS 2.0 : http://www.yourwebsite.ext/newslettux2/newslettux_rss.php?feed=RSS&pid=1 format Atom 1.0 : http://www.yourwebsite.ext/newslettux2/newslettux_rss.php?feed=ATOM&pid=1 To display a RSS feed of newsletter profiles 1, 3 and 4 (for example), use this link : format RSS 2.0 : http://www.yourwebsite.ext/newslettux2/newslettux_rss.php?feed=RSS&pid=1,3,4 format Atom 1.0: http://www.yourwebsite.ext/newslettux2/newslettux_rss.php?feed=ATOM&pid=1,3,4 CAUTION : when you create a newsletter profile (cf. § II 1.), you must choose "public access" so that newsletter may be read throgh the RSS feed. Profiles with this box unchecked won't be readable in RSS. 2. Overloading a simple form ---------------------------- This paragraph is compatible starting from 2.1.0. version and only for the simple form (not NewsletTux 1.X like one) The simple form allows, by default, to have an only field "email" with 2 buttons "subscribe" and "unsubscribe". It is possible to force action ("subscribe" or "unsubscribe") and then hide these buttons. This makes it possible, for example, to have an only "email" field and an "OK" button. To do this, you have to include "form-newslettux.php" after declaring some variables. Here is an example form the "my_newsletter.php" file of example 1, of the code to insert where you want the form to appear : This example will subscribe visitor to newsletter profiles 2 (format : text) and 3 (format : HTML) and he'll receive a sum up in French. Use the 2 letters to name a language : fr, en, sp, de, it, ... according to the languages files you have installed. This overload erases the default subscriptions you chose in the config. of the simple form. V ) Help, support, license ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You'll find all necessary help on the forum for NewsletTux and your website here : http://www.php-astux.info/forum/index.php No mail support, please privilegiate the forum. The license is a CeCILL (http://www.cecill.info/licences.en.html) excepted "PHPMailer" class under GNU GPL, and smileys from CrystalXP. You accept by using the script the CeCILL license. You must let the license informations intacts (tux picture below the form, links, copyrights in the source code) Thanks for using NewsletTux, Matthieu