.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt ========== 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: EXT: Forum ========== Extension Key: **ke\_forum** Copyright 2009-2010, Andreas Kiefer, 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: 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: Introduction ------------ ke\_forum is a forum extension for TYPO3 with basic functions.The configuration is easy and completely done in constants editor. .. _Installation: 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: Configuration ------------- All settings are done in constant editor. .. _generated: ((generated)) ^^^^^^^^^^^^^ .. _tx-keforum: tx\_keforum. """""""""""" .. ### BEGIN~OF~TABLE ### .. _pathToTemplateDirectory: pathToTemplateDirectory ~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property pathToTemplateDirectory Description The path to the directory where the template files are stored Default EXT:ke\_forum/templates/ .. _cssFile: cssFile ~~~~~~~ .. container:: table-row Property cssFile Description Path to the forums css file Default EXT:ke\_forum/res/css/ke\_forum.css .. _pid-storage: pid.storage ~~~~~~~~~~~ .. container:: table-row Property pid.storage Description PID of the SysFolder where the forum records are stored Default .. _pid-categories: pid.categories ~~~~~~~~~~~~~~ .. container:: table-row Property pid.categories Description PID of the page where the category plugin is inserted Default .. _pid-threads: pid.threads ~~~~~~~~~~~ .. container:: table-row Property pid.threads Description PID of the page where the threads plugin is inserted Default .. _pid-threads-add: pid.threads\_add ~~~~~~~~~~~~~~~~ .. container:: table-row Property pid.threads\_add Description PID of the page where the "add thread" plugin is inserted Default .. _pid-posts: pid.posts ~~~~~~~~~ .. container:: table-row Property pid.posts Description PID of the page where the posts plugin is inserted Default .. _pid-posts-add: pid.posts\_add ~~~~~~~~~~~~~~ .. container:: table-row Property pid.posts\_add Description PID of the page where the "add post" plugin is inserted Default .. _pid-search: pid.search ~~~~~~~~~~ .. container:: table-row Property pid.search Description PID of the page where the search plugin is inserted Default .. _pid-moderate: pid.moderate ~~~~~~~~~~~~ .. container:: table-row Property pid.moderate Description PID of the page where the moderation plugin is inserted Default .. _pid-profile: pid.profile ~~~~~~~~~~~ .. container:: table-row Property pid.profile Description PID of the page where the "edit profile" function is inserted Default .. _pid-printview: pid.printview ~~~~~~~~~~~~~ .. container:: table-row Property pid.printview Description PID of the printview page Default .. _teaser-count: teaser.count ~~~~~~~~~~~~ .. container:: table-row Property teaser.count Description The number of entries that are shown in teaser view Default 5 .. _teaser-maxChars: teaser.maxChars ~~~~~~~~~~~~~~~ .. container:: table-row Property teaser.maxChars Description The elements names in teaser view will be cropped after this number of characters Default 30 .. _date-format-default: date.format.default ~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property date.format.default Description The default format string for date Default %e.%B %Y, %H:%M Uhr .. _date-format-short: date.format.short ~~~~~~~~~~~~~~~~~ .. container:: table-row Property date.format.short Description The format string for short dates Default %e.%m %Y, %H:%M .. _date-format-member: date.format.member ~~~~~~~~~~~~~~~~~~ .. container:: table-row Property date.format.member Description The format string for "member since" Default %d.%B.%Y .. _date-format-teaser: date.format.teaser ~~~~~~~~~~~~~~~~~~ .. container:: table-row Property date.format.teaser Description The format string for dates in teaser view Default %d.%m.%Y .. _mail-sender-name: mail.sender\_name ~~~~~~~~~~~~~~~~~ .. container:: table-row Property mail.sender\_name Description The sender name that is used when a notification is sent Default forum@domain.de .. _mail-sender-email: mail.sender\_email ~~~~~~~~~~~~~~~~~~ .. container:: table-row Property mail.sender\_email Description The email address that is used as sender when a notification mail is sent Default noreply@domain.de .. _mail-forum-name: mail.forum\_name ~~~~~~~~~~~~~~~~ .. container:: table-row Property mail.forum\_name Description The forum name that is used in notification emails Default ke\_forum .. _mail-footer: mail.footer ~~~~~~~~~~~ .. container:: table-row Property mail.footer Description The footer that is used in notification mails Default Your forum team .. _mail-subject-notify-single: mail.subject.notify\_single ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row 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: mail.subject.notify\_cron ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property mail.subject.notify\_cron Description The subject that is used for daily reports Default New forum post .. _mail-subject-notify-moderator: mail.subject.notify\_moderator ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property mail.subject.notify\_moderator Description The subject for moderator notifications Default New forum post .. _mail-interval: mail.interval ~~~~~~~~~~~~~ .. container:: table-row Property mail.interval Description The interval for sending the daily report Default 1440 .. _mail-mailsPerRequest: mail.mailsPerRequest ~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property mail.mailsPerRequest Description The number of daily reports that are sent by once Default 2 .. _pagination-itemsPerPage: pagination.itemsPerPage ~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property pagination.itemsPerPage Description How many entries are shown per page Default 5 .. _pagination-itemsInBrowser: pagination.itemsInBrowser ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property pagination.itemsInBrowser Description How many page entries are shown in page browser Default 3 .. _add-showLatestPosts: add.showLatestPosts ~~~~~~~~~~~~~~~~~~~ .. container:: table-row 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: attachment.allowInNewThread ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property attachment.allowInNewThread Description Allow file attachments when creating a new thread; 1 activates, 2 deactivates Default 1 .. _attachment-allowInNewPost: attachment.allowInNewPost ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property attachment.allowInNewPost Description Allow file attachments when creating a new post; 1 activates, 2 deactivates Default 1 .. _attachment-maxFileSize: attachment.maxFileSize ~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property attachment.maxFileSize Description Set allowed maximum filesize for attachments in kB. Guilty for “new thread” and “new post” form; Default 2048 .. _attachment-allowedTypes: attachment.allowedTypes ~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property attachment.allowedTypes Description Set allowed filetypes for file attachments. Default gif,pdf,jpeg,jpg,txt,doc,bmp .. ###### END~OF~TABLE ###### .. _Caching-Information: 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: 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: 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: 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: Daily notifications ------------------- Please see EXT “ke\_forum\_notifications” for further information: `http://typo3.org/extensions/repository/view/ke\_forum\_notifications/ current/ `_ .. _Changelog: 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 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. :border: 0 .. :height: 101 .. :id: Grafik1 .. :name: Grafik1 .. :width: 118 .. |img-2| image:: img-2.png .. :align: left .. :border: 0 .. :height: 32 .. :id: Graphic1 .. :name: Graphic1 .. :width: 102