Ccnewsletter Manual

ccNewsletter 1.0.4 beta 2 In this • • • • • •

manual you will find guides to: Installation Configuration Adding other languages Translating to new languages Changing the module layout Integration with Virtuemart 1.1

NO SUPPORT?! ccNewsletter is a free open source Joomla! extension, and because of that we offer no support! We have a support forum in place at http://support.chillcreations.com where users can help each other, and where you can find us occasionally searching for bugs and maybe helping out. But this is not official support, as ccNewsletter is offered for free as a "as is, where is" extension!

Please, don't e-mail us with your support questions! Read the manual, the FAQs and post in the forum! About ccNewsletter If you want to know more about ccNewsletter check out our website or the listing on the Joomla! Extensions Directory: ccNewsletter on http://extensions.chillcreations.com ccNewsletter on http://extensions.joomla.org Want a custom extension, Dutch hosting or Dutch Joomla! Education? Check out Chill Creations! Extensions We develop high quality Joomla! extensions and can do custom work for you to! We have a lot of experience and work fast and secure. ccNewsletter is just one of the components we have created in 2008/2009, send us an e-mail for some more examples. Dutch Joomla! Hosting Looking for a Dutch Joomla! Hoster that understands Joomla! completely? Try our Joomla! Proof servers. They are faster and more stable then the most hosters because we work on them ourselves and know how important it is to support Joomla! the full nine yards! Dutch Joomla! Education Living in the Netherlands and looking for an excellent Joomla! or Virtuemart training course? Check out our training courses that are given at our partner close to Utrecht: Joomla! and Virtuemart Trainings at de Karmel: http://www.dekarmel.nl/

NOTE: WYSIWYG editors Its best to use the WYSIWYG editor TinyMCE (Joomla! default) with ccNewsletter. Editors might want to make links you send to your subscribers relative, and thats not a good idea for a newsletter. We have a work around in place for the editors, but you can also turn off the relative urls function. In TinyMCE this can be done here: Extensions > Plugin manager > Editor TinyMCE > Absolute URLs >>> Also check the FAQ on http://support.chillcreations.com about this subject! Installation To install ccNewsletter, download the package from http://extensions.chillcreations.com and unzip it. 1. Log into your Joomla! 1.5 website and go to Extensions > Install/Uninstall 2. Click on "Upload file & Install" and find com_ccNewsletter.zip, install it. 3. Again, click on "Upload file & Install" and find mod_ccNewsletter.zip, and install it. 4. You have now installed ccNewsletter component and module. 5. Before you can use ccNewsletter you must configure it. Upgrading from earlier ccNewsletter versions Just uninstall your old ccNewsletter version and reinstall the new ccNewsletter version. All information and subscribers/newsletters will be saved! But always check you preferences. Upgrading from spsNewsletter Just install the ccNewsletter component in your Joomla! website next to spsNewsletter as explained in above. Check to see that ccNewsletter has copied all your subscribers, configuration details and newsletters. If so, just delete the old spsNewsletter component and module, all information is now migrated to ccNewsletter. Configuration You must configure ccNewsletter before use, or it will not function correctly. 1. 2. 3. 4. 5.

Login to your Joomla! 1.5 website and go to Components > ccNewsletter Click on the icon on the right "Parameters" Fill in all fields! Otherwise ccNewsletter will not work! Click save. If you have chosen to use the Acknowledgement function, go to Components > ccNewsletter > acknowledgement and fill in all fields if necessary.

About Batch Sending When your are sending a newsletter to more then 2000/3000 subscribers, please edit the Script Timeout in the component parameters. Depending on the speed of the server, change them to a maximum of 120. But this could mean that sending all newsletters might take up to 2 hours if the server is not fast enough. >>> Also check the FAQ on http://support.chillcreations.com about this subject!

Adding other languages ccNewsletter by default has the English languages files installed. If you want to install other files, you need to get them from the forum and upload them threw FTP or when not available translate them yourself. NOTE: Not all languages are fully translated! If a language is not fully translated you can do this yourself. Read on to do so! Check out the list of language short codes. 1. First of all, make sure the language you want to install is already installed as language for your Joomla! website via Extensions > Language Manager. 2. Then, to find your language file, visit http://support.chillcreations.com. 3. Go to Forum > ccNewsletter > Languages and search for your language. If it not there, no one has translated to your language yet. Consider doing this yourself and contributing the translation. If you do find it, continue. 4. In the folder admin find your administrator language file using the short codes. See the link to the short code list if you don't know the code for your language. 5. Upload the administrator language file to the following location: administrator/ languages/xx_XX where xx_XX stands for your languages short code. 6. In the folder site find your site language file using the short codes. See the link to the short code list if you don't know the code for your language. 7. Upload the site language file to the following location: languages/xx_XX where xx_XX stands for your languages short code. 8. The languages are now installed, if the other language is active in Extensions > Language Manager, ccNewsletter will now be displayed in your language. Translating to new languages To translate ccNewsletter to your language unzip com_ccNewsletter so you can find the translation files: • admin/en-GB.com_ccnewsletter.ini • site/en-GB.com_ccnewsletter.ini Open them in a file editor (not Word!) and translate them to your language, rename them (for example Italian would be it-IT.com_ccnewsletter.ini) and post them on the forum. List of language short codes.

Changing the module layout You can completely change the module layout to suit your needs, if you don't like the different styles thar are already selectable in the Module Manager in the Joomla! backend. You will need to have some xHTML and CSS knowledge. To change the xHTML structure, edit this file: /modules/mod_ccnewsletter/tmpl/default.php To change the CSS layout, change one of the files in this folder: /modules/mod_ccnewsletter/assets

Integration with Virtuemart 1.1 If you are using ccNewsletter 1.0.2+ and Virtuemart 1.1.2+ you can integrate the two components so a user can see a ccNewsletter registration box on the following locations: • in the registration form • in the account maintenance SU Synchronization There is also a "SU Synchronization" button in ccNewsletter when Virtuemart is installed, this is another function! You don't need this function if you are using the Virtuemart integration! The SU Synchronization button will sync all clients that have ordered something in Virtuemart with ccNewsletter, this is only a good feuture to use when you have selected "No account creation" in Virtuemart and are not useing the real "Virtuemart integration".

As far as we know ccNewsletter is the only Joomla! 1.5 Newsletter that has this option and is Joomla! 1.5 Native. The integration is supported by the ccNewsletter and the Virtuemart teams, and there are no hacks used whatsoever. So you are free to upgrade any one of the components at any moment you see fit. Follow these steps to setup the integration. 1. 2. 3. 4. 5. 6.

Only follow these steps after installing ccNewsletter 1.0.2 and Virtuemart 1.1.2 First off all, go to Extensions > ccNewsletter Click on the Parameters button in the toolbar All the way down select "Yes" at Virtuemart integration Then lets go to Virtuemart via Extensions > Virtuemart Select Admin > User Fields

7. 8. 9. 10. 11. 12.

We need to create a new user field for the Newsletter subscription Click New Select Newsletter subscription (ccNewsletter) in Field type Fill in ccnewsletter in Field name Fill in the other information as you would like to see it. The page might look like this:

13. Click save. 14. Use the reorder function in the user field list tio order the ccNewsletter registration box to a better place. In a default Virtuemart installation position 27 is great!

15. You will also need to make a delimiter to get the box shown in a nice way. Make another user field with this configuration:

16. Also reorder this to position: 26, one above the ccNewsletter registration box. 17. You are done! Test it now by checking the registration form in the front end!