.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt .. role:: underline ================== EXT: TIMTAB Weblog ================== :Author: Kasper Skårhøj :Created: 2002-11-01T00:32:00 :Changed by: Ingo Renner :Changed: 2006-06-02T01:32:57 :Author: Ingo Renner :Email: typo3@ingo-renner.com :Info 3: :Info 4: .. _EXT-TIMTAB-Weblog: EXT: TIMTAB Weblog ================== Extension Key: **timtab** Copyright 2005-2006,Ingo Renner, < `typo3 @ingo-renner.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: Table of Contents ----------------- **EXT: TIMTAB Weblog 1** **Introduction 1** What does it do? 1 Requirements 1 Screenshots 1 Credits 2 Sponsors 2 Donate 2 **Users manual 2** An example page tree 2 Setting up a blog using the included template “Kubrick” 2 Setting up a blog in general without using the themes 4 Creating a blog post 4 Trackbacks 4 Blogging with external tools 4 FAQ 5 **Adminstration 5** Installation 5 Activation of Webservice – XML-RPC Interface 5 Trackback SPAM protection 5 FAQ 5 **Configuration 5** Reference 6 New template markers 7 **Known problems 8** **To-Do list 8** **Changelog 8** .. _Introduction: Introduction ------------ .. _What-does-it-do: What does it do? ^^^^^^^^^^^^^^^^ \- timtab is mainly a framework extension which connects other extensions, namely tt\_news, ve\_guestbook (modern guestbook) and realurl to use TYPO3 for blogging. You will use tt\_news to post, your visitors can comment these posts with ve\_guestbook and realurl delivers nice URLs. There will be 'optimal' default configurationsf or these extensions so you can start blogging (nearly) right away. Further this extension ships with the beautiful wordpress default template 'Kubrick'. With this template it is possible to set up a blog within a few clicks. .. _Requirements: Requirements ^^^^^^^^^^^^ TYPO3 3.8.0css\_styled\_contenttt\_news 2.2.0ve\_guestbook 1.7.5not required but recommended: realurl .. _Screenshots: Screenshots ^^^^^^^^^^^ |img-1| Included template “Kubrick” |img-2| additional fields for a blog post in a tt\_news record .. _Credits: Credits ^^^^^^^ Thanks to Kasper Skårhøj for TYPO3! Thanks to Rupert Germann for the awesome work on tt\_news. Valery Romanchev who provided the first patch for modern guestbook to use it as commenting system for tt\_news. Udo von Eynern as author of modern guestbook who integrated some hooks and patches in modern guestbook we are using. Thanks to Micheal Stucki for all his help and support so far. Last but not least a thanks goes to Ingo Schommer for the initial implementation of the metaweblog API. .. _Sponsors: Sponsors ^^^^^^^^ Thanks to Gerald Fränkl, Michael Janssen and Jens Schaller for the books and cds! .. _Donate: Donate ^^^^^^ If you enjoy using this extension and/or would like to see it enhanced, please donate a buck or two ... or fifty. I will use the money to keep my development hardware and software updated. If I had a girlfriend I would buy her dinner so she lets keep me working on this stuff for free and doesn't comlain. **`Make a Donation `_** You can also `check my amazon wishlist `_ if you don't like making donations via paypal. .. _Users-manual: Users manual ------------ .. _An-example-page-tree: An example page tree ^^^^^^^^^^^^^^^^^^^^ All of the following examples and explainations will be based on this example tree: |img-3| .. _Setting-up-a-blog-using-the-included-template-Kubrick: Setting up a blog using the included template “Kubrick” ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Go to our homepage [1] and create a main template record on the same page. Here you select from the right box “Include static (from extension)” the templates like shown in the screenshot below and in that order. |img-4| Next step is to insert two instances of Modern Guestbook on page [2]. One for the comments listing and one for the form. As Modern Guestbook can not be inserted via TS you have to do it manualy: |img-5| The last thing left is to set some options in the constants editor. To do this go to Template [1] --> page where you want to store the settings [2] --> Constants Editor [3] --> PLUGIN.TX\_TIMTAB [4]. |img-6| In our example we would set the following options: **required settings (timtab)** **pid to store posts in:** 6 **pid to store comments in:** 7 **Blog pid:** 2 **Home pid: 1** **Blog homepage:** `http://www.example.com `_ **required settings (tt\_news)** **backPid:** 1 **pid\_list:** 6 **catSelectorTargetPid:** 1 **required settings (ve\_guestbook)** templateFile = {$page.file.template\_ve\_guestbook} **recommended settings (timtab)** Title, Tagline **recommended settings (ve\_guestbook)** limit = 1000 **Blogroll settings (timtab)** To make the Blogroll work you need to set plugin.tx\_timtab\_pi1.pid\_list. (Set it to 8 for our example. That's it – we're done! Wasn't that fast? .. _Setting-up-a-blog-in-general-without-using-the-themes: Setting up a blog in general without using the themes ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Just create a website however you like. After installing tt\_news, ve\_guestbook and timtab you can use some additional markers in your tt\_news and ve\_guestbook templates. You can find a list of available markers further done in this manual. **»Simply create templates for tt\_news and ve\_guestbook like always. Just add the additional markers to the templates! «** .. _Creating-a-blog-post: Creating a blog post ^^^^^^^^^^^^^^^^^^^^ Simply create a regular tt\_news record and switch the type to “Blog Post” |img-7| .. _Trackbacks: Trackbacks ^^^^^^^^^^ Trackbacks will be discovered automaticly when saving a new post. Timtab is searching for trackback enabled sites every time you **change the bodytext field** . Simply link to a post using its **regular URL** or Permalink. If the other site supports trackback autodiscovery timtab will find the trackback URL itself and ping the other site. If the other site doesn't support trackback autodiscovery you can still put the **trackback URL** s in the trackback field, one per line. |img-8| After timtab has sent the pings you will see the results in the trackback field devided by a pipe character after the ping URL: - 1 stands for a successfull ping - 0 means that there was an error and will be followed by the according error message. More on trackback and what it is: `http://en.wikipedia.org/wiki/TrackBack `_ **A Note on Trackbacks:** When using xhtml\_cleaning in order to make it possible for other blogs to discover your trackback URLs automaticly it is necessary to patch a core file. The needed patch is provided in typo3conf/ext/timtab/res/patches. Use that patch against t3lib/class.t3lib\_parsehtml.php. Fo those who on't know how to do this there's also a ready patched file available from `my homepage `_ . Both the patch and the patched file are for TYPO3 3.8.0!An alternative is to turn off xhtml\_cleaning. .. _Blogging-with-external-tools: Blogging with external tools ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Before you can start bloggging with external tools it is necessary to set the Webservice (XML-RPC) settings. See the reference further down on this. Set the PIDs where you want the posts stored and enable the API you want to use. Your blog accepts XML-RPC requests on http://www.example.com/index.php?type=200 Use an existing BE username/password to login. [Example on how to set up w.bloggar goes here] .. _FAQ: FAQ ^^^ \- Possible FAQs .. _Adminstration: Adminstration ------------- .. _Installation: Installation ^^^^^^^^^^^^ Timtab requires TYPO3 version 3.8.0 as it uses some features which have been introduced in this version. Before you can install timtab it is required to have the following extensions in the given versions: .. _Activation-of-Webservice-XML-RPC-Interface: Activation of Webservice – XML-RPC Interface ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Todo: add description on how to set up the webservice .. _Trackback-SPAM-protection: Trackback SPAM protection ^^^^^^^^^^^^^^^^^^^^^^^^^ Since version 0.5.10 TIMTAB has a basic feature to prevent Trackback Spam. When receiving a Trackback TIMTAB fetches the sending URL and checks its content for a link to your own site. If no such link is found the Trackback Ping is considered Spam. This feature is turned on by default. You can turn it of by setting plugin.tx\_timtab\_pi2.trackback.validate = 0 After TIMTAB decided that a ping is Spam several things can be done with it. Default is to mark it hidden. Alternatively you can mark it as deleted, prevent TIMTAB from saving the ping at all or simply do nothing. The action is defined by the value for plugin.tx\_timtab\_pi2.trackback.spam.mark (see table below for values and corresponding actions) .. _Trackback-SPAM-handling-settings: Trackback SPAM handling settings """""""""""""""""""""""""""""""" .. ### BEGIN~OF~TABLE ### .. _2: -2 ~~ .. container:: table-row Value -2 Action Don't make a comment entry in the database at all .. _1: -1 ~~ .. container:: table-row Value -1 Action Mark the comment as deleted .. _0: 0 ~ .. container:: table-row Value 0 Action Do nothing .. _1: 1 ~ .. container:: table-row Value 1 Action Mark the comment as hidden (default) .. ###### END~OF~TABLE ###### [tsref:plugin.tx\_timtab\_pi2.trackback.spam.mark] .. _FAQ: FAQ ^^^ \- Possible subsections: FAQ .. _Configuration: Configuration ------------- Many of the following settings can be configured using the constants editor: |img-6| .. _Reference: Reference ^^^^^^^^^ .. _General-settings: General settings """""""""""""""" .. ### BEGIN~OF~TABLE ### .. _title: title ~~~~~ .. container:: table-row Property title Data type string Description Your blogs name Default timtab .. _tagline: tagline ~~~~~~~ .. container:: table-row Property tagline Data type string Description A short description for your blog Default Blogging with TYPO3 .. _homepage: homepage ~~~~~~~~ .. container:: table-row Property homepage Data type string Description The URL to your blog Default .. _homePid: homePid ~~~~~~~ .. container:: table-row Property homePid Data type int+ Description The pid of your homepage Default .. _blogPid: blogPid ~~~~~~~ .. container:: table-row Property blogPid Data type int+ Description The pid where your tt\_news SINGLE view of your tt\_news plugin resides Default .. _clearPageCacheOnUpdate: clearPageCacheOnUpdate ~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property clearPageCacheOnUpdate Data type int Description A comma separated list of page ids to clear the FE cache after a post or a comment has been created or modified Default .. _wrap: wrap ~~~~ .. container:: table-row Property wrap Data type wrap Description This wrap is required Default
    \|
.. _targetPid: targetPid ~~~~~~~~~ .. container:: table-row Property targetPid Data type Int+ Description Pid for the category links to point to. **Set this to make the category menu work!** Default .. _sortBy: sortBy ~~~~~~ .. container:: table-row Property sortBy Data type string Description A tt\_news table field to sort by Default title .. _sortOrder: sortOrder ~~~~~~~~~ .. container:: table-row Property sortOrder Data type string Description The sorting order: ASC for ascending, DESC for descending Default ASC .. _hideEmpty: hideEmpty ~~~~~~~~~ .. container:: table-row Property hideEmpty Data type boolean Description Hides categories with no posts when set Default 1 .. _list: list ~~~~ .. container:: table-row Property list Data type boolean Description Wraps the output in an