.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt ================== EXT: Page Comments ================== :Author: Steffen Kamper :Created: 2005-11-30T21:17:18 :Changed: 2007-06-04T01:05:28 :Classification: Add Comments to Your Page :Email: info@sk-typo3.de :Info 2: :Info 3: :Info 4: .. _EXT-Page-Comments: EXT: Page Comments ================== Extension Key: **sk\_pagecomments** Copyright 2005,Steffen Kamper, 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: Page Comments 1** **Introduction 1** What does it do? 1 Screenshots 1 **Users manual 3** Installation 3 Using the Plugin 3 Using the Plugin with tt\_news 3 **Quick Start 3** **Configuration 4** Teaser Object 5 Realurl 6 **To-Do list 6** **Changelog 6** .. _Introduction: Introduction ------------ .. _What-does-it-do: What does it do? ^^^^^^^^^^^^^^^^ Simply lets you add Comments to pages. You decide, which pages will get the comment functionality, simply place the plugin on these pages. Also there is a protection for reload, so you don't get double entries when user refreshes the page. All Features can be configured comfortably from the Setup. Special Feature: Webusers which are logged in don't need to fill out name/email, all other's data will be stored in cookie, if not disabled. .. _Screenshots: Screenshots ^^^^^^^^^^^ When you placed the plugin on a page ( normally as last element) it looks like this: |img-1| So when you click on the link you will see the comments and you are able to add a new comment. Thats all. .. _img-2-img-3: |img-2| |img-3| --------------- For easy managing all the comments of the site there is a Backend Module Web > Page Comments |img-4| .. _Users-manual: Users manual ------------ .. _Installation: Installation ^^^^^^^^^^^^ Go in the Ext. Manager and install sk\_pagecomments from online repository. .. _Using-the-Plugin: Using the Plugin ^^^^^^^^^^^^^^^^ Insert the Plugin on the page where you want to have comment function. You also can do it from TS like page.10.marks.COMMENTS < plugin.tx\_skpagecomments\_pi1 .. _Using-the-Plugin-with-tt-news: Using the Plugin with tt\_news ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ In tt\_news the News-Id is given with an url- parameter:tx\_ttnews[tt\_news] = newsid So create a ext-template for the page with the single-view. Use the setting :: plugin.tx_skpagecomments_pi1.bindToGETvar = tx_ttnews[tt_news] Place the plugin on this page. .. _Quick-Start: Quick **Start** ---------------- after installing was complete, you may configure the main options of your like. If you leave the starting point empty, records will be placed on current page. **hiding email icon from user-comment** :: plugin.tx_skpagecomments_pi1.commentEmail.if.equals = DontShow same is possible with homepage-icon and answer-icon (commentHomepage and answer) **reviewing new comments** :: plugin.tx_skpagecomments_pi1.hideNewMsg = 1 Use the Page Comments Module in Backend to unhide the comments. If you select the root icon, you see comments from all pages. **hide Form and show form-link** :: plugin.tx_skpagecomments_pi1.showForm = 0 plugin.tx_skpagecomments_pi1.showFormLink = 1 **notify new comments** **if you want to be notified on new comments configure following settings:** :: plugin.tx_skpagecomments_pi1.emailNewMessage = 1 plugin.tx_skpagecomments_pi1.emailAddress = xxx@yourdomain.com plugin.tx_skpagecomments_pi1.emailFrom = pagecomments@yourdomain .com **using the teaser** :: there is a prebuild object you can use directly: lib.commentTeaser use ObjectBrowser to change the values quickly. .. _Configuration: Configuration ------------- You may want to change some values for the plugin. Here are the initial values, which you can change in the TS-Setup: (You may edit all properties, open ext\_typoscript\_setup.txt to view all) .. ### BEGIN~OF~TABLE ### .. _CSS-DEFAULT-STYLE: \_CSS\_DEFAULT\_STYLE ^^^^^^^^^^^^^^^^^^^^^ .. container:: table-row Property \_CSS\_DEFAULT\_STYLE Data type string Description Default CSS-styles for skpagecomments .. _templateFile: templateFile ^^^^^^^^^^^^ .. container:: table-row Property templateFile Data type string Description Locates the Template file .. _commentNumber: commentNumber ^^^^^^^^^^^^^ .. container:: table-row Property commentNumber Data type stdWrap Description stdWrap for Number in Comments default setting is :: commentNumber.wrap = #| .. _commentName: commentName ^^^^^^^^^^^ .. container:: table-row Property commentName Data type stdWrap Description stdWrap for Name in Comments .. _commentEmail: commentEmail ^^^^^^^^^^^^ .. container:: table-row Property commentEmail Data type stdWrap Description stdWrap for Email in Comments .. _commentHomepage: commentHomepage ^^^^^^^^^^^^^^^ .. container:: table-row Property commentHomepage Data type stdWrap Description stdWrap for Homepage in Comments .. _answer: answer ^^^^^^ .. container:: table-row Property answer Data type stdWrap Description stdWrap for Answer in Comments .. _admin-hide: admin.hide ^^^^^^^^^^ .. container:: table-row Property admin.hide admin.unhide Data type stdWrap Description stdWrap for admin hide/unhide link .. _adminUser: adminUser ^^^^^^^^^ .. container:: table-row Property adminUser adminGroup Data type string Description Comma seperated list of users/groups that are allowed to hide/unhide comments .. _allowAnswer: allowAnswer ^^^^^^^^^^^ .. container:: table-row Property allowAnswer Data type int Description Value for allowing answer of comment - 1 = allow - 0 = forbid .. _answerMargin: answerMargin ^^^^^^^^^^^^ .. container:: table-row Property answerMargin Data type int Description Left margin of answer threads in px, default setting is 16 .. _homepageLink: homepageLink ^^^^^^^^^^^^ .. container:: table-row Property homepageLink Data type typolink Description Typolink for the Homepage, e.g. for open in a new window: :: homepageLink.target = '_blank' .. _comment: comment ^^^^^^^ .. container:: table-row Property comment Data type stdWrap Description stdWrap for Comments, default setting is :: comment.parseFunc < tt_content.text.20.parseFunc so the comment is oarsed like a normal text element replacing links etc. .. _showComments: showComments ^^^^^^^^^^^^ .. container:: table-row Property showComments Data type int Description Value for displaying the Comments - 1 = show - 0 = hide .. _showCommentsLink: showCommentsLink ^^^^^^^^^^^^^^^^ .. container:: table-row Property showCommentsLink Data type int Description Value for displaying the link to the Comments - 1 = show - 0 = hide .. _showForm: showForm ^^^^^^^^ .. container:: table-row Property showForm Data type int Description Value for displaying the Form - 1 = show - 0 = hide .. _showFormLink: showFormLink ^^^^^^^^^^^^ .. container:: table-row Property showFormLink Data type int Description Value for displaying the link to the form - 1 = show - 0 = hide .. _useSectionFormLink: useSectionFormLink ^^^^^^^^^^^^^^^^^^ .. container:: table-row Property useSectionFormLink Data type int Description 1 = adds #9999 to the link, that means it jumps automatic to the end of the form (default) .. _formLink: formLink ^^^^^^^^ .. container:: table-row Property formLink Data type typolink Description for adding params to the form link .. _showCount: showCount ^^^^^^^^^ .. container:: table-row Property showCount Data type int Description Obsolete ! New settings in blind .. _blind: blind ^^^^^ .. container:: table-row Property blind Data type array Description Settings to hide Items without removing their markers from template (1=hide) .. _blind-count: blind.count ^^^^^^^^^^^ .. container:: table-row Property blind.count Data type int Description If 1, hides total count of comments .. _blind-admin: blind.admin ^^^^^^^^^^^ .. container:: table-row Property blind.admin Data type int Description If 1, hides admin link .. _blind-email: blind.email ^^^^^^^^^^^ .. container:: table-row Property blind.email Data type int Description If 1, hides email link .. _blind-homepage: blind.homepage ^^^^^^^^^^^^^^ .. container:: table-row Property blind.homepage Data type int Description If 1, hides homepage link .. _blind-smileys: blind.smileys ^^^^^^^^^^^^^ .. container:: table-row Property blind.smileys Data type int Description If 1, hides smileys in commentform .. _blind-answer: blind.answer ^^^^^^^^^^^^ .. container:: table-row Property blind.answer Data type int Description If 1, hides answer link .. _blind-number: blind.number ^^^^^^^^^^^^ .. container:: table-row Property blind.number Data type int Description If 1, hides comment number .. _dateFormat: dateFormat ^^^^^^^^^^ .. container:: table-row Property dateFormat Data type string Description Formatstring for date, look at php.net/date for possible formatstrings you can format in 2 ways: date-format (e.g. Y-m-d, d.m.Y) strtotime-format (e.g. %a, %b %d) .. _showFormOnTop: showFormOnTop ^^^^^^^^^^^^^ .. container:: table-row Property showFormOnTop Data type int Description Shows Form on top of comments if set to 1 .. _sortOrder: sortOrder ^^^^^^^^^ .. container:: table-row Property sortOrder Data type string Description Value for the sort order of the comments, sorted by date - ASC = ascending - DESC = descending .. _sortOrderOnForm: sortOrderOnForm ^^^^^^^^^^^^^^^ .. container:: table-row Property sortOrderOnForm Data type string Description Value for the sort order of the comments, sorted by date while showing form - ASC = ascending - DESC = descending .. _maxRecords: maxRecords ^^^^^^^^^^ .. container:: table-row Property maxRecords Data type int Description Limit for the Comment Records. Leave empty for unlimited. .. _Unknown-Property: ((Unknown Property)) ^^^^^^^^^^^^^^^^^^^^ .. container:: table-row Property Data type Description .. _commentOnlyRegistered: commentOnlyRegistered ^^^^^^^^^^^^^^^^^^^^^ .. container:: table-row Property commentOnlyRegistered Data type int Description If set to 1. only registered Users are allowed to comment .. _showRegisteredFields: showRegisteredFields ^^^^^^^^^^^^^^^^^^^^ .. container:: table-row Property showRegisteredFields Data type int Description Value for displaying name/email for registered Users - 1 = show - 0 = hide .. _useCaptcha: useCaptcha ^^^^^^^^^^ .. container:: table-row Property useCaptcha Data type int Description Value for using captcha (must be installed) - 1 = use - 0 = nouse .. _useFreecap: useFreecap ^^^^^^^^^^ .. container:: table-row Property useFreecap Data type int Description Value for using frecap (must be installed and useCaptcha must be 0) - 1 = use - 0 = no use .. _emailNewMessage: emailNewMessage ^^^^^^^^^^^^^^^ .. container:: table-row Property emailNewMessage Data type int Description Value for sending notify email on new comments (emailAddress and emailFrom has to be set) - 1 = send - 0 = do not send .. _emailAddress: emailAddress ^^^^^^^^^^^^ .. container:: table-row Property emailAddress Data type string Description Recipient of notify email .. _emailFrom: emailFrom ^^^^^^^^^ .. container:: table-row Property emailFrom Data type string Description Sender of notify email .. _hideNewMsg: hideNewMsg ^^^^^^^^^^ .. container:: table-row Property hideNewMsg Data type int Description Value for setting new comments hidden - 1 = set hidden - 0 = do not set hidden .. _hideMsg: hideMsg ^^^^^^^ .. container:: table-row Property hideMsg Data type stdWrap Description stdWrap for Message if hideNewMsg=1 and a comment was posted, default setting is :: wrap =

|

.. _minCharsName: minCharsName ^^^^^^^^^^^^ .. container:: table-row Property minCharsName Data type int Description min. number of chars for name .. _minCharsComment: minCharsComment ^^^^^^^^^^^^^^^ .. container:: table-row Property minCharsComment Data type int Description min. number of chars for comment .. _useCookies: useCookies ^^^^^^^^^^ .. container:: table-row Property useCookies Data type int Description If >0 it'S the number of days the username and email will be stored in a cookie .. _If-you-use-Page-Comments-with-special-GETvars-e-g-For-use-with: If you use Page Comments with special GETvars, e.g. For use with ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. container:: table-row Property If you use Page Comments with special GETvars, e.g. For use with tt\_news, you can use following property .. _bindToGETvar: bindToGETvar ^^^^^^^^^^^^ .. container:: table-row Property bindToGETvar Data type string Description Use the determing GET-Var e.g. for tt\_news enter **bindToGETvar=tx\_ttnews[tt\_news]** .. ###### END~OF~TABLE ###### For using the Page Comments with tt\_news / sk\_simplegallery there is a hook implemented. Just edit your News-Template for LIST or LATEST and use the Marker ###COMMENTCOUNT### for displaying the count of comments for each News Entry. If you want to use the page Comments with other extensions and want to have implemented a simular method please let me know. .. _Teaser-Object: Teaser Object ^^^^^^^^^^^^^ Following object is predefined for teasing. You can use it in TS of your template or use Extension tscobj for inserting in pages. :: #Object for Teaser lib.commentTeaser < plugin.tx_skpagecomments_pi1 lib.commentTeaser { teaser = 1 teaser { entries = 5 } pageLink { stripHtml=1 crop = 5|...|1 } comment { #stdWrap for Comments stripHtml=1 crop = 35|...|1 } dateFormat = d.m.Y goto { override = } } .. _Realurl: **Realurl** ^^^^^^^^^^^ :: If you work with realurl, don't forget to set config.prefixLocalAnchors = all .. _To-Do-list: To-Do list ---------- Let me know .. _Changelog: Changelog --------- 0.0.1 First Release - 0.0.2 added Manual - missing comments - 1.0.9 changed the code completely, added new features, templatable - 1.0.10 added bindToGetVar for using with tt\_news etc., reverse Order with showing Form possible |img-5| EXT: Page Comments - 6 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.jpeg .. :align: left .. :border: 0 .. :height: 113 .. :id: Grafik1 .. :name: Grafik1 .. :width: 408 .. |img-2| image:: img-2.jpeg .. :align: left .. :border: 0 .. :height: 194 .. :id: Grafik2 .. :name: Grafik2 .. :width: 618 .. |img-3| image:: img-3.jpeg .. :align: left .. :border: 0 .. :height: 541 .. :id: Grafik5 .. :name: Grafik5 .. :width: 619 .. |img-4| image:: img-4.jpeg .. :align: left .. :border: 0 .. :height: 416 .. :id: Grafik6 .. :name: Grafik6 .. :width: 669 .. |img-5| image:: img-5.png .. :align: left .. :border: 0 .. :height: 32 .. :id: Graphic1 .. :name: Graphic1 .. :width: 102