Commenting system
Contents
1. Default template has many CSS classes which allows very customizable styling Commenting system 2 Atal netcreators aaa 2007 11 16 18 51 12 Lorem ipsum dolor sit amet consectetuer adipiscing elit Nam quis sapien sed augue facilisis consequat Donec pretium urna eget diam Phasellus consequat arcu at tellus Nulla in risus cursus diam iaculis fringilla In molestie Etiam accumsan Pellentesque sit amet eros wees Rating 2 5 of 5 2 vote s Click the rating bar to rate this item asdfasmdf a sdfm 2008 02 01 21 25 00 Nullam convallis tempor lacus Maecenas tortor Aliquam orci sem pharetra non luctus eget sodales vitae risus Pellentesque justo Maecenas tincidunt Morbi ac lectus sed magna tempus facilisis Morbi ac nibh facilisis nunc condimentum imperdiet Fusce fringilla gravida metus HH Rating 3 7 of 5 3 vote s Click the rating bar to rate this item Add comment required field First name Last name E mail Web site Location Enter the code 26 S46 Content Submit Reset Acknowledgments Creation of this extension was sponsored by Netcreators BV an international TYPO3 company from Netherlands Special thanks go to ben van t ende for his continuous supports reviews and advice during development process While developing this extension XMIND 2008 software was used for collecting ideas and making development plan Thanks to Mango Softw2. comments pil prefixToTableMap tx myext_ pil tx_myext_mytable So if URL looks like this http domain tld index php id 12345 amp tx_myext_pil showUid 67890 than comments extension will understand that it must refer to tx_myextmytable for triggering prefix tx_myext_pi1 showUid map gt SHOWUIDMAP Some old extensions use names other than showUid to refer to a single record Comments extension need to know this name to find record s uid By default only tt_news is configured in comments extension Here is how default map looks like showUidMap tx_ttnews tt_news All new extesions should use showUid parameter But it is possible to use custom parameter with comments extension Here is an example plugin tx_ comments pil showUidMap tx_myext pil uid So if URL looks like this http domain tld index php id 12345 amp tx_myext_pil uid 67890 than comments extension will understand that record s uid value is 67890 Using comments in other extensions tt_news Comments extension provides custom marker for tt_news to display number of comments inside List Latest or Search views Marker is TX_COMMENTS_COUNT By default it will produce the following HTML lt a href url to news item tx comments comments uid class tx comments count gt 5 comments s lt span gt Commenting system 8 Atal netcreators This HTML can be customized by modifying template supplied with comments extension See HETTNEWS_COMMENT_COUNT_SU
3. form Comment form 2 Triggering prefix pages 2 Store records at page General record storage EO Z x Page 2 Template file EXT comments res pii_template htm a Mode defines what the plugin displays comment listing and or form to add comments Triggering prefix defines what parameter in URL triggers displaying of comments The value depends on another plugin and its parameters Typically this parameter will be tx_extkey_pi1 but some older plugins have different values for example tx_ttnews for tt_news plugin Special value pages allows to comment on pages instead of records Note for plugin authors read Configuration section on information about enabling comments for your extension Storage page specifies where records should be stored If empty current page is used Template file shows template file to be used It can either a path related to web site root like fileadmin templates comments tmpl or relative to extension for example EXT comments res pi1_template Click on the globe icon to select file interactively using TYPOS file wizard General Advanced Anti spam 2 Comments per page 11 2 Close commenting after Advanced tab 2 Enable ratings Iv Show last comments first Comments per page specifies how many comments per page will be shown Close commenting after allows to automatically disable commenting if record is older than specified time period Time pe
4. hook is called when marker array is prepared for displaying comments list as whole Parameters Argument Type Description template string Template subsection to be used markers array Existing markers Hook should return a modified array with markers comments_getComments This hook is called when marker array is prepared for displaying a single comment in a list Parameters Argument Type Description template string Template subsection to be used markers array Existing markers row array Current comment row Hook should return a modified array with markers externalSpamCheck This hook is called when comments extension checks messages for spam Hook can add or remove spam points based on its own logic Parameters Argument Type Description formdata array A shortcut pObj gt piVars Commenting system 9 Atal netcreators Argument Type Description points int Currently earned points Hook should return integer value which will be added to current numver of spam points To block message completely accumulated points value must be greater than spamProtect spoamCutOffPoint elD_postProc This hook is called by elD script when comments extension approves or deleted comment using link in notificatiion e mail It allows to post process e mail commands Hook does not receive anu custom parameters form This hook is called w
5. AMPROTECT requiredFields_errorWr stdWrap stdWrap for required field if field is not filled properly noTrimWrap lt span class tx ap comments required error gt Error lt span gt prefixToTableMap gt PREFIXMAP Atal netcreators Commenting system 6 Property Data type Description Default showVidMap gt SHOWUIDMAP ratingsConfig ratings plugin Allows to specify alternative confguration for ratings empty configuration plugin Typical usage ratingsConfig lt plugin tx ratings pil ratingsConfig additionalCSS EXT myext res ratings_css_for_comments css Obviously userFunc is ignored This parameter is not defined by default and completely optional If default ratings configurations suits your needs do not define this parameter firstName_stdWrap string Wraps First name field empty lastName_stdWrap string Wraps Last name field empty email_stdWrap string Wraps E mail field empty webSite_stdWrap string Wraps Web site field empty location_stdWrap string Wraps Location field empty content_stdWrap string Wraps Content field empty Advanced options gt ADVANCED Property Data type Description Default commentsPerPage int Number of comments per one page 10 value of plugin tx_comm ents_pi1 commen tsPerPage constant closeCommentsAfter string If set automatically d
6. B subpart in the template tt_news marker is typically included after more link Known problems None yet Hooks Using hooks This section explains how to use hooks inside Comments extension and lists all available hooks New hooks can installed using the following code in ext_localconf php of another extension TYPO3 CONF_VARS EXTCONF comments hookName yourextkey EXT yourextkey class tx _yourextkey hooks php amp tx_yourextkey hooks gt methodName Notice that you can freely choose method name for the hook Common hook parameters Each hook receives two arguments Argument Type Description amp params array Contains hook parameters specific for each hook see hooks list below and pObj which is identical to pObj hook parameter amp pObj tx_comments_pi1 Reference to calling class Notice that you should have amp before this parameter name List of hooks Section name in this chapter corresponds to hookName in section Using hooks closeCommentsAfter This hook is called when comments extension must decide if commenting is closed for item Parameters Argument Type Description table string Table name uid int uid of the record Hook should return integer Unix time value to indicate if item is closed Returning false means do not know The first integer value stops processing of other hooks comments This
7. Commenting system Extension Key comments Copyright 2007 2009 Netcreators BV lt extensions netcreators com gt This document is published under the Open Content License available from http www opencontent org oplI shtml The content of this document is related to TYPO3 a GNU GPL CMS Framework available from www typo3 com Table of Contents Commenting system E 1 Configuration T soeeaeeneeeaseneeneeaeensnneaneneeseseanenteneentaneatans 6 INtrOAUCtION cccececeeseccesecceseeceseececeececeerseeeeceeneeeeeeeees 1 Main CONFIQUIALION eecseecstesee tees tees teen tteteetttenetes 6 What does it dO cssscscssssssssssssssesssssseeesesssesssseeeesseeces 1 Advanced options gt ADVANCED sseseree T FP EOUUIRES oen E A 1 Spam protection gt SPAMPROTECT sees 7 Sereen s hols sisanne aaae Eai aE 2 Prefix to table map gt PREFIXMAP ss sesso 8 ACKNOWIECQMENS eee eeceeeeeneeeeeneeeeetenennaeeeeeeeeeeees 3 showUid map gt SHOWUIDMAP cece 8 Having QUeStIONS cccccccscssessesceteteesesteteeeteeeeees 3 Using comments in other extensions 1 8 Users manual cccccesecceseececeececcececceseccereecaceecesensaceneees 3 ELMEWS sesseesseessneesetteneseneteneeeeneseneteneteseneeneenetenten 8 Inserting comments to P gen arsura ianiai 3 Hooks eed penedasnanesecnsnedeunedensoressunavadannenassieenededausseteeenacnanennes 9 Customizing COMMENES sssssssess
8. This procedure is not very clever but works in most cases Links are always created with rel nofollow and css class tx comments external autolink There is no way to change any of these two attributes reverseSorting boolean Reverses sorting of comments in List view Normally comments are 0 sorted from first to last Setting this value reverses the order Spam protection gt SPAMPROTECT Property Data type Description Default requireApproval boolean If enabled messages will be set to disapproved state and notification will 1 value of be sent to administrator see notificationEmail below If approval is not plugin tx_comm requested but checkTypicalSpam is set messages still can be set to ents_pi1 requireA disapproved state and notification is sent pproval constant Commenting system 7 Atal netcreators Property Data type Description Default useCaptcha string Enables using captcha to post comments Possible values are 0 value of 0O do not use captcha plugin tx_comm 1 use captcha extension ents_pi1 useCapt 2 use sr_freecap extension cha constant If value is not 0 corresponding extension must be installed to TYPO3 checkTypicalSpam boolean If set extension automatically checks all comments for typical guestbook 1 spam If comments receives more than 1 spam point it is automatically set to disapproved state and notification is sent to the author To November 18 2007 th
9. are for their exceptional mind mapping product Having questions Author kindly asks to post all questions to the English TYPO3 mailing list Please avoid sending e mails directly to author Users manual Inserting comments to page When inserting new content element scroll down to the end of New content element wizard and click on the Commenting system Commenting system gt Commenting system for pages and records news images etc This will insert a plugin for commenting system as a new content element This operation has to be done twice once for comment list another for comment form See next section for details on configuring the plugin Commenting system 3 Atal netcreators Customizing comments All comments options can be configured either through TypoScript or through plugin s configuration when it is inserted as content element TypoScript configuration should be used when plugin is inserted through TypoScript setup for example as TypoScript object path in TemplaVoila or as a part of flexible content element For information on TypoScript configuration see Configuration section later in this manual Warning Flexform configuration always override TypoScript configuration when corresponding field is not empty Plugin configuration consists from several tabs General tab General Advanced Anti spam 2 Mode Selected Items Comment listing 4 Comment listing Comment
10. comment appears on the page Check referrer forces extension to check that request comes from the same web site This option may have undesired results because many firewalls block referrer information and some browsers do not send this fields reliably It is recommended not to use this option unless you are really paranoid Use captcha allows to select one of two captcha extensions captcha or sr_freecap to use while submitting comments Corresponding extension must be installed Comments extension has good spam catching capabilities so you may wish to try without any captcha first captchas usually annoy users very much Send notification to this e mail specifies e mail address where to send messages with links to approve or delete comments Send e mail from this address contains from e mail address for notifications about new comments Template file for e mails contains template file for e mails See Template file on Basic tab for information on how to specify path to template Approving comments If comment is set to disapproved state because it may be spam or Require approval of each comment option is set comments will not be visible on the page Administrator will receive e mail with links to approve or delete comments Alternatively it can be done through Web gt List module Disapproved comments have different icon in the List module gt Comment E7 ci Suspendisse vestibulum purus nec augue Donec ac n EA Lorem ips
11. er If you do not know what translation server is read about it here To Do list Better screenshots in this manual External spam checkers Do you want to sponsor it Contact author by e mail in the beginning of the manual Commenting system 10 Atal netcreators
12. hen marker array is prepared for displaying form Parameters Argument Type Description template string Template subsection to be used markers array Existing markers Hook should return a modified array with markers mergeConfiguration This hook allows to alter add configuration values for tx_comments_pi1 There are no additional parameters to the hook Hook should modify configuration in the following way pObj gt conf section param value processSubmission This hook is executed before record is inserted into database Argument Type Description record array Record array Hook should return a modified record array sendNotificationMail This hook is called when marker array is prepared for sending e mail notification to administrator Parameters Argument Type Description template string Template subsection to be used check string Hashed check value for elD call markers array Existing markers Hook should return a modified array with markers processValidComment This hook is called when comment is posted and visible on the web site It is not called when comment is approved by the administrator manually Parameters Argument Type Description uid integer uid of the new comment record Return value is ignored Translating the extension Translation of the extension happens only and only through translation serv
13. is catches most ol guestbook spam considerReferer boolean If set checks that referer of the current page is within the same web site 0 If not message is set to disapproved state and notification is sent to administrator See Check referer in User guide for more information and risks associated with this option notificationEmail string E mail address to send notifications to fromEmail string E mail address to send notifications from emailTemplate string E mail template See Template file for e mails in User guide for more EXT comments re information s email txt spamCutOffPoint integer If number of points is greater than this value new comment is ignored 1000 user receives spam warning message and e mail to administrator is not sent Prefix to table map gt PREFIXMAP Comments extension must know table name of the commented record to perform automatic cleanup Extension s configuration contains a map of triggering prefix names to table names By default it looks like prefixToTableMap tx_album3x_pil tx_album3x_images prefixToTableMap tx_commerce pil tx_commerce_ products prefixToTableMap tx_irfaq_pil tx_irfaq q prefixToTableMap tx_mininews pil tx_mininews_news prefixToTableMap tx ttnews tt news Extension authors who want to enable commenting on their records may add entries to setu txt if their own extension to extend this map Here is an example how it should be done plugin tx_
14. isables commenting for items older than this period empty See Close commenting after in the User manual for more information dateFormat string Defines date format to use for date time information about posts Format empty specifiers depend on dateFormatMode configuration option See PHP function date and strftime for information about format specifiers If empty defaults to concatenation of SYS gt ddmmyy and SYS gt hhmm system variables from Install tool and dateFormatMode is foreced to date dateFormatMode string Determines what PHP function to use for date formatting Defaults to date date If you want to use month or week days in national language you have to use strftime Valid values are date strftime preFillFormFromFeuUse boolean If enabled and FE user is logged in fills form data with information from 1 r FE user record If sr_feuser_register is installed attempts to use its fields too enableRatings boolean If ratings extension is installed enables web site visitors to rate 0 comments Notice that ratings change is only available if comments are not closed for the item When comments are closed ratings automatically become read only autoConvertLinks boolean If enabled will search for possible links in comment text and turn them to 1 links Specifically the following texts are searched http www Anything that starts from these strings and till next space will be converted to links
15. riod is a number followed by suffix Suffix can be h hour m month y year or d day Comments extension takes care to change page caching time so that page cache expires when comments should be closed Enable ratings enables ratings for comment items This option is only available if ratings extension is installed Notice that users may rate comments only if comments are not closed for the item If comments are closed users will see ratings but will not be able to rate comments further The option to close comments must be set not only on form but also on listing plugin instance Commenting system 4 Atal netcreators Show last comments first reverses sorting order for comment listing Normally comments are display from first to last Checking this option reverses the order and last comments are show first Anti spam tab General Advanced Anti spam Require approval of each comment Check referer read manual O Use captcha read manual None kad Send notification to this e mail Send e mail from this address Template file for e mails EXT comments res email txt K S Require approval of each comment puts comments on hold and sends e mail to the e mail address in Send notification to this e mail with comment information submitted form fields and links to approve delete or kill i e completely remove from database Approving comment also clears cache for the page and approved
16. rough PHP strtoftime function Automatically clear cache for any page s when comment is added Close comments after predefined period Close comments for individual records immediately or after period through supplemental comments_ic extension Prevent duplicate comments for example several subsequent POST requests See IP address of the commenter in BE Import messages from ve_guestbook will be available soon Spam control O Filter out typical guestbook spam Oo Force all messages to pass approval O Automatically decide if message should be approved before it can appear on the web page O Send e mail to designated e mail address about suspicious messages Oo Hook to connect external spam checkers Full TYPO3 caching supported USER object which highly improves web site performance Automatic cleanup removes comments if parent record is removed External CSS stylesheet can be included through the template no need to modify web site TS setup for this Automatically use FE user data to fill comment form e Extends tt_news to show number of comments in LIST SEARCH and LATEST views e Integrates ratings from ratings extension Automatically find links in comment text and convert them to clickable links can be turned on and off Lots of hooks to customize comments Screenshots There are screenshots also in other sections of this manual This screenshot shows default template with default styles with ratings enabled
17. s table based tmpl tt_news News feed RSS RDF ATOM ttnews Commenting system comments News feed RSS RDF ATOM o Dai ati cal Property Data type Description Default code string COMMENTS or FORM Shows comments listing or COMMENTS form to submit comments storagePid integer list of Page uid where comment records will be stored empty value of integers Current page if empty plugin tx_comments_pi1 storageP Starting from version 1 4 0 can be a comma id constant separated list of page UID values Comments will searched in all thse pages but will be posted to the first page in this list externalPrefix string See Triggering prefix in User guide tx_ttnews the value of plugin tx_comments_pi1 external Prefix constant templateFile string Template file for the plugin Accepts either site relative EXT comments res pi1_template ht path or extension related path EXT prefix ml value of plugin tx_comments_pi1 template File constant additionalClearCacheP list of integers Addition page uid values to clear when comment is ages submitted or approved advanced gt ADVANCED preventDuplicatePosts boolean If set prevents duplicate posts on the same page 1 requiredFields list of values Comma separated list of fields to be required for firstname email content comments Available values firstname lastname email homepage location content spamProtect gt SP
18. ssessseessseesseeseeesees 4 Wsing NOOKS nenia E RE 9 Approving COMMENLS ccccccsesececscseeteteeseseteeeesees 5 Common hook parameters 9 Ne see aten eects cates ea nts ces ceah ee 5 List Of NOOKS ssssseesteesseeessseeteetetseteneteneteneteey 9 Administration ccccccccscssccsscessessessessssesseseesenseeseenseseess 6 Translating the extension 10 Adding TypoScript template cccseesseeeeeeeeeees 6 Bors lo ee 10 Introduction What does it do This extension provides commenting capabilities to TYPO3 pages or to virtually any TYPO3 record available in frontend in a single view like single news item single album image etc This extension may replace ve_guestbook extension in timtab or as commenting system for tt_news Separate extension is available to import all ve_guestbook comments to comments This extension was created by Dmitry Dulepov for the Netcreators BV Features Extension has the following features Comment pages Comment records Comments are displayed in pages Highly customizable template for example oO Number of messages per page O Show hide fields to comments e Available fields labels can be customized O First name Atal netcreators Commenting system 1 o Last name Oo E mail o Home page o Location city for example O Comment Set fields as required or optional E mail address syntax validation Fully localizable including date format th
19. um dolor sit amet consectetuer adipiscin The first item on the screenshot above is disapproved comment When opened for editing the following flag will define if comment is approved 2 d If check is set comment is approved Commenting system 5 A netcreators FAQ None yet Ask in the TYPO3 mailing lists Administration Adding TypoScript template Extension s TypoScript template must be added to site s TypoScript template To add a template go to Template submodule of Web module click on the Info Modify there and click Click here to edit whole template record link In the opened form scroll down to Include static from extensions and click Commenting system comments in the right box It should appear in the left box The following screen shot shows that fragment of the page 2 Selected Items CSS Styled Content css_styled_content AndreasO9 tmpl_andreasO9 3 Album album3x News feed RSS RDF ATOM cal default CSS styles cal CSS based tmpl cal CSS based tmpl tt_news default CSS styles ttnews Commenting system comments 3x Album album3x anaa csSsS basedtmpih cal default CSS styles cal Configuration Plugin configuration is explained in User manual This section talks about TypoScript configuration Main configuration ae a gee ae a i ee AndreasO9 tmpl_andreasO09 CSS based tmpl tt_news default CSS styles ttnew
Download Pdf Manuals
Related Search