.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt ========= Majordomo ========= :Author: Kasper Skårhøj :Created: 2002-11-01T00:32:00 :Changed: 2009-09-23T13:21:42 :Classification: majordomo :Description: Subscribing to and unsubscribing in majordomo mailing lists. You need a Majordomo list on the same Web-Server or any other Web-Server in the Word Wide Web. :Keywords: forAdmins, forDevelopers, forAdvanced, majordomo, mailing lists, mailing, list :Author: Dirk Wildt, Die Netzmacher :Email: wildt.at.die-netzmacher.de :Website: http://die-netzmacher.de :Language: en |img-1| |img-2| Majordomo (extKey: majordomo) |img-3| .. _Majordomo-Subscribe-to-mailing-lists: Majordomo - Subscribe to mailing lists ====================================== |img-4| Version: 1.1.1, 2009-09-23 Extension Key: majordomo Language: en Keywords: forAdmins, forDevelopers, forAdvanced, majordomo, mailing lists, mailing, list Copyright 2007-2009, Dirk Wildt, Die Netzmacher, This document is published under the Open Content License available from http://www.opencontent.org/opl.shtml The content of this document is related to TYPO3 \- a GNU/GPL CMS/Framework available from www.typo3.org .. _Table-of-Contents: Table of Contents ----------------- `Majordomo - Subscribe to mailing lists 1 <#1.Majordomo%20-%20Subscribe%20to%20mailing%20lists|outline>`_ `Introduction 3 <#1.1.Introduction|outline>`_ `What does it do? 3 <#1.1.1.What%20does%20it%20do_|outline>`_ `Features 3 <#1.1.1.1.Features|outline>`_ `What do you need 3 <#1.1.2.What%20do%20you%20need|outline>`_ `Update 3 <#1.1.2.Update|outline>`_ `Manual in PDF 3 <#1.1.2.Manual%20in%20PDF|outline>`_ `Screenshots 4 <#1.1.3.Screenshots|outline>`_ `Frontend 4 <#1.1.3.1.Frontend|outline>`_ `Configuration 4 <#1.1.3.2.Configuration|outline>`_ `DRS - Development Reporting System 4 <#1.1.3.3.DRS%20-%20Development%20Reporting%20System|outline>`_ `Installation 5 <#1.2.Installation|outline>`_ `Extension Manager 5 <#1.2.1.Extension%20Manager|outline>`_ `Option: DRS - Development Reporting System 5 <#1.2.1.1.Option:%20DRS% 20-%20Development%20Reporting%20System|outline>`_ `Option Check Mode 5 <#1.2.1.2.Option%20Check%20Mode|outline>`_ `Include Static Template 5 <#1.2.2.Include%20Static%20Template|outline>`_ `Create three Pages 6 <#1.2.3.Create%20three%20Pages|outline>`_ `Add a Majordomo Configure Record 6 <#1.2.4.Add%20a%20Majordomo%20Configure%20Record|outline>`_ `Configure Majordomo 7 <#1.2.5.Configure%20Majordomo|outline>`_ `Basics 7 <#1.2.5.1.Basics|outline>`_ `Form 7 <#1.2.5.2.Form|outline>`_ `Confirmation 8 <#1.2.5.3.Confirmation|outline>`_ `Majordomo Server 8 <#1.2.5.4.Majordomo%20Server|outline>`_ `Email 9 <#1.2.5.5.Email|outline>`_ `Remove the Cache 9 <#1.2.5.6.Remove%20the%20Cache|outline>`_ `Configure the Plugins 10 <#1.2.6.Configure%20the%20Plugins|outline>`_ `Confirmation 10 <#1.2.6.1.Confirmation|outline>`_ `Form 10 <#1.2.6.2.Form|outline>`_ `Test it! 11 <#1.2.Test%20it!|outline>`_ `Enable the Check Mode 11 <#1.2.7.Enable%20the%20Check%20Mode|outline>`_ `Subscribe to Majordomo 11 <#1.2.7.Subscribe%20to%20Majordomo|outline>`_ `Investigate the DRS Log! 12 <#1.2.8.Investigate%20the%20DRS%20Log!|outline>`_ `Subscribe with a real Email 12 <#1.2.8.Subscribe%20with%20a%20real%20Email|outline>`_ `Complete the Check Mode 12 <#1.2.8.Complete%20the%20Check%20Mode|outline>`_ `Configure the Email Template and HTML Output 13 <#1.3.Configure%20the %20Email%20Template%20and%20HTML%20Output|outline>`_ `Reference 14 <#1.4.Reference|outline>`_ `General Settings 14 <#1.4.1.General%20Settings|outline>`_ `Update 15 <#1.5.Update|outline>`_ `From < 1.0 15 <#1.5.1.From%20%3C%201.0|outline>`_ `Include Static Table 15 <#1.5.1.1.Include%20Static%20Table|outline>`_ `Delete tx\_majordomo\_pi1 15 <#1.5.1.2.Delete%20tx_majordomo_pi1|outline>`_ `Maintaine Your Majordomo Configuration 16 <#1.5.1.3.Maintaine%20Your%20Majordomo%20Configuration|outline>`_ `Check Your TypoScript with the DRS 16 <#1.5.1.4.Check%20Your%20TypoScript%20with%20the%20DRS|outline>`_ `Helpful Suggestions 17 <#1.6.Helpful%20Suggestions|outline>`_ `FAQ 18 <#1.7.FAQ|outline>`_ `SimulateStaticDocuments 18 <#1.7.1.SimulateStaticDocuments|outline>`_ `RealUrl 18 <#1.7.2.RealUrl|outline>`_ `Further Information 19 <#1.8.Further%20Information|outline>`_ `About the plugin icon 19 <#1.8.1.About%20the%20plugin%20icon|outline>`_ `Mojordomo Website and Wikipedia 19 <#1.8.2.Mojordomo%20Website%20and%20Wikipedia|outline>`_ `Other extensions published by Die Netzmacher 19 <#1.8.3.Other%20exten sions%20published%20by%20Die%20Netzmacher|outline>`_ `To-Do List 20 <#1.9.To-Do%20List|outline>`_ `Changelog 21 <#1.10.Changelog|outline>`_ `Illustration Index 22 <#1.10.Illustration%20Index|outline>`_ .. _Introduction: Introduction ------------ .. _What-does-it-do: What does it do? ^^^^^^^^^^^^^^^^ Extension for subscribing to and unsubscribing in majordomo mailing lists. .. _Features: Features """""""" A plugin with two frontend elements - a form for subscribing and unsubscribing, - a content element with a confirmation message. - The plugin verifies mail addresses. - Subscribers and unsubscribers will get a confirmation mail. - You can configure the plugin with an interface, you don't need to know nothing about TypoScript. - The plugin is configurable by editors. - With DRS - Development Reporting System. It supports you in cases of a unsuccessfully configuration. - Language support. .. _What-do-you-need: What do you need ^^^^^^^^^^^^^^^^ - A majordomo installation on your server or on a third party server. - An existing majordomo mailing list. .. _Update: Update ^^^^^^ Please read the section "Update" below. .. _Manual-in-PDF: Manual in PDF ^^^^^^^^^^^^^ You find this manual as PDF file at - doc/manual.pdf - `http://typo3.org/extensions/repository/view/majordomo/current/info/?t x\_terfe\_pi1%5BdownloadFile%5D=doc%252Fmanual.pdf `_ |img-5| .. _Screenshots: Screenshots ^^^^^^^^^^^ .. _Frontend: Frontend """""""" |img-5| |img-5| .. _Configuration: Configuration """"""""""""" |img-5| |img-5| .. _DRS-Development-Reporting-System: DRS - Development Reporting System """""""""""""""""""""""""""""""""" |img-5| .. _Installation: Installation ------------ .. _Extension-Manager: Extension Manager ^^^^^^^^^^^^^^^^^ Download the extension Majordomo form the TYPO3 online repository. |img-5| |img-5| - If you don't have installed the extension "devlog" (Developer Log), Majordomo will suggest to install it.You need "devLog", if you want to use the DRS - Development Reporting System. - Than load the extension Majordomo. .. _Option-DRS-Development-Reporting-System: Option: DRS - Development Reporting System """""""""""""""""""""""""""""""""""""""""" You can enable the DRS - Development Reporting System - with options in the select menu. If you enable it, the DRS will report every action of Majordomo to the Developer Log. See the section "Test it! below. .. _Option-Check-Mode: Option Check Mode """"""""""""""""" You can enable the Check Mode. The Majordomo extension will doesn't send any email and doesn't subrcribe or unsubsribe anybody. See the section "Test it! below. .. _Include-Static-Template: Include Static Template ^^^^^^^^^^^^^^^^^^^^^^^ |img-5| Select the item "Template" in the web modul. Select your root page or the page in the page tree, where you want to use the majordomo plugin. Click on the line "Click here to edit ..." below the table template tools. |img-5| - Select in the tab [Includes] the item "Majordomo (majordomo)" - "Majordomo (majordomo)" will be added to the selected items. .. _Create-three-Pages: Create three Pages ^^^^^^^^^^^^^^^^^^ |img-5| Create three pages like in the example above - Configuration (it has the uid 378 in our example) - Form (uid 22) - Confirmation (uid 21) .. _Add-a-Majordomo-Configure-Record: Add a Majordomo Configure Record ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |img-5| |img-5| Add the Majordomo Configuration Record to the Sysfolder Configuration (uid 378) like in the illustrations above. .. _Configure-Majordomo: Configure Majordomo ^^^^^^^^^^^^^^^^^^^ .. _Basics: Basics """""" |img-5| Name your configuration. Recommended titles are - Name of the website - Name of the majordomo list .. _Form: Form """" |img-5| Configure some HTML capabilities. You can set a tab index to your form. If you are allocates to this field the string "2\|3\|4" you will get the following tab indexes: - 2: Input Field: 2 - 3: Unsubscribe Button - 4: Subscribe Button |img-5| .. _Confirmation: Confirmation """""""""""" |img-5| HTML properties for the content element Confirmation. .. _Majordomo-Server: Majordomo Server """""""""""""""" |img-5| - Majordomo List Its the name of the majordomo list. - Email of the Majordomo Server It is the email address of the majordomo server. The majordomo server will process emails to this address as commands for subscribing and unsubscribing. |img-5| - Email of the List Owner The email of the list owner. It has to be the majordomo list owner email. - Default Email in the Input Field of the Form - Forbidden Mails (comma separated) A comma separated list of emails. The email of the majordomo server, the list owner and the default form email will added self-acting. .. _Email: Email """"" |img-5| Configuring of the confirmation email. This email has a template. If you want to edit the template, please read section "Configure the Email Template" below. The illustration below displays an email to a subscriber in the email client application thunderbird. |img-5| .. _Remove-the-Cache: Remove the Cache """""""""""""""" Please remove the TYPO3 cache, if you have changed any value in the Majordomo configuration. .. _Configure-the-Plugins: Configure the Plugins ^^^^^^^^^^^^^^^^^^^^^ .. _Confirmation: Confirmation """""""""""" Edit in the page properties of the page confirmation the general record storage page. |img-5| Add a plugin to the confirmation page. |img-5| Select the Majordomo plugin. Select the content element Confirmation. Select your configuration. If there isn't any configuration, it can have two reasons: - You didn't configure a record. Please read the section "Add a Configure Record" in this case. - The page configuration record hasn't any general record storage. .. _Form: Form """" |img-5| Edit in the page properties of the page form the general record storage page (see example confirmation page above). Add a plugin to the form page. Select the Majordomo plugin. Select the content element Form. Select your configuration. Select the confirmation page. .. _Test-it: Test it! -------- .. _Enable-the-Check-Mode: Enable the Check Mode ^^^^^^^^^^^^^^^^^^^^^ |img-5| Choose Admin Tool > Ext Manager and than the extension Majordomo. Enable the DRS - Development Reporting System. Select "All". Enable the Check Mode. Majordomo won't send any email, majordomo won't subscribe or unsubscribe. Klick [Update]. .. _Subscribe-to-Majordomo: Subscribe to Majordomo ^^^^^^^^^^^^^^^^^^^^^^ |img-5| Subscribe to majordomo with the default email. .. _Investigate-the-DRS-Log: Investigate the DRS Log! ^^^^^^^^^^^^^^^^^^^^^^^^ |img-5| Choose Admin Tools > Developer Log. .. _Subscribe-with-a-real-Email: Subscribe with a real Email ^^^^^^^^^^^^^^^^^^^^^^^^^^^ Now subscribe with a real Email. E.g your email. Don't take the email in our example: angela.merkel@cdu.de. Investigate the Developer Log. |img-5| The DRS displays the email to the majordomo server, the email to angela.merkel@cdu.de and last but not least an instruction, how to configure the email template, if you like another text. .. _Complete-the-Check-Mode: Complete the Check Mode ^^^^^^^^^^^^^^^^^^^^^^^ Please - disable the DRS and - disable the Check Mode. .. _Configure-the-Email-Template-and-HTML-Output: Configure the Email Template and HTML Output -------------------------------------------- |img-5| Open the TypoScript Object Browser: Web > Template Select your root page or the page with your majordomo static include template. Select plugin > tx\_majodomo\_pi1 Click on the item you want to edit e.g. [form\_title] .. _Reference: Reference --------- .. _General-Settings: General Settings ^^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _LOCAL-LANG: \_LOCAL\_LANG """"""""""""" .. container:: table-row Property \_LOCAL\_LANG Data type array Description Default Text for HTML output plugin.tx\_majordomo\_pi1 { \_LOCAL\_LANG { default { form\_title = Newsletter html\_subscribe\_button\_title = Get the\newsletter html\_subscribe\_button\_value = Subscribe ... } } } Default .. _CSS-DEFAULT-STYLE: \_CSS\_DEFAULT\_STYLE """"""""""""""""""""" .. container:: table-row Property \_CSS\_DEFAULT\_STYLE Data type text/CSS Description Default CSS styles for the majrodomo plugin form. plugin.tx\_majordomo\_pi1 { \_CSS\_DEFAULT\_STYLE ( .tx-majordomo-pi1-buttons { padding-top:0.4em; clear:both; height:2em; } .tx-majordomo-pi1-button\_left { float:left; width:49%; text-align:left; } .tx-majordomo-pi1-button\_right { text-align:right; float:right; width:49%; } ) } If you don't need it, please use this snippet in your TypoScript code: plugin.tx\_majordomo\_pi1 { \_CSS\_DEFAULT\_STYLE **>** } Default .. ###### END~OF~TABLE ###### .. _Update: Update ------ .. _From-1-0: From < 1.0 ^^^^^^^^^^ We replaced the configuration by TypoScript with the configuration by a plugin. You have to copy your datas from your current TypoScript configuration to the configuration record. .. _Include-Static-Table: Include Static Table """""""""""""""""""" If you make an update, please load the Include Static Template again. |img-5| .. _Delete-tx-majordomo-pi1: Delete tx\_majordomo\_pi1 """"""""""""""""""""""""" Select the Admin Tools > Install Select Database Analyzer Select Compare |img-5| Remove the table tx\_majordomo\_pi1 |img-5| Select Compare a second time. Remove table zzz\_tx\_majordomo\_pi1. If you like a last check, please click the option [Compare with $TCA]. .. _Maintaine-Your-Majordomo-Configuration: Maintaine Your Majordomo Configuration """""""""""""""""""""""""""""""""""""" Create a Majordomo configuration recordSee the section "Installation > Add a Majordomo Configure Record. Configure your pages with the Majordomo plugins.Every page with a Majordomo plugin needs a general record storage page.See section "Installation > Configure the Plugins > Confirmation. Configure the PluginsSee section "Installation > Configure the Plugins > Confirmation and Form. Remove your TypoScript Template, unless you are using TypoScript for removing CSS defaults or for the email templates like the code snippet below: plugin.tx\_majordomo\_pi1 { \_LOCAL\_LANG { default { mail\_subscribe\_subject = YOUR VALUES ... } } \_CSS\_DEFAULT\_STYLE > } .. _Check-Your-TypoScript-with-the-DRS: Check Your TypoScript with the DRS """""""""""""""""""""""""""""""""" You can check your TypoScript code with the DRS - Development Reporting System. You only have - to enable the DRS and - to subscribe to the Majordomo list. See section "Test it" above. .. _Helpful-Suggestions: Helpful Suggestions ------------------- If you have helpful suggestions, feel free to contact me: Dirk Wildt, wildt.at.die-netzmacher.de. .. _FAQ: FAQ --- .. _SimulateStaticDocuments: SimulateStaticDocuments ^^^^^^^^^^^^^^^^^^^^^^^ There isn't any problem known. .. _RealUrl: RealUrl ^^^^^^^ There isn't any problem known. .. _Further-Information: Further Information ------------------- .. _About-the-plugin-icon: About the plugin icon ^^^^^^^^^^^^^^^^^^^^^ |img-4| The concept of the icon: The letter is symbolizing email and email lists The color yellow is the color of Die Netzmacher ( `http://die- netzmacher.de `_ ), the company which created the Majordomo extension. .. _Mojordomo-Website-and-Wikipedia: Mojordomo Website and Wikipedia ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Majordomos home site: http://www.greatcircle.com/majordomo/ - Majordomo on Wikipedia: http://de.wikipedia.org/wiki/Majordomo .. _Other-extensions-published-by-Die-Netzmacher: Other extensions published by Die Netzmacher ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |img-6| Browser - Highway to Frontend. The Browser is the fast way for your data to the TYPO3 frontend. It displays content from related tables. You need 1 line typoscript for a result list with a search form, a record browser and an a-z browser. Images are wrapped self- acting. SEO, Search Engine Optimization. DRS supports the TypoScript configuration. `http://typo3.org/extensions/repository/view/browser/current/ `_ - |img-7| Juridat - Database for Juridical Data. Juridat provides a juridical data base with backend functionality. Juridat is out of the box. `http://typo3.org/extensions/repository/view/juridat/current/ `_ - |img-8| logical\_form: A frontend plugin for evaluating forms. I.e you can evaluate mail addresses. `http://typo3.org/extensions/repository/view/logical\_form/current/ `_ - |img-9| rm\_staticfile: Improve your performance! This extension enables the delete of static files, which where generated by nc\_staticfilecache. It is a team play with the TYPO3 cache management, ttnews, ttnewscache, sg\_newsplus and sg\_zfelib. `http:// typo3.org/extensions/repository/view/delete\_staticfile\_by\_3party/cu rrent/ `_ - |img-10| seo\_dynamic\_tag: You can generate values dynamically with this extension especially for the -tag, for the <meta>-tag description and the <meta>-tag keywords. `http://typo3.org/extensions/ repository/view/seo\_dynamic\_tag/current/ <http://typo3.org/extension s/repository/view/seo_dynamic_tag/current/>`_ - |img-11| tt\_news Marker (extkey: ttnews\_marker) enables to add any marker to a tt\_news HTML template including links. Any marker has the std\_wrap property. `http://typo3.org/extensions/repository/view/ttnews\_marker/current/ <http://typo3.org/extensions/repository/view/ttnews_marker/current/>`_ - |img-12| tt\_news select configuration (extkey: ttnews\_selectconf) enables to select tt\_news by any SQL clause. The extension adds an andWhere clause to the SQL query of the tt\_news plugin. I. e. it is possible to display tt\_news items in dependence on the ownership of a fe\_user. `http://typo3.org/extensions/repository/view/ttnews\_selectc onf/current/ <http://typo3.org/extensions/repository/view/ttnews_selec tconf/current/>`_ .. _To-Do-List: To-Do List ---------- Nothing to do. .. _Changelog: Changelog --------- - 1.1.1 **New Sub Versio** - New Features- Editing of Email Templates and HTML Templates is simplified - 1.0.1 **Major Version Release** - New Features- Configuring with Flexform- DRS - Development Reporting System - 0.0.5 **Propering Project** - 0.0.4 **Improvement** - Configurable charset for mail- Changing status from alpha to beta - 0.0.3 **Improvement** Form and buttons got a class - 0.0.2 **Manual** Publishing the English edition - 0.0.1 **Initial Release** .. _Illustration-Index: **Illustration Index** ---------------------- Illustration 1: Manual in PDF format 3 Illustration 2: A website with the majordomo plugin "form" 4 Illustration 3: A website with the majordomo plugin "confirm" 4 Illustration 4: Screenshot of the plugin in the backend 4 Illustration 5: Screenshot of the configuration record 4 Illustration 6: Logs with email to majordomo and the subscriber 4 Illustration 7: Import of devlog 5 Illustration 8: Extension manager with Majordomo 5 Illustration 9: Include static template 5 Illustration 10: Include the Static Template 6 Illustration 11: Three pages 6 Illustration 12: Web > List - Add a record 6 Illustration 13: Select the Majordomo configuration record 6 Illustration 14: Basics 7 Illustration 15: Form 7 Illustration 16: Form with Tab Indexes 7 Illustration 17: Confirmation 8 Illustration 18: Mdom Server 8 Illustration 19: Email to the majordomo server 8 Illustration 20: Mdom Server 9 Illustration 21: Mail to the subscriber 9 Illustration 22: General Storage Page 10 Illustration 23: Plugin on the confirmation page 10 Illustration 24: Plugin on the confirmation page 10 Illustration 25: Test configuration 11 Illustration 26: Subscribe 11 Illustration 27: DRS - Development Reporting System 12 Illustration 28: DRS - Development Reporting System with the emails 12 Illustration 29: \_LOCAL\_LANG array in the TypoScript Object Browser 13 Illustration 30: Include the Static Template 15 Illustration 31: Comparing with the Database Analyzer 15 Illustration 32: Remove tx\_majordomo\_pi1 15 22 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. |img-2| image:: img-2.png .. :border: 0 .. :height: 27 .. :hspace: 4 .. :id: Grafik2 .. :name: Grafik2 .. :width: 98 .. |img-3| image:: img-3.png .. :align: bottom .. :border: 0 .. :height: 27 .. :id: graphics1 .. :name: graphics1 .. :width: 30 .. |img-4| image:: img-4.png .. :align: bottom .. :border: 0 .. :height: 268 .. :id: graphics21 .. :name: graphics21 .. :width: 302 .. |img-5| image:: data: :alt: Frame80 .. :align: bottom .. :id: Frame80 .. :name: Frame80 .. |img-6| image:: img-6.png .. :align: bottom .. :border: 0 .. :height: 16 .. :id: graphics36 .. :name: graphics36 .. :width: 18 .. |img-7| image:: img-7.png .. :align: bottom .. :border: 0 .. :height: 16 .. :id: graphics40 .. :name: graphics40 .. :width: 18 .. |img-8| image:: img-8.png .. :align: bottom .. :border: 0 .. :height: 16 .. :id: graphics38 .. :name: graphics38 .. :width: 18 .. |img-9| image:: img-9.png .. :align: bottom .. :border: 0 .. :height: 16 .. :id: graphics18 .. :name: graphics18 .. :width: 18 .. |img-10| image:: img-10.png .. :align: bottom .. :border: 0 .. :height: 16 .. :id: graphics37 .. :name: graphics37 .. :width: 18 .. |img-11| image:: img-11.png .. :align: bottom .. :border: 0 .. :height: 16 .. :id: graphics51 .. :name: graphics51 .. :width: 18 .. |img-12| image:: img-12.png .. :align: bottom .. :border: 0 .. :height: 16 .. :id: graphics50 .. :name: graphics50 .. :width: 18