DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

EXT: mm_forum Extender¶

Author:	Kasper Skårhøj
Created:	2002-11-01T00:32:00
Changed by:	Erwin Knoll
Changed:	2008-10-06T07:56:56
Classification:	rsys_mmforum
Description:	The keywords help with categorizing and tagging of the manuals. You can combine two or more keywords and add additional keywords yourself. Please use at least one keyword from both lists. If your manual is NOT in english, see next tab "language" ---- forEditors (use this for editors / german "Redakteure") forAdmins (use this for Administrators) forDevelopers (use this for Developers) forBeginners (manuals covering TYPO3 basics) forIntermediates (manuals going into more depth) forAdvanced (covering the most advanced TYPO3 topics) see more: http://wiki.typo3.org/doc_template#tags ----
Keywords:	forAdmins, forIntermediates, mm_forum, notification, mail
Author:	Erwin Knoll
Email:	typo3coding@rootsystem.de
Info 4:
Language:	en

EXT: mm_forum Extender - rsys_mmforum

EXT: mm_forum Extender¶

Extension Key: rsys_mmforum

Language: en

Keywords: forAdmins, forIntermediates, mm_forum, notification, mail

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¶

EXT: mm_forum Extender 1

`Introduction 3 <#1.1.Introduction|outline>`_

What does it do? 3

Screenshots 3

`Users manual 5 <#1.2.Users%20manual|outline>`_

`Configuration 8 <#1.3.Configuration|outline>`_

Template selection 8

Template modification 8

Reference 11

`Known problems 12 <#1.4.Known%20problems|outline>`_

`To-Do list 13 <#1.5.To-Do%20list|outline>`_

`ChangeLog 14 <#1.6.ChangeLog|outline>`_

Introduction¶

What does it do?¶

The rsys_mmforum is a frontend plugin which adds additional features to the mm_forum extension. The version 0.1.0 has the following features

General¶

This extension is designed to work with mm_forum 0.1.7
It supports multiple languages for the mail templates (however templates are supplied only in german at this point of time)
Mails are in HTML Format and have a full HTML template with additional markers for text and subject.
Links to the forum in notification mails are now <a href...> tags in HTML and can be clicked from every mail client.
A footer can be added to all generated mails.
New markers are available: author, forum, text, footer

Subscriptions¶

Emails for notification of subscribed topics are generated by this extension and have all features described above

New topic notifications¶

If a new topic is created a notification mail will be sent to selected groups of the forum.
Each forum and each user group can be activated or deactivated for the new topic notification .
Selection of groups and activation of notification is inherited from the forum categories

Screenshots¶

Front end User group activation¶

Frontend user groups can be activated for notification using list view in the backend

Forum activation¶

Forums or forum categories can be activated for notification using list view in the backend

Email for new topic¶

HTML Templates can be modified to create a user defined notification mail

Users manual¶

Requirements¶

This extension requires:

mm_forum 0.1.7 (It might work with prior versions but this is not tested)
PHP4 or PHP5
Typo3 Version ≥4.0.2 (it is tested with 4.0.4)

Installation¶

Import/Download the extension and install it like every other extension.

Include the static template to your root page template

Usage¶

Activate a forum for notification¶

Use list view and navigate to the folder where your forum data is stored

Go to edit a forum and in the properties you will find a checkbox to activate the forum (or category) for notification on creation of new topics

Save the record

Activate a user group for notification¶

Use list view and navigate to the folder where your frontend users are stored

Go to edit a group and in the properties you will find a checkbox to activate the group for notification on creation of new topics

Save the record

Functionality¶

Notification in general¶

Since version 0.1.7 of mm_forum the author was notified of his own post. This extension changes that behavior so that the user who wrote the post (author) will not be notified.

New topic notifications¶

Group assignment¶

In the mm_forum Board Administration you can select groups for a category or a forum, which are organized hierarchically in two levels: Category →Forum. Groups can be assigned for:

Read access
Write access
Moderation access

All selected groups together, no matter in which section they are selected are used for notification of new topics. However only those groups which are activated for notification will be used.

Attention: Subgroups of a group will not be evaluated

Group inheritance¶

If there are groups selected for the category, they will be inherited by the forums below this category. If there are additional groups assigned to the forum they will be notified in addition to the inherited ones.

Example

Hierarchy:

Category A

→Forum A

Groups assigned:

Category A

Read access: Group A

Write access: Group B

Forum A

Read access: Group C

Notification:

If a new topic is created in Forum A all users of Group A, Group B and Group C will be notified. If a user is in more than one of those groups he will be notified only once – and of course only if the Forum and the group is activated for notification.

Best practice

Best practice will be to create extra groups for notification like “Mailing list forum A” and include it in the read access for a forum or category for the group members to be notified.

Activation inheritance¶

If a category is activated for notification all forums in this category will be selected for notification no matter if the activation check mark for a forum is set or not.

Example

Hierarchy:

Category A (notification activated)

→Forum A (notification not activated)

Groups assigned:

Category A

Read access: Group A (notification activated)

Write access: Group B (notification activated)

Forum A

Read access: Group C (notification not activated)

Notification:

If a new topic is created in Forum A all users of Group A and Group B will be notified. Attention: This is different from the inheritance of mm_forum access rights. Access rights will be inherited so that only users which are in Group A and in Group C or those which are in Group B and Group C will have access to Forum A .

In simple words this means that if you activate a category for notification all forums below will be activated too. Each forum will inherit the groups of the category in addition to the groups selected for the forum itself (a union of category and forum groups ).

Configuration¶

Template selection¶

If you want to configure you own modified template:

make a copy of the template in the extension directory EXT:rsys_mmforum/tmpl/template_rsysmmforum_de.html and place it e.g. to fileadmin/templates/ template_rsysmmforum_de.html

In the Setup section of your TS templates change the template path:

TS-CODE
plugin.tx_mmforum_pi1 {
 # template selection
        templateFile = fileadmin/template_rsysmmforum.html
 }

If you want a different template for each language you can extend the templateFile with the language key (default, en, de, it,...)

TS-CODE
plugin.tx_mmforum_pi1 {
         # template selection
        templateFile.default = fileadmin/template_rsysmmforum.html
   templateFile.de= fileadmin/template_rsysmmforum_de.html
 }

Template modification¶

###BOARDNAME###¶

Section

###BOARDNAME###

Description

Will be replaced with the Board name

###FORUMNAME###¶

Section

###FORUMNAME###

Description

Will be replaced with the Forum name

###TOPICNAME###¶

Section

###TOPICNAME###

Here the template as it is included in the extension directory tmpl/template_rsysmmforum_de.html

<!--

Template for rsys_mmforum

This is the html template for all notifications.

You can use a copy for each language by including in your TS Setup:

plugin.tx_mmforum_pi1 {

# template for content of mails

templateFile.default = typo3conf/ext/rsys_mmforum/tmpl/template_rsysmmforum_en.html

templateFile.de = typo3conf/ext/rsys_mmforum/tmpl/template_rsysmmforum_de.html

}

-->

<!-- ---------------------------------------------------------------

SUBJECT_ABO

This is the html template for subject of subscription notification

--------------------------------------------------------------- -->

Im Forum '###FORUMNAME###' wurde auf das Thema '###TOPICNAME###' geantwortet.

<!-- ---------------------------------------------------------------

TEMPLATE_ABO

This is the html template for subscription notification

--------------------------------------------------------------- -->

<html>

<head>

<title>Notification</title>

</head>

<body>

<h1>Hallo ###NAME###,</h1>

Sie bekommen diese Mail, da Sie angegeben haben, dass Sie informiert werden möchten,

wenn jemand auf ein von Ihnen beobachtetes Thema antwortet.

Thema:###TOPICNAME###

Text:###TEXT###

Autor:###AUTHOR_NAME### (###AUTHOR_EMAIL###)

Hier der Link, mit dem Sie direkt in den Beitrag gelangen: ###LINK###

###FOOTER###

</body>

</html>

<!-- ---------------------------------------------------------------

SUBJECT_NEWTOPIC

This is the html template for subject of new topic notification

--------------------------------------------------------------- -->

Im Forum '###FORUMNAME###' wurde ein neues Thema '###TOPICNAME###' eröffnet.

<!-- ---------------------------------------------------------------

TEMPLATE_NOTIFY

This is the html template for new topic notification

--------------------------------------------------------------- -->

<html>

<head>

<title>Notification</title>

</head>

<body>

<h1>Hallo ###NAME###,</h1>

Sie bekommen diese Mail, da Sie in der Verteiler-Gruppe des Forums sind.

Es wurde ein neuer Beitrag im Forum '###FORUMNAME###' von '###BOARDNAME###'geschrieben.

Thema:###TOPICNAME###

Text:###TEXT###

Autor:###AUTHOR_NAME### (###AUTHOR_EMAIL###)

Hier der Link mit dem Sie direkt in den Beitrag des neuen Themas gelangen: ###LINK###

###FOOTER###

</body>

</html>

<!-- ---------------------------------------------------------------

TEMPLATE_FOOTER

This is the html template for the footer appended to every mail

--------------------------------------------------------------- -->

<hr><imagesrc="http://www.example.com/images/logo.gif">Ihr Forum

<!-- ---------------------------------------------------------------

GOTO

This is the html template for the link text in every mail

--------------------------------------------------------------- -->

Zum Beitrag auf der Internetseite

Reference¶

((generated))¶

plugin.tx_mmforum_pi1¶

TS Values (setup section of TS templates)

templateFile¶

Property

templateFile

Data type

string

Description

The location of the HTML template Example

plugin.tx_mmforum_pi1 {
 # template selection
  templateFile = fileadmin/forumnotify.html
}

Default

EXT:rsys_mmforum/tmpl/template_rsysmmforum_de.html

templateFile.<langKey>¶

Property

templateFile.<langKey>

Data type

string

Description

The location of the HTML template for a certain language

Example

plugin.tx_mmforum_pi1 {
 # template selection
  templateFile.default = fileadmin/forumnotify.html
  templateFile.de= fileadmin/forumnotify_de.html
}

Default

Known problems¶

If the configuration value post_limit of mm_forum is not set, there will be a division by zero error. This is a not of my extension, but of mm_forum. Therefore I included in my static template a value for this (which might overwrite the value in your other templates, so be sure to set this to the desired value).

plugin.tx_mmforum_pi1 {
    post_limit = 30
}

To-Do list¶

Notification about downloads (extra activation check mark for categories, forums and user groups)
Notification about every new post (extra activation check mark for categories, forums and user groups)

ChangeLog¶

The following is a high level overview of the changes. For more details, see the ChangeLog file included with the extension.

0.1.1 beta¶

Version

0.1.1 beta

Changes

Update Release

New Markers:###NAME### Full Name##AUTHOR_USERNAME### Author's username###AUTHOR_NAME### Author's full name###AUTHOR_EMAIL### Author's email address

0.1.0 beta¶

Version

0.1.0 beta

Changes

Redesign Release

This release is the first “clean” one, however it has only the feature “notification of new topics” and improvement of mail notification on subscriptions (a mm_forum feature)

Nothing is hardcoded
Everything is template based
Notification is taken from the user groups assigned to forum and categories
Notification is inherited for category / forum and for user groups
Categories, forums and user groups can be activated for notification in the backend
Compatible with mm_forum 0.1.7 beta
No modification to mm_forum required

0.0.42 beta¶

Version

0.0.42 beta

Changes

Update release

Notification of one admin user about all new posts in activated forums
Notification of one admin user about downloaded files
mm_forum needs to be modified

0.3.0 beta¶

Version

0.3.0 beta

Changes

Initial release

Notification when a new topic is created
Configuration only via TS
Hardcoded Email text and Addresses

14

EXT: mm_forum Extender¶

EXT: mm_forum Extender¶

Table of Contents¶

Introduction¶

What does it do?¶

General¶

Subscriptions¶

New topic notifications¶

Screenshots¶

Front end User group activation¶

Forum activation¶

Email for new topic¶

Users manual¶

Requirements¶

Installation¶

Usage¶

Activate a forum for notification¶

Activate a user group for notification¶

Functionality¶

Notification in general¶

New topic notifications¶

Group assignment¶

Group inheritance¶

Activation inheritance¶

Configuration¶

Template selection¶

Template modification¶

Sections¶

###SUBJECT_ABO###¶

###TEMPLATE_ABO###¶

###SUBJECT_NEWTOPIC###¶

###TEMPLATE_NEWTOPIC###¶

###TEMPLATE_FOOTER###¶

###GOTO###¶

Markers for the subject sections¶

###BOARDNAME###¶

###FORUMNAME###¶

###TOPICNAME###¶

Markers for the content sections¶

###BOARDNAME###¶

###FORUMNAME###¶

###TOPICNAME###¶

###USERNAME###¶

###NAME###¶

###AUTHOR_USERNAME###¶

###AUTHOR_NAME###¶

###AUTHOR_EMAIL###¶

###TEXT###¶

###LINK###¶

###FOOTER###¶

Template¶

Reference¶

((generated))¶

plugin.tx_mmforum_pi1¶

Known problems¶

To-Do list¶

ChangeLog¶

0.1.1 beta¶

0.1.0 beta¶

0.0.42 beta¶

0.3.0 beta¶