DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

EXT: DAM TV Connector

Author:Kasper Skårhøj
Created:2002-11-01T00:32:00
Changed:2007-12-19T12:51:17
Author:Author Name
Email:your@email.com
Info 3:
Info 4:

EXT: DAM-TV Connector

Extension Key: dam_tv_connector

Copyright 2000-2008, Christian Welzel, <gawain@camlann.de>

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

EXT: DAM-TV Connector 1

Introduction 1

What does it do? 1

Screenshots 1

User manual 2

Configuration 2

TypoScript example 3

Known problems 3

Multi-Language 3

Context Menu Integration 3

Changelog 3

Introduction

What does it do?

This extension is intended to help administrators to connect DAM and TemplaVoilà. Of course this can also be done manually by editing the XML of the Data Structure generated by TemplaVoilà. But this is a real pain as you have to convert the PHP array from DAM to XML and manual changes get lost every time you save the Data Structure.

This extension automates this process by inserting two new entries into the editing types of TemplaVoilà backend.

This extension does not provide the functions to render the associated files in the frontend, but relies on the extensions dam_ttcontent and dam_filelinks (css_filelinks) for this purpose.

Screenshots

img-1 This screenshot shows the two new entries in the editing types of TemplaVoilà backend.

User manual

The usage of this extension is confined to the installation from TER and selecting the DAM type which shall be used.

Because the frontend rendering of selected DAM files is left to other extensions (dam_ttcontent, dam_filelinks), please refer their manuals for further information.

img-2 Configuration

Although the new editing types contain all the necessary options, here is a reference of the TypoScript properties available, if calling this extension from outside the Data Structure.

additional.filePath

Property

additional.filePath

Data type

string/stdWrap

Description

Path to the files listed in additional.fileList

Default

additional.fileList

Property

additional.fileList

Data type

list/StdWrap

Description

Comma-separated list of files that will be added to the files retrieved by the connector

Default

refField

Property

refField

Data type

string/stdWrap

Description

TemplaVoilà field containing the files selected in the DAM

Default

refTable

Property

refTable

Data type

string/stdWrap

Description

Table from where the information should be fetched

Default

tt_content

random

Property

random

Data type

boolean/stdWrap

Description

Return a randomly chosen file rather than the whole list of files

Default

0

slide

Property

slide

Data type

boolean/stdWrap

Description

Slide up the page tree to find a non-empty value of the refField

Note that this property is usable only when the refTable is “pages”

Default

0

atIndex

Property

atIndex

Data type

string/integer/stdWrap

Description

Returns the image at the given position in the files array.

Possible String-Values: “first”, “last”

Default

TypoScript example

Here's how such a TypoScript might look:

lib.random_image = COA_INT
lib.random_image {
        10 = IMAGE
        10 {
                file {
                        import.cObject = USER
                        import.cObject {
                                refField = field_selection
                                refTable = pages
                                userFunc = tx_damtvc_tsfe->fetchFileList
                                random = 1
                                slide = 1
                        }
                }
        }
}

This script will fetch a list of files from a field called “field_selection” which is attached to a page. It will slide up the page tree to find a non-empty value of that field and take a random image from the retrieved list. Note how the IMAGE cObj is defined inside a COA_INT cObj so that the object is not cached (otherwise the random parameter would take effect only when the cache is cleared).

Known problems

  • This ext uses an XCLASS for EXT:templavoila/cm1/index.php therefore it can cause conflicts with other extensions XCLASSing the same file.
  • This extension is not compatible with content containers including several elements holding DAM elements. This is caused by the way DAM and TV are organizing their data.

Multi-Language

If you want to use this extension with a multi language setup you have to ensure that TYPO3 does not use inline translation of elements. You have to add this code into the XML of your FCE:

<meta>
    <langDisable>1</langDisable>
</meta>

Context Menu Integration

This makes it possible to show the TV context menu in the second level of Media>List module context menus.

Context menus works with DAM version 1.1 (beta) only!

Make sure to install TV after DAM. This can be done by sorting the extension comma list in typo3conf/localconf.php:

$TYPO3_CONF_VARS['EXT']['extList'] = ' ... ,dam,templavoila, ... ';

Changelog

  • 0.0.2 initial release
  • 0.0.3 added this manual
  • 0.0.4 fixed the bug that all images of all fce are shown on every page
  • 0.0.5: fixed the userFunc-Call in TS
  • 0.0.6: added content preview for image CE.
  • 0.0.7: added content preview for textpic CE
  • 0.0.8: Fixed problem with short php opening tag.
  • 0.0.9: added missing dependencies
  • 0.0.10: added clickmenu item for TV in file list (thx to Rene Fritz)
  • 0.0.11: Added random and slide functions (thanks to François Suter <fsuter@cobweb.ch>)

img-3 EXT: DAM-TV Connector - 4