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: Forum

Author:Andreas Kiefer
Created:2010-04-01T15:32:12.070000000
Changed by:Andreas Kiefer
Changed:2010-09-08T17:30:25.110000000
Author:Andreas Kiefer
Email:kiefer@kennziffer.com
Info 3:
Info 4:

EXT: Forum

Extension Key: ke_forum

Copyright 2009-2010, Andreas Kiefer, <kiefer@kennziffer.com>

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.com

Table of Contents

EXT: Forum 1

Introduction 1

Installation 2

Configuration 3

Caching Information 4

Known problems 4

Todo 4

Bugs and feature requests 4

Daily notifications for new posts 4

Changelog 5

Introduction

ke_forum is a forum extension for TYPO3 with basic functions.The configuration is easy and completely done in constants editor.

Installation

Install the EXT “div” from TER.

Install the EXT “lib” from TER.

The file “ext/lib/class.tx_lib_smartyView.php” tries to detect the EXT “rtp_smarty”. This EXT has been renamed to “smarty”, this causes an error in frontend saying “smarty is not availabe”. Please process the following changes:

  • rename “rtp_smarty” to “smarty”
  • rename “class.tx_rtpsmarty” to “class.tx_smarty”
  • rename “tx_rtpsmarty” to “tx_smarty”
  • rename “$this->pathToTemplates” to “$this->pathToTemplateDirectory”

Install the EXT “smarty” from TER.

Install the EXT “ke_forum” from TER.

img-1 Create the following pagetree structure, set all pages to “hide in menu” instead of “Forum”

Include all Static Templates regarding to “ke_forum”

Add plugin “Forum: Categories” to page “Forum”

Add plugin “Forum: Threads” to page “Threads”

Add plugin “Forum: Add Thread” to page “Add Thread”

Add plugin “Forum: Posts” to page “Posts”

Add plugin “Forum: Add Post” to page “Add Post”

Add plugin “Forum: Search” to page “Search”

Add plugin “Forum: Moderation” to page “Moderation”

Create a SysFolder “Forum”

Change configuration in constants editor (see chapter “Configuration” for further information)

Create Category records in SysFolder “Forum”

Configuration

All settings are done in constant editor.

((generated))

tx_keforum.
pathToTemplateDirectory

Property

pathToTemplateDirectory

Description

The path to the directory where the template files are stored

Default

EXT:ke_forum/templates/

cssFile

Property

cssFile

Description

Path to the forums css file

Default

EXT:ke_forum/res/css/ke_forum.css

pid.storage

Property

pid.storage

Description

PID of the SysFolder where the forum records are stored

Default

pid.categories

Property

pid.categories

Description

PID of the page where the category plugin is inserted

Default

pid.threads

Property

pid.threads

Description

PID of the page where the threads plugin is inserted

Default

pid.threads_add

Property

pid.threads_add

Description

PID of the page where the "add thread" plugin is inserted

Default

pid.posts

Property

pid.posts

Description

PID of the page where the posts plugin is inserted

Default

pid.posts_add

Property

pid.posts_add

Description

PID of the page where the "add post" plugin is inserted

Default

pid.moderate

Property

pid.moderate

Description

PID of the page where the moderation plugin is inserted

Default

pid.profile

Property

pid.profile

Description

PID of the page where the "edit profile" function is inserted

Default

pid.printview

Property

pid.printview

Description

PID of the printview page

Default

teaser.count

Property

teaser.count

Description

The number of entries that are shown in teaser view

Default

5

teaser.maxChars

Property

teaser.maxChars

Description

The elements names in teaser view will be cropped after this number of characters

Default

30

date.format.default

Property

date.format.default

Description

The default format string for date

Default

%e.%B %Y, %H:%M Uhr

date.format.short

Property

date.format.short

Description

The format string for short dates

Default

%e.%m %Y, %H:%M

date.format.member

Property

date.format.member

Description

The format string for "member since"

Default

%d.%B.%Y

date.format.teaser

Property

date.format.teaser

Description

The format string for dates in teaser view

Default

%d.%m.%Y

mail.sender_name

Property

mail.sender_name

Description

The sender name that is used when a notification is sent

Default

forum@domain.de

mail.sender_email

Property

mail.sender_email

Description

The email address that is used as sender when a notification mail is sent

mail.forum_name

Property

mail.forum_name

Description

The forum name that is used in notification emails

Default

ke_forum

mail.subject.notify_single

Property

mail.subject.notify_single

Description

The subject that is used for the notifications mail when an answer is created

Default

New forum post

mail.subject.notify_cron

Property

mail.subject.notify_cron

Description

The subject that is used for daily reports

Default

New forum post

mail.subject.notify_moderator

Property

mail.subject.notify_moderator

Description

The subject for moderator notifications

Default

New forum post

mail.interval

Property

mail.interval

Description

The interval for sending the daily report

Default

1440

mail.mailsPerRequest

Property

mail.mailsPerRequest

Description

The number of daily reports that are sent by once

Default

2

pagination.itemsPerPage

Property

pagination.itemsPerPage

Description

How many entries are shown per page

Default

5

pagination.itemsInBrowser

Property

pagination.itemsInBrowser

Description

How many page entries are shown in page browser

Default

3

add.showLatestPosts

Property

add.showLatestPosts

Description

This number of the latest posts is shown in “add post” form; Set to 0 if you want to deactivate this function

Default

2

attachment.allowInNewThread

Property

attachment.allowInNewThread

Description

Allow file attachments when creating a new thread; 1 activates, 2 deactivates

Default

1

attachment.allowInNewPost

Property

attachment.allowInNewPost

Description

Allow file attachments when creating a new post; 1 activates, 2 deactivates

Default

1

attachment.maxFileSize

Property

attachment.maxFileSize

Description

Set allowed maximum filesize for attachments in kB. Guilty for “new thread” and “new post” form;

Default

2048

attachment.allowedTypes

Property

attachment.allowedTypes

Description

Set allowed filetypes for file attachments.

Default

gif,pdf,jpeg,jpg,txt,doc,bmp

Caching Information

The plugins “Categories”, “Threads”, and “Posts” are USER objects, that means that they are cached and its contents are indexed. In case of generating a thread or a post in frontend, the cache has to be cleared so that the newest entry is visible. For this reason, ke_forum has its own cache handling. There is a method that detects and clears the cache-entries that fit the pages where the USER plugins are inserted and the parameters “thread” and “category”. The other plugins regarding to ke_forum are USER-INT objects, that means that they are not cached.

Known problems

The smarty problem in class.tx_lib_smartyView.php has to be resolved. I tried to XCLASS this file, but this had no effect. Looking for a better solution than manual editing....

Todo

  • The template designer used a lot of unnecessary HTML and CSS, this should be cleaned up
  • Integrate the extension “ke_insitemailbox” for an internal messaging system
  • Redirect after creating new post or thread

Bugs and feature requests

Please use the projects' TYPO3 Forge page to report issues: http://forge.typo3.org/projects/show/extension-ke_forum

Daily notifications

Please see EXT “ke_forum_notifications” for further information:

http://typo3.org/extensions/repository/view/ke_forum_notifications/ current/

Changelog

TER version 0.0.3

  • unused static template “cronjob” deleted
  • no longer used flexform configurations deleted
  • bugfix: show printview button only if printview pid is set
  • documentation updated

TER version 0.0.2

documentation updated

TER version 0.0.1

  • bugfix: “show latests posts” uses correct amount of posts now
  • new feature: file attachments
  • bugfix: set thread title field to maxlength of 255 chars (=tinytext)
  • bugfix: limit search to current category in threads view
  • new feature: show X latest posts in “add post” form
  • XSS-removal added
  • bugfix: users' total number of posts count was corrected
  • printview that shows all posts of a thread in a row added
  • bugfix: overflow auto set for textareas
  • bugfix: error with “reply” and “new thread” buttons and realUrl in IE8
  • ke_ukb interface added
  • bugfix: error with singleview link in single notification
  • bugfix: missing date in single notification mail
  • bugfix: default date format was not avaliable for mvc8
  • FE user fields moved to tab “Forum” in Backend
  • bugfix: Daily report
  • bugfix: Single Post Notification Mail
  • Notification mails changed to HTML templates
  • bugfix: text cropping for notification mail

img-2 EXT: Forum - 5