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: sb_downloader¶

Created:	2010-02-18T17:33:18
Changed:	2012-01-08T19:40:40.590000000
Classification:	sb_downloader
Keywords:	Downloadsystem for TYPO3
Author:	Sebastian Baumann
Email:	sb@typo3erweiterungen.de
Info 4:
Language:	en

EXT: sb_downloader - sb_downloader

EXT: sb_downloader¶

Extension Key: sb_downloader

Language: en

Keywords: Downloadsystem for TYPO3

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¶

EXT: sb_downloader 1

`Introduction 3 <#__RefHeading__1854_1243345418>`_

What does it do? 3

Support & Demo? 3

Screenshots 4

`User manual 5 <#__RefHeading__1862_1243345418>`_

Install the Extension 5

Create the sites (data folder, ...) 5

Add Categories and Partners in the data folder 5

Configure the options 5

`Configuration 7 <#__RefHeading__1872_1243345418>`_

Reference 7

Static css file 10

`Using sb_downloader in your Extension 12 <#__RefHeading__1878_1243345418>`_

`FAQ 13 <#__RefHeading__1880_1243345418>`_

`You like the extension? 14 <#__RefHeading__2175_1243345418>`_

`Changelog 15 <#__RefHeading__1882_1243345418>`_

Introduction¶

What does it do?¶

Download system with many features. Displays downloads with short description, click counter, file size and image preview. It is possible to create a detail site of each download. New is simple search function and it´s now possible to display single downloads. External files via link are now possible too.

Support & Demo?¶

Demo is available here: http://www.typo3erweiterungen.de/typo3-extensions/sb-downloader/demo/

Support-Forum: http://www.faqboard.info

Sponsoring & Thanks¶

Many thanks to Robert Heel for the complete rewrite of the 2.x.x branch. Many thanks to web und werbe werkstatt, Traunstein ( www.webundwerbe.de ) for sponsoring the sort features (backend, short description).

Bugfixing¶

If you find a bug or need a special feature, please check the page http://forge.typo3.org/projects/show/extension-sb_downloader and add a feature or bug request.

Screenshots¶

Download without Image preview and dynamic icons

Download with three download options (display size) and last edit date

singleID: Display selected downloads as download list

User manual¶

You will need to do the following:

Install The Extension

Create Or Set the Data Folder

Add Categories and Downloads in the data folder

Create new site and add the Extension

Configure the options

Install the Extension¶

The first step you need to do is to install the extension – sb_downloader -- with the extension manager. You can get it by going to Tools section and choosing “Ext Manager” on the main action menu (usually on left-side). Then in the dropdown Menu at the top, select “Import Extensions” in the Menu at top. Then type “ sb_downloader ” in the “Extensions in TYPO3 Extension Repository” and click on the “Look up” button. You should then find the Servant Matcher extension.

If you have never installed this, then you will see a red arrow to the left of “ sb_downloader ” and you can click on that to install. If it has been installed, you can click on the green arrow to the left of the extension or the name of the extension and then load the newest version by clicking on the Import/Update button. It is highly recommended to install the new extension in the "local" folder (LOCAL: typo3conf/ext/sb_downloader).

Create the sites (data folder, ...)¶

You have to create several pages. The usual way is to create one sysfolder where the records and categories are saved in.It´s possible to create the extension records in normal sites but we recommend to use a new Storage Folder because there can be many records and you can keep everything in one place.

Create a page where the LIST view appears

Create a page where the SINGLE view appears

Create a SYSFOLDER named “sysfolder” e.g. beyond your site with LIST view.

On each page you have to set the “ General record store page ” to your sysfolder.

Put the plugin into your page(s) with “general plugin” = “sb_downloader” and put the desired parameters in.

Add Categories and Partners in the data folder¶

Click on “ Create new record ” and choose one of the following:

Categorie for a new categorie and Download for a new partner record. You have to add first your categories, because you need the categories to add a new partner record. The form fields are self- explanatory.

Configure the options¶

To display some records on your site you have to add a new site record (choose as type: extension and select “Download sytem”) on a page. Then you´ll have to edit the flexform tabs:

First choose Category and what to display: List view, single view. Search or singleID

Settings

You are able to display only selected Download files.

Configuration¶

You have the possibility to edit the following properties via setup:

Reference¶

linkdescription¶

Property

linkdescription

Data type

integer

Description

If no linktitle set:

1 = filename.fileextension,

2 = filename

3 = fileextension

Default

1

downloadIcon¶

Property

downloadIcon

Data type

string

Description

Path to download icon (complete – e.g.

downloadIcon =

typo3conf/ext/sb_downloader/pi1/images/down

load.gif)

or

Path to the folder, where the fileicons are:

(e.g. downloadIcon = typo3/gfx/fileicons/) This

path must end with a Slash! Result: the

corrosponding icons to the fileextension will be

shown, just like “pdf.gif” e.g. - Kurt Kunig

Default

missingDownloadIcon¶

Property

missingDownloadIcon

Data type

string

Description

If the path is set typo3/gfx/fileicons/ you can set a default download icon if a icon is missing (e.g. for rar files)

Default

typo3conf/ext/sb_downloader/pi1/images/download.gif

ShowFileDate¶

Property

ShowFileDate

Data type

boolean

Description

Display file modofication date

Default

0

templateFile¶

Property

templateFile

Data type

String

Description

Path to template file

Default

typo3conf/ext/sb_downloader/sb_download_template.html

singlePID¶

Property

singlePID

Data type

integer

Description

Pid of the detail page, if empty it uses the actual pageid

Default

empty

overviewPID¶

Property

overviewPID

Data type

integer

Description

Pid of page with list view, if empty it uses the actual pageid

Default

empty

displayCreationDate¶

Property

displayCreationDate

Data type

boolean

Description

Decission to display the date of the crdate

behind the download-number or not

displayCreationDate (1 = yes, 0 = no)

- additional array-elements in locallang.xml

Default

dateformat¶

Property

dateformat

Data type

->stdWrap

Description

Date formating for the template-marker: ###DATE###.

Example:

plugin.tx_sbdownloader_pi1 {dateformat= l, d.m.Y}

This will display the date in content elements like this: “Monday, 31.03.2008 ”.

Default

timeformat¶

Property

timeformat

Data type

->stdWrap

Description

Time formating for the template-marker: ###DATE###.

Example:

plugin.tx_sbdownloader_pi1 {timeformat= H:i}

This will display the time in content elements like this: “12:03”.

Default

datetimeformat¶

Property

datetimeformat

Data type

->stdWrap

Description

Date and time format for the template marker:

###MODIFICATIONDATE###

Example:

plugin.tx_sbdownloader_pi1{datetimeformat=d.m.y}

This will display the date and time in content elements like this: “12.05.2008”

Default

imageDistance¶

Property

imageDistance

Data type

String

Description

Distance between Image and text

Default

5

image¶

Property

image

Data type

->imgResource

->stdWrap

Description

Configurates the image(s) in news items.

Example:

image{

file.maxW = 140

imageLinkWrap = 0

imageLinkWrap {

enable = 1

bodyTag = <BODY bgColor=white>

wrap = |

width = 400m

height = 400

JSwindow = 1

JSwindow.newWindow = 1

JSwindow.expand = 17,20

}

see: TSref->imgResource

Default

sortBy¶

Property

sortBy

Data type

String

Description

Sort list by name, crdate, tstamp, singleID, backend, description

Default

Name

limit¶

Property

limit

Data type

string

Description

Limit: max items for LATEST

Default

3

Imagelink¶

Property

Imagelink

Data type

boolean

Description

preview image with link to first download

Default

0

LinkTarget¶

Property

LinkTarget

Data type

String

Description

set the target of the links - if you dont want to use a target just clear it.

Default

empty

Example

plugin.tx_sbdownloader_pi1 {# templatetemplateFile = typo3conf/ext/sb_downloader/sb_download_template.htmlsinglePID = 329# download description (1 = filename.fileextension, 2 = filename, 3 = fileextension)linkdescription = 1# date and time formatdateformat = m/d/ytimeformat = H:i# download icon# if set to typo3/gfx/fileicons/ typo3 standard icons appear# you can set own images like:# downloadIcon = typo3conf/ext/sb_downloader/pi1/images/download.gifdownloadIcon = typo3/gfx/fileicons/# if a download icon is missing (e.g. *.rar)missingDownloadIcon = typo3conf/ext/sb_downloader/pi1/images/download.gif# distance around imageimageDistance = 5# image settingsimage{file.maxW = 80imageLinkWrap = 1imageLinkWrap {enable = 1bodyTag = <BODY bgColor=white>wrap = <A href="javascript:close();"> | </A>width = 400mheight = 400JSwindow = 1JSwindow.newWindow = 1JSwindow.expand = 17,20}}# displayCreationDate (0 = no date & time, 1 = only date, 2 = date & time)displayCreationDate = 1}

Static css file¶

You can insert the static css file via include static

Using sb_downloader in your Extension¶

Markus Dreyer < Markus@MadaXel.de >wrote a hook for sb_downloader to use the extension data in another extensions.

Insert in the ext_localconf.php file of your extension this code:

$TYPO3_CONF_VARS['EXTCONF']['sb_downloader'][] = 'EXT:'._EXTKEY.'/path/to/class.extensionhook.php:extensionhook';

and user this method to get the data:

$lHook->downloadCompleted($uid, tx_sbdownloader_pi1 &$pPiRef);

FAQ¶

((generated))¶

I can´t insert categories in a new partner record.¶

You have to set the “ General Record Storage page” of your SysFolder.

You like the extension?¶

If you like this extension, you can do one or more of the following things:

Write me an email
Donate something, so that I can write those kind of extensions for you.More information is here: http://www.typo3erweiterungen.de/spende/

Many thanks in advance!

Changelog¶

12-01-04 Sebastian Baumann <sb@typo3erweiterungen.de>* added backend search support* added LATEST view* added preview image with link to first download

11-12-11 Sebastian Baumann <sb@typo3erweiterungen.de>* added TYPO3 4.6.x Support* added linkdescrition again* added sort by short description* added sort by backend view

11-06-06 Sebastian Baumann < sb@typo3erweiterungen.de >

* main function rewritten by Robert Heel (Feature #11701)* added external links (Feature #11701)* added versioning by Robert Heel (Feature #11701)* Workspace capability by Robert Heel (Feature #11701)

10-11-27 Sebastian Baumann < sb@typo3erweiterungen.de >

* added support for “all languages”

* added singleID as sort option

* fixed Bug 10992 , 10993

10-08-24 Sebastian Baumann < sb@typo3erweiterungen.de >

* added search function

* display singleIds as Download list

09-12-22 Sebastian Baumann < sb@typo3erweiterungen.de >

* security bugfix, update please!, fixed small bug with secure links

08-07-14 Sebastian Baumann <sb@typo3erweiterungen.de>

* added hook from Markus Dreyer <Markus@MadaXel.de>

08-06-18 Sebastian Baumann <sb@typo3erweiterungen.de>

* added link description (a description per downloadlink)

* added forcelinkdescription: this is usefull if a link description is set and should only displayed in detail view

* added category marker

08-06-16 Sebastian Baumann <sb@typo3erweiterungen.de>

* added option to set secure downloads or not

08-06-02 Sebastian Baumann <sb@sitesystems.de>

* added: file modification date (thanks to Kurt Kunig, www.kupix.de)

* added: sorting of records (thanks to Kurt Kunig, www.kupix.de)

* added: template for link output

* added: display only first download record (e.g. for archive in detail view)

08-05-30 Sebastian Baumann <sb@sitesystems.de>

* more link appear only if long description is not empty (optional)

* fixed bug if more than two languages are available (then the wrong detail view appears)

08-05-26 Sebastian Baumann <sb@sitesystems.de>

* fixed bug (sql injection)

08-04-01 Sebastian Baumann <sb@sitesystems.de>

* added filesize of download (thanks to Kurt Kunig, www.kupix.de)

* added date and time of record creation (thanks to Kurt Kunig, www.kupix.de)

* added last edit date

* added HTML template

* added detail view

* added multi language support

08-01-15 Sebastian Baumann <sb@sitesystems.de>

* fixed bug (blank in link description)

07-10-09 Sebastian Baumann <sb@sitesystems.de>

* updated query´s (typo3 coding guidlines)

* first public release

07-10-01 Sebastian Baumann <sb@sitesystems.de>

* added imagepreview (e.G. for video files)

* fixed bug in "all" view

07-09-25 Sebastian Baumann <sb@sitesystems.de>

* first public use

07-09-19 Sebastian Baumann < sb@sitesystems.de >

* Initial release

15