.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt ===================== EXT: PMK News Twitter ===================== :Author: Kasper Skårhøj :Created: 2002-11-01T00:32:00 :Changed: 2010-05-07T15:09:06.250000000 :Classification: pmkttnewstwitter :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: forEditors, forAdmins, forBeginners, forIntermediates :Author: Peter Klein :Email: pmk@io.dk :Info 4: :Language: en |img-1| |img-2| EXT: PMK News Twitter - pmkttnewstwitter .. _EXT-PMK-News-Twitter: EXT: PMK News Twitter ===================== Extension Key: pmkttnewstwitter Language: en Keywords: forEditors, forAdmins, forBeginners, forIntermediates Copyright 2000-2009, Peter Klein, Extension sponsored by: Hjulstad.no < `http://hjulstad.no/ `_ > 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: Table of Contents ----------------- `EXT: PMK News Twitter 1 <#1.EXT:%20PMK%20News%20Twitter|outline>`_ **`Introduction 3 <#1.1.Introduction|outline>`_** `What does it do? 3 <#1.1.1.What%20does%20it%20do_|outline>`_ `Screenshots 3 <#1.1.3.Screenshots|outline>`_ **`Users manual 4 <#1.2.Users%20manual|outline>`_** **`Administration 5 <#1.3.Administration|outline>`_** **`Configuration 6 <#1.4.Configuration|outline>`_** `Reference (TSConfig) 6 <#1.4.1.Reference%20(TSConfig)|outline>`_ **`Frequently Asked Questions 8 <#1.5.Frequently%20Asked%20Questions|outline>`_** **`Known problems 9 <#1.6.Known%20problems|outline>`_** **`To-Do list 10 <#1.7.To-Do%20list|outline>`_** **`Reporting Bugs 11 <#1.8.Reporting%20Bugs|outline>`_** **`Updates 12 <#1.9.Updates|outline>`_** **`ChangeLog 13 <#1.10.ChangeLog|outline>`_** .. _Introduction: Introduction ------------ .. _What-does-it-do: What does it do? ^^^^^^^^^^^^^^^^ - Adds Twitter entry when a tt\_news record is created or edited. - Optional link back to tt\_news singleView page can be added to Twitter post. - (If you don't want the news posted on Twitter, there's a checkbox named “Don't post on Twitter” on the news record.) .. _Screenshots: Screenshots ^^^^^^^^^^^ N/A .. _Users-manual: Users manual ------------ - Once the extension is installed and the Twitter username and password have been inserted in either Page or User TSConfig, creation or editing of tt\_news records will trigger post on Twitter. (Only is the field selected in the TSConfig options have been changed.) - On the tt\_news records there's now a new checkbox field named “Don't post on Twitter”. If this is checked, nothing will be posted to Twitter. .. _Administration: Administration -------------- - The extension must be configured using Page/User TSConfig, with the username and password of the Twitter account you want the news to be posted to. And what field should be posted/trigger posting. - See the Configuration section for an example. .. _Configuration: Configuration ------------- - The extension has 3 TSConfig options which must be set before Twitter posting will occur. - If the config options is placed in User TSConfig, it's possible to have different accounts depending on the BE user creating/editing the news item. - If placed in Page TSConfig it's possible to have different accounts depending on the page where the config options is placed. .. _Reference-TSConfig: Reference (TSConfig) ^^^^^^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _twitterUser: twitterUser """"""""""" .. container:: table-row Property twitterUser Data type string Description Username for your Twitter account. Default .. _twitterPassword: twitterPassword """"""""""""""" .. container:: table-row Property twitterPassword Data type string Description Password for your Twitter account. Default .. _postField: postField """"""""" .. container:: table-row Property postField Data type string Description The field to post on Twitter. If this field is changed the first 140 chars is posted to the Twitter account. Default title .. _linkBack: linkBack """""""" .. container:: table-row Property linkBack Data type boolean Description If set a link back to the page where tt\_news is inserted in singleView mode is added to the Twitter msg.This requires that the tt\_news singlePid have been set from TypoScript, or you use singlePids in the categories. It will NOT work if you only set the singlePid in the tt\_news plugin FlexForm. Default .. _useKeywordsAsHashTags: useKeywordsAsHashTags """"""""""""""""""""" .. container:: table-row Property useKeywordsAsHashTags Data type boolean Description If set, then the keywords field will be used as Hash tags when posting. Default .. _noPagePath: noPagePath """""""""" .. container:: table-row Property noPagePath Data type boolean Description If the PagePath extension is installed and this is set, then PagePath will NOT be used for generating the link back to the tt\_news post. Default .. _bitlyLogin: bitlyLogin """""""""" .. container:: table-row Property bitlyLogin Data type string Description Optional bit.ly login.If no bit.ly login & API key is provided, then the URL is shortened using tinyurl.com.Bit.ly has link tracking which tinyurl.com doesn't, but requires registration. Default .. _bitlyApiKey: bitlyApiKey """"""""""" .. container:: table-row Property bitlyApiKey Data type string Description Optional bit.ly API key. Default .. ###### END~OF~TABLE ###### [tsrconfig:tx\_pmkttnewstwitter] .. _generated: ((generated)) """"""""""""" .. _Example: Example ~~~~~~~ Insert configuration code like this on either Page or User TSConfig: For Page TSConfig, the code must be inserted like this: :: tx_pmkttnewstwitter { # Username of Twitter account. twitterUser = myTwitterUser # Password of Twitter account. twitterPassword = mySecretPassword #The field to post on Twitter postField = title # Insert link back to singleView page on site. linkBack = 1 # If set, then the keywords field will be used as Hash tags when posting. useKeywordsAsHashTags = 1 # If PagePath extension is installed, and this is set, # then PagePath WILL NOT be used for generating the links back to the site. noPagePath = 0 } For User TSConfig, the config option must be prepended with “page.”, like this: :: page.tx_pmkttnewstwitter { # Username of Twitter account. twitterUser = myTwitterUser # Password of Twitter account. twitterPassword = mySecretPassword #The field to post on Twitter postField = bodytext # Insert link back to singleView page on site. linkBack = 1 # If set, then the keywords field will be used as Hash tags when posting. useKeywordsAsHashTags = 1 # If PagePath extension is installed, and this is set, # then PagePath WILL NOT be used for generating the links back to the site. noPagePath = 0 } *Remember to change the username / password to that of your Twitter account.* .. _Frequently-Asked-Questions: Frequently Asked Questions -------------------------- **Q: I sometimes forget to check off the “Don't post on Twitter” checkbox, and as a result I have to go to my Twitter account and delete the entry. Is there a possibility to “revert” that, so that I have to check off the checkbox if I WANT to post on Twitter?** A: Not currently, but with Page TSConfig you can use TCAdefaults to make the checkbox checked by default when you create a new tt\_news record. That way you'll have to UNCHECK the checkbox before something is posted on Twitter. Insert this in the Page TSConfig on the sysfolder with your tt\_news records. :: TCAdefaults.tt_news.tx_pmkttnewstwitter_notwitter = 1 **Q: The links back to my site is not correct. What should I do?** A: Try removing the PagePath extension (or set the “noPagePath” in your Page TSConfig setup) This will make the extension create plain “index.php?id=” type of backlinks (This means \*NO\* RealURL or CoolUri translations of the URL.) *I suggest you write a bugreport at the PagePath Forge bugtracker, describing your setup. `http://forge.typo3.org/projects/extension- pagepath/issues `_* **Q: Instead of a backlink on Twitter, I get a “Error” text. What should I do?** A: Turn off the PagePath extension (or set the “noPagePath” in your Page TSConfig setup). **Q: I have SinglePid set in the FlexForm of the plugin and not in TypoScript, what should I do?** A: Create an EXT: TypoScript template on the the sysfolder where your tt\_news records are stored. Then insert this in the TypoScript setup field: :: plugin.tt_news.singlePid = Remember to change to the id of the sysfolder where the tt\_news records are located. .. _Known-problems: Known problems -------------- The plugin first checks if a Category is attached to the news record, with a singlePid set. If not it reads the TypoScript configuration of tt\_news (plugin.tt\_news.singlePid) to determine what page is used for singleView.So it WILL NOT WORK if you only set the singleView mode in the tt\_news plugin FlexForm!, as it's not possible to read the FlexForm settings form a BE extension. .. _To-Do-list: To-Do list ---------- Nothing planned, but ideas are welcome. .. _Reporting-Bugs: Reporting Bugs -------------- - If you discover a bug, please don't write the author(s) directly. Instead post a bug report at the Forge bugtracker: `http://forge.typo3.org/projects/show/extension-pmkttnewstwitter `_ - That way others can see your bug report and maybe add additional comment. It also makes it possible for all the extension authors to see what bugs are already been fixed by one of the other authors. .. _Updates: Updates ------- - If you like this extension, please rate it. `http://typo3.org/extensio ns/repository/view/pmkttnewstwitter/current/rating/ `_ - As ratings are the only way I can see if there's an interest in this extension, updates depends on people rating it. - **(No ratings = No updates)** For latest version, always check the Forge repository: `http://forge.typo3.org/projects/show/extension-pmkttnewstwitter `_ .. _ChangeLog: ChangeLog --------- - 07.May.2010 - Bug #7548: Fixed problems with tt\_news records posted to Twitter if the “hidden” checkbox was checked. (Thanks to Andreas Hirsch for reporting this.) - Bug #7545: Enabled “excludefield” for the “Post on Twitter” field. Now you can exclude the field from certain usergroups. (Suggested/reported by Andreas Hirsch) - 25.April.2010 - Added option to use the tt\_news “keywords” as “Hash Tags” for the Twitter post. (Option suggested by Andreas Hirsch) - 18.April.2010 - Fixed problems with national chars. Now data sent to twitter is correctly UTF-8 encoded. (Thanks to Paul Klimek for reporting this.) - Now filters out chars that Twitter doesn't like (even if they are encoded), such as “&”, “<” & “>”. - 11.April.2010 - Fixed problems with messages containing quotes and other special characters. (Thanks to Kurt Kunig < `www.kupix.de `_ > for reporting this.) - Added German translations. (Thanks to Kurt Kunig < `www.kupix.de `_ >) - Fixed problem with CURL and safe\_mode (Thanks to Sebastian Baumann for reporting this.) - Added FAQ section to the manual. - 09.April.2010 - PagePath extension is now optional. (Without it, the extension just generates a plain “index.php?id=” type of backlink.) This was done as PagePath uses the BE domain for generating the FE url, and in some cases (like when the BE is https and the FE is http or if running multiple domains in the same installation) this doesn't work. (Thanks to Egon Zemmer for reporting this.) - Added a new PageTSconfig option called “noPagePath”. If the PagePath extension is installed and this is set, then PagePath will NOT be used for generating the link back to the tt\_news post. - 19.Nov.2009 - Added Context Sensitive Help (CSH) . - 16.Nov.2009 - Added support for `http://bit.ly `_ URL shortner. Bit.ly has link tracking which tinyurl.com doesn't, but requires registration. - 12.Nov.2009 - Fixed some problems in ext\_emconf.php. - Removed htmlspecialchars around Twitter username/password. - Fixed problem with reference to calling object. (Error messages was not shown) - 11.Nov.2009 - First version released on TER. 13 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. |img-2| image:: img-2.png .. :border: 0 .. :height: 21 .. :hspace: 9 .. :id: Grafik2 .. :name: Grafik2 .. :width: 87