Dam 1.1. Documentation

Extension detail information dam
	DAM 1.1 Documentation This page is for co-ordinating DAM 1.1. Documentation-Updates. In addition it can & should be used for adding missing or fixing missleading parts of the documentation.
documentation state	draft licence OCL
forgeproject
mailinglist
usergroups	forDevelopers
author(s)	Pee Jee Kruidhof
TER category	module
dependency

<< Back to Extension manuals page

[edit]

Initial Document-Structure, -Chapters & -Numbering are taken from http://typo3.org/documentation/document-library/extension-manuals/dam/1.0.13/view/ only;

Pee Jee Kruidhof will rewrite the DAM 1.1 Documentation, any suggestions or remarks are welcome.

You may / wanna / should: - Found a Mistake in the old docu: add simple notes to the respective chapter - Adopt a chapter reworking the docu for 1.1: add a note to the respective chapter, that you started working on it and/or link to a new wiki-page with the documentation work in progress and / or finally deliver finished chapters to Ben or Pee Jee via Mail. - Resort the structure / numbering by adding such; however please keep the old numbers so we have a common base

In case of questions, please raise them in typo3.projects.dam

Introduction

What is a Digital Asset Management System?

A DAM system is a tool to handle digital content like images, text files and virtually any other data format.

These media files can be attributed with meta information. Such information can describe the content (description, keywords, location), provide technical data (image size) or copyright information for example.

All this information can be used to handle, find and categorize the media files.

Two different forces drive the necessity for advanced management of such assets:

Large number: even smaller sites tend to produce large numbers of assets, often stored in random folders and with incoherent naming, making the organization and overview increasingly hard over time. Digital asset management adds a meta-layer of information to every file in a semi-automatic indexing process, allowing users to search for attributes in a database associated with the files.

Automated retrieval: assets as building blocks for content often are used to produce automated output, like image galleries and download areas. Digital asset management serves these output functions by providing an interface for retrieving assets filtered by any combination of meta data criteria.

New in this version

• Auto-indexing
• Full integration in the TYPO3 skin (docheaders)
• Full integration with workspaces
• Create categories from folders
• Batch processing of files (delete, move etc.)
• Add indexing configuration to folders (XML config)

TYPO3 DAM

The DAM is similar to the File module integrated into the TYPO3 backend as a main module. It will replace the File module when finished, which means all file handling like copying, deletion and renaming of files is provided by the DAM. Nevertheless the DAM don't use a new storage type for files. The files are stored into the file system as before.

Installation of DAM

To get a good functioning system you will have to install several other extensions as well besides the DAM extension itself. The first three will eventually be merged together.

• dam
• dam_catedit
• dam_index
• dam_cron
• dam_ttcontent

DAM Services

• cc_metaexif
• cc_metaexec
• cc_txtextexec
• cc_txtextphp
• cc_langguess

More about DAM and TYPO3

Outlook

DAM 1.2 will focus on adding more flexibility to DAM to allow localizations and versioning of files and folders. Performance and usability will also be emphasized.

Backend Modules

"Media>List>Selection" - this should no longer be there

"Media>Info>References" - never really implemented?

DAM and RTE

Basic Configuration of DAM and RTE via the Ext Manager

To make use of DAM when inserting file links or images in RTE, first make sure that both RTE and DAM are configured correctly via the Ext Manager:

• For htmlarea RTE make sure that the option Enable the DAM media browser is not checked! The DAM connector inside RTE will only work for DAM version prior to 1.1.
• For DAM, ensure that the option media tag is checked!

With these settings DAM introduces a new transformation mode txdam_media that transforms links into a custom tag <media> on the way to the database and back to <a> on the way from database to RTE and from database to frontend. This is done by adding some RTE-related configuration to your Page TSconfig and to your template (lib.parseFunc and lib.parseFunc_RTE).

The example below shows the metamorphosis of a link to a photoshop psd-file from RTE to database to frontend:

• in RTE: <a href="http://spinne.uni-erfurt.t3/fileadmin/kladde/default_01.psd" txdam="356" class="download" title="UNDEFINED, Photoshop-Datei zum Collagen basteln, default_01.psd, 53 MB" rtekeep="1">dicke, fette Photoshop-Datei</a>
• in DB: <media 356 - download>dicke, fette Photoshop-Datei</media>
• in FE: <a class="download" title="default_01.psd (53 MB)" href="fileadmin/kladde/default_01.psd">dicke, fette Photoshop-Datei</a>

It is essential for DAM to work with RTE that these basic settings really take effect in your installation which they might not if you manage your Page TSConfig and/or your template through an extension loaded after RTE and DAM. So you should check this and adapt your configuration manually if necessary. Details follow below.

Checking your Page TSConfig

Under Web->Info select Page TSConfig and in the select list below RTE.. Check whether txdam_media is present in the comma separated list of the following object paths:

• RTE.default.proc.overruleMode = ts_css,txdam_media
• RTE.default.FE.proc.overruleMode = ts_css,txdam_media
• RTE.config.tt_content.bodytext.proc.overruleMode = ts_css,txdam_media
• RTE.config.tt_content.bodytext.types.textpic.proc.overruleMode = ts_css,txdam_media

If txdam_media is missing in any of those keys, you might want to add the following code manually to your Page TSconfig:

TS TypoScript:

## Add txdam_media to RTE processing rules
RTE.default.proc.overruleMode = ts_css,txdam_media
 
## Use same RTE processing rules in FE
RTE.default.FE.proc.overruleMode = ts_css,txdam_media
 
## RTE processing rules for bodytext column of tt_content table
RTE.config.tt_content.bodytext.proc.overruleMode = ts_css,txdam_media
RTE.config.tt_content.bodytext.types.text.proc.overruleMode = ts_css,txdam_media
RTE.config.tt_content.bodytext.types.textpic.proc.overruleMode = ts_css,txdam_media
 
## RTE processing rules for bodytext column of tt_news table (if installed)
RTE.config.tt_news.bodytext.proc.overruleMode = ts_css,txdam_media
RTE.config.tt_news.bodytext.types.text.proc.overruleMode = ts_css,txdam_media
RTE.config.tt_news.bodytext.types.textpic.proc.overruleMode = ts_css,txdam_media

Checking your Template

DAM default setup for rendering the <media>-tag as found in ext/dam/binding/mediatag/ext_localconf.php:

TS TypoScript:

plugin.tx_dam_tsfemediatag {
	procFields {
		file_size = 1
	}
	format = filesize
	tag {
		current = 1
		typolink.parameter.data = parameters : allParams
		typolink.extTarget = {$styles.content.links.extTarget}
		typolink.target = {$styles.content.links.target}
		typolink.title { 
			dataWrap = { field : txdam_file_name } ({ field : txdam_file_size })
			htmlspecialchars = 1
		}
		parseFunc.constants = 1
	}
}
 
lib.parseFunc.tags.media = < plugin.tx_dam_tsfemediatag
lib.parseFunc_RTE.tags.media = < plugin.tx_dam_tsfemediatag

Administration

General access

Also need to give access to the Media table, otherwise all DB operations will be forbidden.

Indexing

Mime Types and Media Types

• New media type: photoshop (psd files)

Multiple languages support

Before you can translate a DAM item (be that a category or the metadata of a file) you will have to translate your media folder into all necessary languages as you would do it for any other page:

• Select your media folder in the page tree.
• Chose Web->Info
• In the selectlist on top, choose Localisation overview
• Add a translation for each language by clicking the appropriate checkbox and the Create new translation headers icon

TSconfig

Error: "tx_dam. ... general DAM configuration" - actually, its setup.*

Troubleshooting

The DAM can output a lot of information when debugging is turned on. To enable that mode, set $TYPO3_CONF_VARS['SYS']['enable_DLOG'] = 1 in your local configuration and install an extension that can handle this output (for example, extension devlog). This may help you track problems.

Configuration

This is for template configuration

Possible properties for plugin.tx_dam_tsfemediatag.procFields

By exploring dam/binding/mediatag/class.tx_dam_tsfemediatag.php (function getContent()) I found out that plugin.tx_dam_tsfemediatag.procFields allows for quite a few subproperties. This is documented nowhere and filling in the necessary pieces of information would be very much appreciated. --Uffi 15:08, 18 May 2008 (CEST)

file_size

• Data type: string/stdWrap
• Default: ?

Description goes here.

__image_thumbnailImgTag

• Data type: string/stdWrap
• Default: ?

Description goes here.

__image_thumbnailImgUrl

• Data type: string/stdWrap
• Default: ?

Description goes here.

__image_thumbnailImg

• Data type: string/stdWrap
• Default: ?

Description goes here.

__icon_fileTypeImgTag

• Data type: string/stdWrap
• Default: ?

Description goes here.

caption

• Data type: string/stdWrap
• Default: ?

Description goes here.

alt_text

• Data type: string/stdWrap
• Default: ?

Description goes here.

media_type

• Data type: string/stdWrap
• Default: ?

Description: Fill in

default

• Data type: string/stdWrap
• Default: ?

Description: Fill in