EXT: DAM Downloads

Extension Key: dam_downloads

Copyright 2004, Daniel Thomas, <dt@dpool.net>

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 Downloads	1

Introduction	1

What does it do?	1

Users manual	1

FAQ	1

Adminstration	1

FAQ	1

Configuration	1

FAQ	2

Reference	2

Tutorial	4

Known problems	4

To-Do list	4

Changelog	4

Introduction

What does it do?

The extension contains a frontend plugin which displays records from the Media module based on the categorisation made in the Media module. Display of lists of records and details of single records is fully configurable through TypoScript and HTML-templates. The plugin handles any given file type. Images are displayed with thumbnails.

It is possible to configure individual downloadlinks for each file. Alternatively, files can be added to session stored download list. Users can then download the whole list via a dynamically created zip-archive.

Users manual

FAQ

Adminstration

FAQ

Configuration

FAQ

Reference

General Configuration

plugin.tx_damdownloads_pi1:

Property:	Data type:	Description:	Default:
pid	int	Every DAM installation has a priviliged page on which records are stored in the pagetree. Specifiy this ID here.	0
imgTypes	String, comma separated list	Specifiy those file types which should be regarded as images and are therefore being processed by ImageMagick.	Jpg, jpeg, gif, tif, png
template	fileresource	HTML template file	EXT:dam_downloads/pi1/template.tmpl
restricted	boolean	With this parameter set you can restrict the display of records to those file-types which are defined as a comma separated list under restricted.fileTypes	0
restricted.fileTypes	String, comma separated list	See restricted	jpg, jpeg, gif, tif, png
searchFieldList	String, comma separated	List of meta data fields which are included in textsearch.	
icons_small	array	Each of these keys of this typoscript array represents a standard thumbnail image for a given filetype. Example: icons_small.xls = <img src=”fileadmin/image_for_excel_documents.gif” /> This directive results in the image “image_for_excel_documents.gif” being displayed in the ###DOC### marker of the display if the file_type of the record is xls. Each entry in this array has to correspond to a file_type in the DAM. If no entry is available for a file_type the entry in icons_small.noImg will be displayed.	
icons_large	array	See icons_small. For detail view of record.	

plugin.tx_damdownloads_pi1.downloads:

Configuration for the download functionality. The plugin uses an external class to produce a

Property:	Data type:	Description:	Default:
filename	string	Name for the file which will be dynamically created by the zip class.	download.zip
directoryName	string	Name of the folder into which the files will be extracted when the user extracts the zip-file.	t3downloads/

Hint:

the paramter absolutePathPrefix is not needed anymore in dam_downloads version 1.1.0 and higher.

plugin.tx_damdownloads_pi1.browsebar:

Configuration for the browsebar

Property:	Data type:	Description:	Default:
start.btn	string	String to be displayed as link to the first page	
start.std	->stdWrap	stdWrap start.btn is passed through before output.	
back.btn	string	String to be displayed as link to the previous page	
back.std	->stdWrap	stdWrap back.btn is passed through before output.	
page.btn	string	String to be appended to the integer of the pagelinks.	
page.std	->stdWrap	stdWrap each pagelink is passed through before output.	
page.stdAct	->stdWrap	stdWrap the current pagelink is passed through before output.	
next.btn	string	String to be displayed as link to the next page	
next.std	->stdWrap	stdWrap next.btn is passed through before output.	
end.btn	string	String to be displayed as link to the last page	
end.std	->stdWrap	stdWrap last.btn is passed through before output.	
first	->stdWrap	stdWrap the start and back parts are passed through together before output	
second	->stdWrap	stdWrap the pagelinks are passed through together before output	
third	->stdWrap	stdWrap the next and end parts are passed through together before output	
whole	->stdWrap	stdWrap the first, second and third parts are passed through together before output	

plugin.tx_damdownloads_pi1.listView:

Property:	Data type:	Description:	Default:
results_at_a_time	int	How many records displayed on one screen	8
maxPages	uint	How many pages displayed in the browsebar	20
orderBy	string	SQL ORDER BY string	ORDER BY title
rewind	boolean	If set then the browsebar will display a link back to the first browsepage every time.	1
cue	boolean	If set then the browsebar will display a link back to the last browsepage every time.	1
cols	int	Number of columns the listView is displayed with.	4
templatePrefix	string	In the template file there are several subparts for the display types. Based on value of this parameter records will be displayed with the template subpart ###LIST_ITEM###. If you change the value to SOME_OTHER_VALUE the application will expect a subpart ###SOME_OTHER_VALUE_ITEM###	LIST
imageType	string	Don't change. Internal information	icons_small.
image	->cObj	Configuration for display of thumbnails if record is an image.	
std.	array	Each displayable record field's content is passed through stdWrap before output with configuration given in std.NAME_OF_FIELD: title description search_content language copyright file_name file_path file_size file_dl_name creator hpixels vpixels crdate tstamp file_ctime category	

plugin.tx_damdownloads_pi1.singleView:

Property:	Data type:	Description:	Default:
std	array	See. plugin.tx_damdownloads_pi1.listView.std	
imgType	string	Don't change.	icons_large.
templatePrefix	string	See above	DETAIL

Template Subparts:

Name:	Description:	Default:
###LIST_ITEM### ###LIST_ITEM_NOIMG### ###COLLECT_ITEM### ###COLLECT_ITEM_NOIMG### ###DETAIL_ITEM### ###DETAIL_ITEM_NOIMG###	Single record in various display modes. Each of the three display modes takes different subparts based on the file being an image or not. MARKER: ###DOC### ###TITLE### ###CRDATE### ###FILE_TYPE### ###FILE_SIZE### ###DESCRIPTION### ###ABSTRACT### ###SEARCH_CONTENT### ###LANGUAGE### ###COPYRIGHT### ###FILE_NAME### ###FILE_PATH### ###FILE_DL_NAME### ###CREATOR### ###HPIXELS### ###VPIXELS### ###TSTAMP### ###FILE_CTIME### ###CATEGORIES### WRAPPEDSUPPARTMARKER: ###LINK_DETAIL### ###LINK_DL_FILE### ###LINK_SAVE### add record to downloadlist ###LINK_DELETE### remove record from downloadlist	
###LIST_ROW### ###COLLECT_ROW###	Template for on row in either list or downloadlist display. MARKER: ###ITEMS### - all items in one row	
###LIST_MAIN### ###COLLECT_MAIN###	Template for all rows: MARKER: ###ITEMS### - all rows ###BROWSERESULTS### ###BROWSELINKS### ###DOWNLOAD_ZIP### link to trigger the download of the zip archive	
###SEARCH###	Template for search part: MARKER: ###FORM_URL### ###SWORDS### ###OPTIONS### SUBPART: ###CATEGORIES###	

Tutorial

Known problems

To-Do list

Changelog

EXT: DAM Downloads - 4

EXT: DAM Downloads

Kasper Skårhøj

2002-11-01T00:32:00

Rupert Germann

Robert Lemke