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 Portfolio 2¶

Created:	2010-02-18T17:33:18
Changed:	2014-06-27T13:33:43.716000000
Classification:	sb_portfolio2
Description:	The keywords help with categorizing and tagging of the manuals. You can combine two or more keywords and add additional keywords yourself. Please use at least one keyword from both lists. If your manual is NOT in english, see next tab "language" ---- forEditors (use this for editors / german "Redakteure") forAdmins (use this for Administrators) forDevelopers (use this for Developers) forBeginners (manuals covering TYPO3 basics) forIntermediates (manuals going into more depth) forAdvanced (covering the most advanced TYPO3 topics) see more: http://wiki.typo3.org/doc_template#tags ----
Keywords:	forEditors, forAdmins, forDevelopers, forIntermediates
Author:	Author Name
Email:	your@email.com
Info 4:
Language:	en

EXT: SB Portfolio 2 - sb_portfolio2

EXT: SB Portfolio 2¶

Extension Key: sb_portfolio2

Language: en

Keywords: forEditors, forAdmins, forDevelopers, forIntermediates

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 Portfolio 2 1

`Introduction 3 <#__RefHeading__1359_1972601825>`_

What does it do? 3

Features: 3

What doesn't work at the moment 3

What's new in this version? 3

`Installation 5 <#__RefHeading__1367_1972601825>`_

`Item Records 6 <#__RefHeading__6011_1720785869>`_

General Tab 6

Type Fields 6

File Information Palette 6

`Category Records 8 <#__RefHeading__951_154025061>`_

`Client Records 9 <#__RefHeading__1164_154025061>`_

`File Records 11 <#__RefHeading__1471_154025061>`_

General Tab 11

File Information Palette 11

Visibility Tab 11

`Film Records 12 <#__RefHeading__2402_154025061>`_

General Tab 12

Type Fields 12

File Information Palette 12

Visibility Tab 12

`Image Records 13 <#__RefHeading__4241_154025061>`_

General Tab 13

Image Information Palette 13

Visibility Tab 13

`Image Folder Records 14 <#__RefHeading__4245_154025061>`_

General Tab 14

Visibility Tab 14

`Link Records 15 <#__RefHeading__4249_154025061>`_

General Tab 15

Type Fields 15

File Information Palette 15

Visibility Tab 16

`Tag Records 17 <#__RefHeading__5534_154025061>`_

General Tab 17

Visibility Tab 17

`Testimonial Records 18 <#__RefHeading__5536_154025061>`_

General Tab 18

Credit Tab 18

Visibility Tab 18

`Slider Records 19 <#__RefHeading__5540_154025061>`_

`Item Plugin 21 <#__RefHeading__6287_154025061>`_

General Tab 21

`Client Plugin 22 <#__RefHeading__6625_1187495877>`_

General Tab 22

`Category Plugin 23 <#__RefHeading__6629_1187495877>`_

General Tab 23

`Slider Plugin 24 <#__RefHeading__6633_1187495877>`_

General Tab 24

`Tag Plugin 25 <#__RefHeading__6637_1187495877>`_

General Tab 25

`Testimonial Plugin 26 <#__RefHeading__6641_1187495877>`_

General Tab 26

`Backend Module 27 <#__RefHeading__6645_1187495877>`_

Import Function 27

`TypoScript Constant Reference 29 <#__RefHeading__6425_2059369532>`_

plugin.tx_sbportfolio2.view 29

plugin.tx_sbportfolio2.persistence 29

plugin.tx_sbportfolio2.settings 29

`TypoScript Setup Reference 30 <#__RefHeading__4188_992187280>`_

plugin.tx_sbportfolio2.view 30

plugin.tx_sbportfolio2.persistence 30

plugin.tx_sbportfolio2.settings 30

plugin.tx_sbportfolio2.settings.pageBrowser 30

plugin.tx_sbportfolio2.settings.sortByFields 31

plugin.tx_sbportfolio2.settings.meta 31

plugin.tx_sbportfolio2.settings.client 31

plugin.tx_sbportfolio2.settings.item 32

plugin.tx_sbportfolio2.settings.item.flickr 33

plugin.tx_sbportfolio2.settings.item.flickr.getInfo 33

plugin.tx_sbportfolio2.settings.item.flickr.getPhotos 33

plugin.tx_sbportfolio2.settings.category 34

plugin.tx_sbportfolio2.settings.slider 35

plugin.tx_sbportfolio2.settings.tag 35

plugin.tx_sbportfolio2.settings.testimonial 36

`Templates 37 <#__RefHeading__6691_2059369532>`_

`To-do List 38 <#__RefHeading__6013_1720785869>`_

`Change Log 39 <#__RefHeading__6015_1720785869>`_

`Bugs 40 <#__RefHeading__6017_1720785869>`_

Introduction¶

What does it do?¶

This extension is intended to replace sb_portfolio... sometime! It is an all-in-one portfolio system for your TYPO3 website with items, clients, categories, and testimonials. The extension uses ExtBase and is templated with Fluid.

Features:¶

Records for items, clients, categories, testimonials, images, image folders, links, films, files, & content sliders.
Items and clients can be categorised, have links, tags, files and testimonials.
Items and clients inherit links, files and tags from their categories – view helpers exist to sort the inheritable records with the records own links, tags and files so you don't have to list them separately.
Items can link to pages, files or urls instead of linking to a detail view.
On detail view for clients, items and categories the next and previous records can be shown.
Client's have their own portfolio showing all items for them when on the client detail view.
Category detail view shows all items and clients in that category.
Item's can be filtered by client, category, or tag.
Client's can be filtered by category or tag,
A classes ViewHelper for adding classes to a list of records – any of the records. Classes include first, last, odd, even, number-n, plus various classes based on the type of record it is. Files will get file type classes, links will get classes based on the type of links that they are and so on.
Films can be URLS, embedded films from YouTube, Vimeo etc., or a file (played using TYPO3's media CE).
Links can be URLs, pages, files, a client, a category, an item, items filtered by a client, items filtered by a category, items filtered by a tag, clients filtered by a category, or clients filtered by a tag.
Flickr can be a source of images for items.
Have a look at the templates and ViewHelpers to see what can be done.
… lots more things!

What doesn't work at the moment¶

sb_portfolio's image folder manifest files are not incorporated into sb_portfolio2.
There is no BE module like sb_portfolio has. (There is now an import module)
Items can't be related by tag yet, I have started work on a viewhelper for this.

What's new in this version?¶

Manual¶

Change

Manual

Description

Documented new features and TS settings.

Viewhelpers¶

Change

Viewhelpers

Description

Added image class specific classes

File records¶

Change

File records

Description

Added file type class to links of type = 1 (file)

Client records¶

Change

Client records

Description

Added logo field

Item records¶

Change

Item records

Description

Added featured and inprogress to TS
Items can be filtered via TS of FF for inprogress or featured
Create manifest file if there is none on saving a record with image folders

Flickr¶

Change

Flickr

Description

Fixed problem with flickr trying to use a flickrimages oauth class.

Misc.¶

Change

Misc.

Description

Changed several templates slightly
Changed tca for clients, list, and tags
Added film host to film type 2: url

Installation¶

Install through the extension manager and add sb_portfolio 2's default TypoScript to your TypoScript template.

Item Records¶

General Tab¶

Language¶

Field

Language

Description

The item's language. Defaults to “Default”.

Title¶

Field

Title

Description

REQUIRED FIELD - The item's title.

Title (Full)¶

Field

Title (Full)

Description

The item's full title.

Title (Short)¶

Field

Title (Short)

Description

The item's short title, to be used in the FE when space is restricted.

Type of Item¶

Field

Type of Item

Description

This is the type of item, there are 4 types:

Normal = A normal portfolio item.

Page = Item is a link to a page.

URL = Item is a link to another website or file on another website.

File = Item is a link to a file in fileadmin.

Featured¶

Field

Featured

Description

This item is featured. Content elements can be set to include or exclude featured items.

In-progress¶

Field

In-progress

Description

This item is not finished/not gone live etc. Content elements can be set to include or exclude in-progress items.

Date¶

Field

Date

Description

The item's date. Defaults to the current date/time.

Summary¶

Field

Summary

Description

A summary of the item. This could be used in lists.

Full description¶

Field

Full description

Description

A full description of the item. This is an RTE and can be formatted, contain images, links etc.

Type Fields¶

The following additional fields are available depending on the type of item:

Page¶

Type

Page

Field

Page

Description

This is the page that the item should link to.

URL¶

Type

URL

Field

URL

Description

This is the URL that the item should link to.

File¶

Type

File

Field

File

Description

This is a reference to a file in fileadmin.

File Information Palette¶

When an item record of type “File” is saved with a file the following information is added to the record so that it can be used in the FE in your fluid templates (see the default templates for examples of how to use this information). If you remove a item record's “file”, the file information fields will be emptied when you next save the file record. You can't edit these fields yourself, the information is taken from the file itself.

File Name¶

Field

File Name

Description

This is the file name of the file (without the file extension)

File Extension¶

Field

File Extension

Description

This is the extension of the file, this will be something like “pdf” or “zip” etc.

File Size¶

Field

File Size

Description

This is the size of the file in bytes. A ViewHelper is available to convert this to a human readable value in the FE (see the default templates).

File Path¶

Field

File Path

Description

This is the path from fileadmin to the file

Media Tab¶

Preview Image¶

Field

Preview Image

Description

This is a single image record. This could be used in lists.

Images¶

Field

Images

Description

The item's images, these are separate image records.

Image Folders¶

Field

Image Folders

Description

The item's image folders, these are separate image folder records. Image folders allow you to relate many images at once to a portfolio item by selecting a folder from fileadmin. All images in the folder will then be displayed in the FE.

Films¶

Field

Films

Description

The item's films, these are separate film records.

Photoset ID¶

Field

Photoset ID

Description

Flickr can be used as a source for images for the item. One Flickr Photoset ID can be saved per item.

Categorisation Tab¶

Client¶

Field

Client

Description

This is the client that the item was made for.

Categories¶

Field

Tags¶

Field

SEO Tab¶

OG Title¶

Field

OG Title

Description

The page title for the OG meta tag when viewing the single item. You don't have to set this, any of the main title fields can be used instead, this is in case you want a different title for the meta tag.

OG Type¶

Field

OG Type

Description

The OG type meta tag when viewing the single item, defaults to “article”. Unless you have any reason to change this, leave it as “article”.

OG Image¶

Field

OG Image

Description

An image for the OG image meta tag when viewing the single item. Facebook recommends an image 50 x 50 pixels.

OG Description¶

Field

OG Description

Description

The OG description meta tag when viewing the single item. You don't have to set this, you could use the summary field instead or the full description field (cropped and stripped of HTML)

FB App ID¶

Field

FB App ID

Description

This is a Facebook app ID for the single page. This is set globally by TypoScript but this field allows you to over-ride the app ID for specific pages.

FB Administrators¶

Field

FB Administrators

Description

This is a Facebook admin IDs for the single page. This is set globally by TypoScript but this field allows you to over-ride the Facebook admin IDs for specific pages. Separate IDs with a comma.

Visibility Tab¶

Hidden¶

Field

Hidden

Description

Hides / Shows the item. Enable this check box to hide the item in the FE.

Display From¶

Field

Display From

Description

A date and time when the item should start appearing in the FE.

Display Until¶

Field

Display Until

Description

A date and time when the item should stop appearing in the FE.

Category Records¶

General Tab¶

Language¶

Field

Language

Description

The category's language. Defaults to “Default”.

Title¶

Field

Title

Description

REQUIRED FIELD - The category's title.

Title (Full)¶

Field

Title (Full)

Description

The category's full title.

Title (Short)¶

Field

Title (Short)

Description

The category's short title, to be used in the FE when space is restricted.

Summary¶

Field

Summary

Description

A summary of the category. This could be used in lists.

Full description¶

Field

Full description

Description

A full description of the category. This is an RTE and can be formatted, contain images, links etc.

Media Tab¶

Image¶

Field

Image

Description

This is a single image record and is an icon or image to represent the category.

Related Tab¶

Related Files¶

Field

Related Files

Description

These are file records that relate to this category. Category files are inherited by items/clients within the category.

Related Items¶

Field

Categorisation Tab¶

Tags¶

Field

Parent Category¶

Field

Parent Category

Description

If you want this category to be a sub-category of another, select the category's parent category with this field.

SEO Tab¶

OG Title¶

Field

OG Title

Description

The page title for the OG meta tag when viewing the single category. You don't have to set this, any of the main title fields can be used instead, this is in case you want a different title for the meta tag.

OG Type¶

Field

OG Type

Description

The OG type meta tag when viewing the single category, defaults to “article”. Unless you have any reason to change this, leave it as “article”.

OG Image¶

Field

OG Image

Description

An image for the OG image meta tag when viewing the single category. Facebook recommends an image 50 x 50 pixels.

OG Description¶

Field

OG Description

Description

The OG description meta tag when viewing the single category. You don't have to set this, you could use the summary field instead or the full description field (cropped and stripped of HTML)

FB App ID¶

Field

FB App ID

Description

This is a Facebook app ID for the single page. This is set globally by TypoScript but this field allows you to over-ride the app ID for specific pages.

FB Administrators¶

Field

FB Administrators

Description

This is a Facebook admin IDs for the single page. This is set globally by TypoScript but this field allows you to over-ride the Facebook admin IDs for specific pages. Separate IDs with a comma.

Visibility Tab¶

Hidden¶

Field

Hidden

Description

Hides / Shows the category. Enable this check box to hide the category in the FE.

Display From¶

Field

Display From

Description

A date and time when the category should start appearing in the FE.

Display Until¶

Field

Display Until

Description

A date and time when the category should stop appearing in the FE.

Client Records¶

General Tab¶

Language¶

Field

Language

Description

The client's language. Defaults to “Default”.

Title¶

Field

Title

Description

REQUIRED FIELD - The client's title.

Title (Full)¶

Field

Title (Full)

Description

The client's full title.

Title (Short)¶

Field

Title (Short)

Description

The client's short title, to be used in the FE when space is restricted.

Date¶

Field

Date

Description

The client's date (when they first became a client). Defaults to the current date/time.

Summary¶

Field

Summary

Description

A summary of the client. This could be used in lists.

Full description¶

Field

Full description

Description

A full description of the client. This is an RTE and can be formatted, contain images, links etc.

Media Tab¶

Image¶

Field

Image

Description

This is a single image record. This could be used in lists.

Related Tab¶

Link¶

Field

Link

Description

This is the main link for the client and is a link record, this could be a website, a file or whatever else you want.

Testimonial¶

Field

Testimonial

Description

This is a testimonial from your client and is a testimonial record.

Related Files¶

Field

Related Files

Description

These are file records that relate to this client.

Categorisation Tab¶

Categories¶

Field

Tags¶

Field

SEO Tab¶

OG Title¶

Field

OG Title

Description

The page title for the OG meta tag when viewing the single client. You don't have to set this, any of the main title fields can be used instead, this is in case you want a different title for the meta tag.

OG Type¶

Field

OG Type

Description

The OG type meta tag when viewing the single client, defaults to “article”. Unless you have any reason to change this, leave it as “article”.

OG Image¶

Field

OG Image

Description

An image for the OG image meta tag when viewing the single client. Facebook recommends an image 50 x 50 pixels.

OG Description¶

Field

OG Description

Description

The OG description meta tag when viewing the single client. You don't have to set this, you could use the summary field instead or the full description field (cropped and stripped of HTML)

FB App ID¶

Field

FB App ID

Description

This is a Facebook app ID for the single page. This is set globally by TypoScript but this field allows you to over-ride the app ID for specific pages.

FB Administrators¶

Field

FB Administrators

Description

This is a Facebook admin IDs for the single page. This is set globally by TypoScript but this field allows you to over-ride the Facebook admin IDs for specific pages. Separate IDs with a comma.

Visibility Tab¶

Hidden¶

Field

Hidden

Description

Hides / Shows the client. Enable this check box to hide the client in the FE.

Display From¶

Field

Display From

Description

A date and time when the client should start appearing in the FE.

Display Until¶

Field

Display Until

Description

A date and time when the client should stop appearing in the FE.

File Records¶

General Tab¶

Language¶

Field

Language

Description

The file's language. Defaults to “Default”.

Title¶

Field

Title

Description

REQUIRED FIELD - The file's title.

Title (Full)¶

Field

Title (Full)

Description

The file's full title.

Title (Short)¶

Field

Title (Short)

Description

The file's short title, to be used in the FE when space is restricted.

Description¶

Field

Description

A description of the file.

File¶

Field

File

Description

This is a reference to a file in fileadmin.

File Information Palette¶

When a file record is saved with a file the following information is added to the record so that it can be used in the FE in your fluid templates (see the default templates for examples of how to use this information). If you remove a file record's “file”, the file information fields will be emptied when you next save the file record. You can't edit these fields yourself, the information is taken from the file itself.

File Name¶

Field

File Name

Description

This is the file name of the file (without the file extension)

File Extension¶

Field

File Extension

Description

This is the extension of the file, this will be something like “pdf” or “zip” etc.

File Size¶

Field

File Size

Description

This is the size of the file in bytes. A ViewHelper is available to convert this to a human readable value in the FE (see the default templates).

File Path¶

Field

File Path

Description

This is the path from fileadmin to the file

Visibility Tab¶

Hidden¶

Field

Hidden

Description

Hides / Shows the file. Enable this check box to hide the file in the FE.

Display From¶

Field

Display From

Description

A date and time when the file should start appearing in the FE.

Display Until¶

Field

Display Until

Description

A date and time when the file should stop appearing in the FE.

Film Records¶

General Tab¶

Language¶

Field

Language

Description

The film's language. Defaults to “Default”.

Title¶

Field

Title

Description

REQUIRED FIELD - The film's title.

Title (Full)¶

Field

Title (Full)

Description

The film's full title.

Title (Short)¶

Field

Title (Short)

Description

The film's short title, to be used in the FE when space is restricted.

Type of Film¶

Field

Type of Film

Description

This is the type of film, there are 3 types:

Hosted Film = A film hosted by a site like YouTube.

File = A link to a film file in fileadmin.

URL = A link to another website where the film is displayed or to a film file on another website.

Description¶

Field

Description

A description of the film.

Preview Image¶

Field

Preview Image

Description

This is a single image record. This could be used in lists.

Type Fields¶

The following additional fields are available depending on the type of film:

Hosted Film¶

Type

Hosted Film

Field

Host

Description

This is the host of the film. More can be added via page tsconfig. Host types allow you to change the layout or use different embedding code depending on where the film is hosted.

Hosted Film¶

Type

Hosted Film

Field

Host Film ID

Description

This is the ID of the film on the host's site.

File¶

Type

File

Field

Film File

Description

This is a reference to a film in fileadmin.

URL¶

Type

URL

Field

Film URL

Description

This is a URL to a film or the site where the film is displayed.

File Information Palette¶

When a film record of type “File” is saved with a film file the following information is added to the record so that it can be used in the FE in your fluid templates (see the default templates for examples of how to use this information). If you remove the film file, the file information fields will be emptied when you next save the file record. You can't edit these fields yourself, the information is taken from the file itself.

File Name¶

Field

File Name

Description

This is the file name of the file (without the file extension)

File Extension¶

Field

File Extension

Description

This is the extension of the file, this will be something like “mov” or “mp4” etc.

File Size¶

Field

File Size

Description

This is the size of the file in bytes. A ViewHelper is available to convert this to a human readable value in the FE (see the default templates).

File Path¶

Field

File Path

Description

This is the path from fileadmin to the file

Visibility Tab¶

Hidden¶

Field

Hidden

Description

Hides / Shows the film. Enable this check box to hide the film in the FE.

Display From¶

Field

Display From

Description

A date and time when the film should start appearing in the FE.

Display Until¶

Field

Display Until

Description

A date and time when the film should stop appearing in the FE.

Image Records¶

General Tab¶

Language¶

Field

Language

Description

The image's language. Defaults to “Default”.

Title¶

Field

Title

Description

REQUIRED FIELD - The image's title.

Title (Full)¶

Field

Title (Full)

Description

The image's full title.

Title (Short)¶

Field

Title (Short)

Description

The image's short title, to be used in the FE when space is restricted.

Image¶

Field

Image

Description

This is a reference to an image in fileadmin.

Description¶

Field

Description

A description of the film.

Caption¶

Field

Caption

Description

This is a caption to be displayed with the film

Image Information Palette¶

When an image record is saved with an image file the following information is added to the record so that it can be used in the FE in your fluid templates (see the default templates for examples of how to use this information). If you remove the image, the image information fields will be emptied when you next save the image record. You can't edit these fields yourself, the information is taken from the image itself.

Image Name¶

Field

Image Name

Description

This is the file name of the image (without the file extension)

Image Extension¶

Field

Image Extension

Description

This is the extension of the image, this will be something like “jpg” or “png” etc.

Image Size¶

Field

Image Size

Description

This is the size of the image in bytes. A ViewHelper is available to convert this to a human readable value in the FE (see the default templates).

Image Path¶

Field

Image Path

Description

This is the path from fileadmin to the image.

Image Width¶

Field

Image Width

Description

The width of the image in pixels.

Image Height¶

Field

Image Height

Description

The height of the image in pixels.

Image Orientation¶

Field

Image Orientation

Description

The orentation of the image: 0 - square, 1 - landscape, 2 – portrait. You could then, if you wish, use different settings dependent upon the image's orientation.

Visibility Tab¶

Hidden¶

Field

Hidden

Description

Hides / Shows the image. Enable this check box to hide the image in the FE.

Display From¶

Field

Display From

Description

A date and time when the image should start appearing in the FE.

Display Until¶

Field

Display Until

Description

A date and time when the image should stop appearing in the FE.

Image Folder Records¶

General Tab¶

Language¶

Field

Language

Description

The image folder's language. Defaults to “Default”.

Title¶

Field

Title

Description

REQUIRED FIELD - The image folder's title.

Title (Full)¶

Field

Title (Full)

Description

The image folder's full title.

Title (Short)¶

Field

Title (Short)

Description

The image folder's short title, to be used in the FE when space is restricted.

Description¶

Field

Description

A description of the image folder.

Folders¶

Field

Folders

Description

These are references to image folders within fileadmin. An image folder record can have more than one folder associated with it.

Visibility Tab¶

Hidden¶

Field

Hidden

Description

Hides / Shows the image folder. Enable this check box to hide the image folder in the FE.

Display From¶

Field

Display From

Description

A date and time when the image folder should start appearing in the FE.

Display Until¶

Field

Display Until

Description

A date and time when the image folder should stop appearing in the FE.

Link Records¶

General Tab¶

Language¶

Field

Language

Description

The links's language. Defaults to “Default”.

Title¶

Field

Title

Description

REQUIRED FIELD - The links's title.

Title (Full)¶

Field

Title (Full)

Description

The links's full title.

Title (Short)¶

Field

Title (Short)

Description

The links's short title, to be used in the FE when space is restricted.

Type of Link¶

Field

Type of Link

Description

This is the type of link, there are 11 types:

URL = A link to a URL.

File = A link to a file in fileadmin.

Page = A link to a page.

Item = A link to an Item.

Client = A link to a Client.

Category = A link to a Category.

Items filtered by category = A link to items filtered by a category.

Items filtered by client = A link to items filtered by a client.

Items filtered by tag = A link to items filtered by a tag.

Clients filtered by category = A link to clients filtered by a category.

Clients filtered by tag = A link to clients filtered by a tag.

Type Fields¶

The following additional fields are available depending on the type of link:

URL¶

Type

URL

Field

URL

Description

A URL to a website or file on another site.

File¶

Type

File

Field

File

Description

This is a reference to a film in fileadmin.

Page¶

Type

Page

Field

Page

Description

A page that the link links to.

Item¶

Type

Item

Field

Item

Description

A portfolio item that the link should link to.

Client¶

Type

Client

Field

Client

Description

A portfolio client that the link should link to.

Category¶

Type

Category

Field

Category

Description

A portfolio category that the link should link to.

Items filtered by category¶

Type

Items filtered by category

Field

Category

Description

A portfolio category that items should be filtered by.

Items filtered by client¶

Type

Items filtered by client

Field

Client

Description

A portfolio client that items should be filtered by.

Items filtered by tag¶

Type

Items filtered by tag

Field

Tag

Description

A portfolio tag that items should be filtered by.

Clients filtered by category¶

Type

Clients filtered by category

Field

Category

Description

A portfolio category that clients should be filtered by.

Clients filtered by tag¶

Type

Clients filtered by tag

Field

Tag

Description

A portfolio tag that clients should be filtered by.

File Information Palette¶

When a link record of type “File” is saved with a file the following information is added to the record so that it can be used in the FE in your fluid templates (see the default templates for examples of how to use this information). If you remove the file, the file information fields will be emptied when you next save the file record. You can't edit these fields yourself, the information is taken from the file itself.

File Name¶

Field

File Name

Description

This is the file name of the file (without the file extension)

File Extension¶

Field

File Extension

Description

This is the extension of the file, this will be something like “pdf” or “zip” etc.

File Size¶

Field

File Size

Description

This is the size of the file in bytes. A ViewHelper is available to convert this to a human readable value in the FE (see the default templates).

File Path¶

Field

File Path

Description

This is the path from fileadmin to the file

Visibility Tab¶

Hidden¶

Field

Hidden

Description

Hides / Shows the link. Enable this check box to hide the link in the FE.

Display From¶

Field

Display From

Description

A date and time when the link should start appearing in the FE.

Display Until¶

Field

Display Until

Description

A date and time when the link should stop appearing in the FE.

Tag Records¶

General Tab¶

Language¶

Field

Language

Description

The tags's language. Defaults to “Default”.

Title¶

Field

Title

Description

REQUIRED FIELD - The tags's title (the tag itself).

Description¶

Field

Description

A description of the tag.

Visibility Tab¶

Hidden¶

Field

Hidden

Description

Hides / Shows the tag. Enable this check box to hide the tag in the FE.

Display From¶

Field

Display From

Description

A date and time when the tag should start appearing in the FE.

Display Until¶

Field

Display Until

Description

A date and time when the tag should stop appearing in the FE.

Testimonial Records¶

General Tab¶

Language¶

Field

Language

Description

The testimonial's language. Defaults to “Default”.

Title¶

Field

Title

Description

REQUIRED FIELD - The testimonial's title.

Testimonial¶

Field

Testimonial

Description

The tesimonial text.

Date¶

Field

Date

Description

The date that the testimonial was made.

Credit Tab¶

Name¶

Field

Name

Description

The name of the person making the testimonial.

Company¶

Field

Company

Description

The company that the person making the testimonial works for.

Position¶

Field

Position

Description

The position in the company that the person making the testimonial has.

Image¶

Field

Image

Description

This is an image record. This could be an image of the person making the testimonial or the companies logo.

Visibility Tab¶

Hidden¶

Field

Hidden

Description

Hides / Shows the testimonial. Enable this check box to hide the testimonial in the FE.

Display From¶

Field

Display From

Description

A date and time when the testimonial should start appearing in the FE.

Display Until¶

Field

Display Until

Description

A date and time when the testimonial should stop appearing in the FE.

Slider Records¶

General Tab¶

Language¶

Field

Language

Description

The slider's language. Defaults to “Default”.

Title¶

Field

Title

Description

REQUIRED FIELD - The slider's title.

Title (Full)¶

Field

Title (Full)

Description

The slider's full title.

Title (Short)¶

Field

Title (Short)

Description

The slider's short title, to be used in the FE when space is restricted.

Type of Slider¶

Field

Type of Slider

Description

This is the type of slider, there are 10 types:

URL = A slider that links to a URL.

Page = A slider that links to a page.

Item = A slider that links to an Item.

Client = A slider that links to a Client.

Category = A slider that links to a Category.

Items filtered by category = A slider that links to items filtered by a category.

Items filtered by client = A slider that links to items filtered by a client.

Items filtered by tag = A slider that links to items filtered by a tag.

Clients filtered by category = A slider that links to clients filtered by a category.

Clients filtered by tag = A slider that links to clients filtered by a tag.

Summary¶

Field

Summary

Description

A summary of the slider.

Full description¶

Field

Full description

Description

A full description of the slider. This is an RTE and can be formatted, contain images, links etc.

Type Fields¶

The following additional fields are available depending on the type of slider:

URL¶

Type

URL

Field

URL

Description

A URL to a website or file on another site.

Page¶

Type

Page

Field

Page

Description

A page that the slider links to.

Item¶

Type

Item

Field

Item

Description

A portfolio item that the slider should link to.

Client¶

Type

Client

Field

Client

Description

A portfolio client that the slider should link to.

Category¶

Type

Category

Field

Category

Description

A portfolio category that the slider should link to.

Items filtered by category¶

Type

Items filtered by category

Field

Category

Description

A portfolio category that items should be filtered by.

Items filtered by client¶

Type

Items filtered by client

Field

Client

Description

A portfolio client that items should be filtered by.

Items filtered by tag¶

Type

Items filtered by tag

Field

Tag

Description

A portfolio tag that items should be filtered by.

Clients filtered by category¶

Type

Clients filtered by category

Field

Category

Description

A portfolio category that clients should be filtered by.

Clients filtered by tag¶

Type

Clients filtered by tag

Field

Tag

Description

A portfolio tag that clients should be filtered by.

Media Tab¶

Image¶

Field

Image

Description

A reference to an image file in fileadmin. This is the main image of the slider.

Image (Rollover)¶

Field

Image (Rollover)

Description

A reference to an image file in fileadmin. This is a rollover for the slider image (if required).

Icon¶

Field

Icon

Description

A reference to an image file in fileadmin. This is an icon for the slider (if required).

Logo¶

Field

Logo

Description

A reference to an image file in fileadmin. This is a logo for the slider (if required).

Visibility Tab¶

Hidden¶

Field

Hidden

Description

Hides / Shows the slider. Enable this check box to hide the slider in the FE.

Display From¶

Field

Display From

Description

A date and time when the slider should start appearing in the FE.

Display Until¶

Field

Display Until

Description

A date and time when the slider should stop appearing in the FE.

Item Plugin¶

This plugin is used to show items, both lists of items and single items. The following FlexForm fields over-write their equivalent TypoScript properties, therefore you only need to set these fields if you want something to be different from your default TS settings.

The following FlexForm fields are available for this plugin:

General Tab¶

Record selection¶

Field

Record selection

Visibility

Always

Description

Automatic or manual (you specify exactly which records should be shown), this choice controls the visibility of the other fields available for this plugin.

Number of items¶

Field

Number of items

Visibility

Automatic

Description

How many items in total should be displayed.

Number of items per page¶

Field

Number of items per page

Visibility

Always

Description

How many items should be displayed on each page.

Sort field¶

Field

Sort field

Visibility

Automatic

Description

Sort the records by:

Title
ID
Date / Time
Updated Date
Creation Date

Sort direction¶

Field

Sort direction

Visibility

Automatic

Description

Either ascending or descending

Featured Items¶

Field

In-progress Items¶

Field

In-progress Items

Visibility

Automatic

Description

This setting controls whether in-progress items are displayed or not. Options are:

- Include in-progress items

- Exclude in-progress items

- Only in-progress items

Exclude these items¶

Field

Exclude these items

Visibility

Automatic

Description

Select which items are to be excluded from display.

Items to display¶

Field

Items to display

Visibility

Manual

Description

Select which items are to be display.ed.

Client Plugin¶

This plugin is used to show clients, both lists of clients and single clients. The following FlexForm fields over-write their equivalent TypoScript properties, therefore you only need to set these fields if you want something to be different from your default TS settings.

The following FlexForm fields are available for this plugin:

General Tab¶

Record selection¶

Field

Record selection

Visibility

Always

Description

Automatic or manual (you specify exactly which records should be shown), this choice controls the visibility of the other fields available for this plugin.

Number of clients¶

Field

Number of clients

Visibility

Automatic

Description

How many clients in total should be displayed.

Number of clients per page¶

Field

Number of clients per page

Visibility

Always

Description

How many clients should be displayed on each page.

Sort field¶

Field

Sort field

Visibility

Automatic

Description

Sort the records by:

Title
ID
Date / Time
Updated Date
Creation Date

Sort direction¶

Field

Sort direction

Visibility

Automatic

Description

Either ascending or descending

Exclude these clients¶

Field

Exclude these clients

Visibility

Automatic

Description

Select which clients are to be excluded from display.

Clients to display¶

Field

Clients to display

Visibility

Manual

Description

Select which clients are to be display.ed.

Category Plugin¶

This plugin is used to show categories, both lists of categories and single categories. The following FlexForm fields over-write their equivalent TypoScript properties, therefore you only need to set these fields if you want something to be different from your default TS settings.

The following FlexForm fields are available for this plugin:

General Tab¶

Record selection¶

Field

Record selection

Visibility

Always

Description

Automatic or manual (you specify exactly which records should be shown), this choice controls the visibility of the other fields available for this plugin.

Number of categories¶

Field

Number of categories

Visibility

Automatic

Description

How many categories in total should be displayed.

Number of categories per page¶

Field

Number of categories per page

Visibility

Always

Description

How many categories should be displayed on each page.

Sort field¶

Field

Sort field

Visibility

Automatic

Description

Sort the records by:

Title
ID
Date / Time
Updated Date
Creation Date

Sort direction¶

Field

Sort direction

Visibility

Automatic

Description

Either ascending or descending

Display categories as:¶

Field

Display categories as:

Visibility

Always

Description

Either display the categories as a flat list, or display them as a tree with child categories listed under their parent categories.

Select the start of the tree¶

Field

Select the start of the tree

Visibility

Always (tree mode only)

Description

Select which category should be used as the root of the tree (it will not be displayed), don't select any to display the whole tree.

Number of levels in the tree to display¶

Field

Number of levels in the tree to display

Visibility

Always (tree mode only)

Description

How many levels deep should the tree display?

Exclude these categories¶

Field

Exclude these categories

Visibility

Automatic

Description

Select which categories are to be excluded from display.

Categories to display¶

Field

Categories to display

Visibility

Manual

Description

Select which categories are to be display.ed.

Slider Plugin¶

This plugin is used to show slider items. The following FlexForm fields over-write their equivalent TypoScript properties, therefore you only need to set these fields if you want something to be different from your default TS settings.

The following FlexForm fields are available for this plugin:

General Tab¶

Record selection¶

Field

Record selection

Visibility

Always

Description

Automatic or manual (you specify exactly which records should be shown), this choice controls the visibility of the other fields available for this plugin.

Number of sliders¶

Field

Number of sliders

Visibility

Automatic

Description

How many slider items in total should be displayed.

Number of sliders per page¶

Field

Number of sliders per page

Visibility

Automatic

Description

How many categories should be displayed on each page.

Sort field¶

Field

Sort field

Visibility

Automatic

Description

Sort the records by:

Title
ID
Date / Time
Updated Date
Creation Date

Sort direction¶

Field

Sort direction

Visibility

Automatic

Description

Either ascending or descending

Exclude these sliders¶

Field

Exclude these sliders

Visibility

Automatic

Description

Select which slider items are to be excluded from display.

Sliders to display¶

Field

Sliders to display

Visibility

Manual

Description

Select which slider items are to be display.ed.

Tag Plugin¶

This plugin is used to show tags. The following FlexForm fields over- write their equivalent TypoScript properties, therefore you only need to set these fields if you want something to be different from your default TS settings.

The following FlexForm fields are available for this plugin:

General Tab¶

Record selection¶

Field

Record selection

Visibility

Always

Description

Automatic or manual (you specify exactly which records should be shown), this choice controls the visibility of the other fields available for this plugin.

Number of tags¶

Field

Number of tags

Visibility

Automatic

Description

How many tags in total should be displayed.

Number of tags per page¶

Field

Number of tags per page

Visibility

Always

Description

How many tags should be displayed on each page.

Sort field¶

Field

Sort field

Visibility

Automatic

Description

Sort the records by:

Title
ID
Date / Time
Updated Date
Creation Date

Sort direction¶

Field

Sort direction

Visibility

Automatic

Description

Either ascending or descending

Exclude these tags¶

Field

Exclude these tags

Visibility

Automatic

Description

Select which tags are to be excluded from display.

Tags to display¶

Field

Tags to display

Visibility

Manual

Description

Select which tags are to be display.ed.

Testimonial Plugin¶

This plugin is used to show testimonials. The following FlexForm fields over-write their equivalent TypoScript properties, therefore you only need to set these fields if you want something to be different from your default TS settings.

The following FlexForm fields are available for this plugin:

General Tab¶

Record selection¶

Field

Record selection

Visibility

Always

Description

Automatic or manual (you specify exactly which records should be shown), this choice controls the visibility of the other fields available for this plugin.

Number of testimonials¶

Field

Number of testimonials

Visibility

Automatic

Description

How many testimonials in total should be displayed.

Number of testimonials per page¶

Field

Number of testimonials per page

Visibility

Always

Description

How many testimonials should be displayed on each page.

Sort field¶

Field

Sort field

Visibility

Automatic

Description

Sort the records by:

Title
ID
Date / Time
Updated Date
Creation Date

Sort direction¶

Field

Sort direction

Visibility

Automatic

Description

Either ascending or descending

Exclude these testimonials¶

Field

Exclude these testimonials

Visibility

Automatic

Description

Select which testimonials are to be excluded from display.

Testimonials to display¶

Field

Testimonials to display

Visibility

Manual

Description

Select which testimonials are to be display.ed.

Backend Module¶

At the moment there is only one BE module function: Import.

Import Function¶

This module allows you to import records from sb_portfolio to sb_portfolio2.

A table will be displayed showing all the importable records found in the current page and the complete branch (the current page and all accessible pages under it). You can import from just the current page or the branch. Click start import to start the import process, this is done via AJAX. You will see something like the following:

Categories are created first, than clients and then items. After all the records have been created, related items will be made – this has to wait until all items are created as obviously no relationship can be made before the item exists in the sb_portfolio2 tables. After related records have been set, parent translations will be set.

CURRENTLY THERE IS A PROBLEM SETTING sys_language_uid. The correct language UID is found but for some reason it is not saved with the record. If anyone knows why, please let me know, for now you will just have to manually change the language field.

You can see which records have been created and any child records or relations to other records that have been created for these records.

Everything will be created on the page where it is found, hidden and deleted records will not be imported. So if you have records that you don't want importing, hide them first.

Related news is not imported as you probably will want to start using the new news extension instead of tt_news.

TypoScript Constant Reference¶

plugin.tx_sbportfolio2.view¶

templateRootPath¶

Property

templateRootPath

Type

string

Description

A path to the template root.

Default

EXT:sb_portfolio2/Resources/Private/Templates/

partialRootPath¶

Property

partialRootPath

Type

string

Description

A path to the template partial.

Default

EXT:sb_portfolio2/Resources/Private/Partials/

layoutRootPath¶

Property

layoutRootPath

Type

string

Description

A path to the template layout.

Default

EXT:sb_portfolio2/Resources/Private/Layouts/

plugin.tx_sbportfolio2.persistence¶

storagePid¶

Property

storagePid

Type

integer/string

Description

The PID(s) of the page where the portfolio records are stored. Mutiple IDs can be separated by a comma. i.e. 1,2,3

Default

{$plugin.tx_sbportfolio2.persistence.storagePid}

plugin.tx_sbportfolio2.settings¶

api_key¶

Property

api_key

Type

string

Description

Flickr API Key.

Default

app_id¶

Property

app_id

Type

string

Description

Facebook App ID. This is a default App ID, used on a single page view when a client, category, or item doesn't have its own App ID.

Default

admins¶

Property

admins

Type

string

Description

Facebook Admins. These are the default admins, used on a single page view when a client, category, or item doesn't have its own Facebook Admins.

Default

site_name¶

Property

site_name

Type

string

Description

Site Name. The OG site name meta tag value.

Default

dateFormat¶

Property

dateFormat

Type

string

Description

Date Format. Used in the settings whenever a record timestamp needs converting to a human readable format.

Default

d/m/Y

TypoScript Setup Reference¶

plugin.tx_sbportfolio2.view¶

templateRootPath¶

Property

templateRootPath

Type

string

Description

A path to the template root.

Default

{$plugin.tx_sbportfolio2.view.templateRootPath}

partialRootPath¶

Property

partialRootPath

Type

string

Description

A path to the template partial.

Default

{$plugin.tx_sbportfolio2.view.partialRootPath}

layoutRootPath¶

Property

layoutRootPath

Type

string

Description

A path to the template layout.

Default

{$plugin.tx_sbportfolio2.view.layoutRootPath}

plugin.tx_sbportfolio2.persistence¶

storagePid¶

Property

storagePid

Type

integer/string

Description

The PID(s) of the page where the portfolio records are stored. Mutiple IDs can be separated by a comma. i.e. 1,2,3

Default

{$plugin.tx_sbportfolio2.persistence.storagePid}

plugin.tx_sbportfolio2.settings¶

pageBrowser.¶

Property

pageBrowser.

Type

array

Description

Default settings for the page browser.

Default

See the relevant table below.

sortByFields.¶

Property

sortByFields.

Type

array

Description

Default settings for sorting records.

Default

See the relevant table below.

meta.¶

Property

meta.

Type

array

Description

Meta tags for single views.

Default

See the relevant table below.

client.¶

Property

client.

Type

array

Description

Settings for clients.

Default

See the relevant table below.

item.¶

Property

item.

Type

array

Description

Settings for items.

Default

See the relevant table below.

category.¶

Property

category.

Type

array

Description

Settings for categories.

Default

See the relevant table below.

slider.¶

Property

slider.

Type

array

Description

Settings for content sliders.

Default

See the relevant table below.

tag.¶

Property

tag.

Type

array

Description

Settings for tags.

Default

See the relevant table below.

testimonial.¶

Property

testimonial.

Type

array

Description

Settings for testimonials.

Default

See the relevant table below.

plugin.tx_sbportfolio2.settings.pageBrowser¶

itemsPerPage.¶

Property

itemsPerPage.

Type

integer

Description

The number items per page.

Default

10

insertAbove¶

Property

insertAbove

Type

boolean

Description

Should the page browser buttons be shown before the records?

Default

FALSE

insertBelow¶

Property

insertBelow

Type

boolean

Description

Should the page browser buttons be shown after the records?

Default

TRUE

maximumNumberOfLinks¶

Property

maximumNumberOfLinks

Type

integer

Description

The number of clickable “pages” to show in the page browser.

Default

50

plugin.tx_sbportfolio2.settings.sortByFields¶

tstamp¶

Property

tstamp

Type

string

Description

This is a field to sort by.

Default

tstamp

crdate¶

Property

crdate

Type

string

Description

This is a field to sort by.

Default

crdate

title¶

Property

title

Type

string

Description

This is a field to sort by.

Default

title

uid¶

Property

uid

Type

string

Description

This is a field to sort by.

Default

uid

plugin.tx_sbportfolio2.settings.meta¶

image/image.¶

Property

image/image.

Type

TEXT

Description

This is used in the OG Image meta tag.

Default

image = TEXT

image {

current = 1

wrap.data = getIndpEnv:TYPO3_SITE_URL

required = 1

}

url/url.¶

Property

url/url.

Type

TEXT

Description

This is used in the OG URL meta tag.

Default

url = TEXT

url.typolink {

parameter.data = TSFE:id

useCacheHash = 1

forceAbsoluteUrl = 1

addQueryString.method = GET

addQueryString.exclude = id

returnLast = url

}

site_name¶

Property

site_name

Type

sting

Description

Used to create the OG Site Name meta tag.

Default

{$plugin.tx_sbportfolio2.settings.site_name}

app_id¶

Property

app_id

Type

sting

Description

Used to create the FB APP ID meta tag. This is the global value for this tag, but items, clients and catgeories can replace this value with their own.

Default

{$plugin.tx_sbportfolio2.settings.app_id}

admins¶

Property

admins

Type

sting

Description

Used to create the FB Admins meta tag. This is the global value for this tag, but items, clients and catgeories can replace this value with their own.

Default

{$plugin.tx_sbportfolio2.settings.admins}

plugin.tx_sbportfolio2.settings.client¶

records¶

Property

records

Type

array

Description

Settings used to find records.

limit = The number of records to return.
sortByFields = The fields that can be used to sort records.
sortBy = The field (must be in sortByFields) to sort records by.
sortDir = The direction to sort records by.
selection = 1 : Automatic record selection, 2: Manual record selection
include = UIDs of records to include in manual selection
exclude = UIDs of records to exclude in automatic selection.

Default

records {

limit = 10

sortByFields < plugin.tx_sbportfolio2.settings.sortByFields

sortByFields.datetime = datetime

sortBy = datetime

sortDir = DESC

selection = 1

#include =

#exclude =

}

dateFormat¶

Property

dateFormat

Type

string

Description

The date format for record dates.

Default

{$plugin.tx_sbportfolio2.settings.dateFormat}

items.¶

Property

items.

Type

array

Description

limit = A limit to the number of items shown on the client single page.

Default

items {

limit = 3

}

nextprevious.¶

Property

nextprevious.

Type

array

Description

field - The field used to find the next/previous records. Either 'uid', 'datetime', or 'crdate'

Default

nextprevious {

field = datetime

}

pageBrowser.¶

Property

pageBrowser.

Type

array

Description

Page browser settings for this plugin.

Default

plugin.tx_sbportfolio2.settings.pageBrowser

pids.¶

Property

pids.

Type

array

Description

The page IDs were certain views are displayed.

Default

pids {

list = 1

single = 1

}

plugin.tx_sbportfolio2.settings.item¶

records¶

Property

records

Type

array

Description

Settings used to find records.

limit = The number of records to return.
inprogress = How inprogress items should be handled: 'include', 'only' or 'exclude'
featured = How featured items should be handled: 'include', 'only' or 'exclude'
sortByFields = The fields that can be used to sort records.
sortBy = The field (must be in sortByFields) to sort records by.
sortDir = The direction to sort records by.
selection = 1 : Automatic record selection, 2: Manual record selection
include = UIDs of records to include in manual selection
exclude = UIDs of records to exclude in automatic selection.

Default

records {

limit = 10

inprogress = exclude

featured = include

sortByFields < plugin.tx_sbportfolio2.settings.sortByFields

sortByFields.datetime = datetime

sortBy = datetime

sortDir = DESC

selection = 1

#include =

#exclude =

}

dateFormat¶

Property

dateFormat

Type

string

Description

The date format for record dates.

Default

{$plugin.tx_sbportfolio2.settings.dateFormat}

films.¶

Property

films.

Type

array

Description

Settings for films:

width = The width of embedded hosted films.

hight = The height of embedded hosted films.

media = The media CE setup for films that are files in fileadmin.

Default

films {

width = 200

height = 120

media < tt_content.media.20

media.file.data = field:film

media.width = 200

media.height = 120

}

flickr.¶

Property

flickr.

Type

array

Description

The settings for flickr.

Default

See below.

imageFolders¶

Property

imageFolders

Type

array

Description

Default

imageFolders {

sorting = 1

limit = 1

}

nextprevious.¶

Property

nextprevious.

Type

array

Description

field - The field used to find the next/previous records. Either 'uid', 'datetime', or 'crdate'

Default

nextprevious {

field = datetime

}

pageBrowser.¶

Property

pageBrowser.

Type

array

Description

Page browser settings for this plugin.

Default

plugin.tx_sbportfolio2.settings.pageBrowser

pids.¶

Property

pids.

Type

array

Description

The page IDs were certain views are displayed.

Default

pids {

list = 1

single = 1

}

plugin.tx_sbportfolio2.settings.item.flickr¶

api_key¶

Property

api_key

Type

string

Description

The date format for item dates.

Default

{$plugin.tx_sbportfolio2.settings.api_key}

photosets¶

Property

photosets

Type

array

Description

Settings for flickr API methods used to display flickr sets

Default

photosets.getInfo¶

Property

photosets.getInfo

Type

array

Description

Settings for the flickr API method “flickr.photosets.getInfo”

Default

See below.

photosets.getPhotos¶

Property

photosets.getPhotos

Type

array

Description

Settings for the flickr API method “flickr.photosets.getPhotos”

Default

See below.

plugin.tx_sbportfolio2.settings.item.flickr.getInfo¶

method¶

Property

method

Type

string

Description

The name of the flickr API method.Used internally, DON'T CHANGE

Default

flickr.photosets.getInfo

plugin.tx_sbportfolio2.settings.item.flickr.getPhotos¶

method¶

Property

method

Type

string

Description

The name of the flickr API method.Used internally, DON'T CHANGE

Default

flickr.photosets.getPhotos

extras¶

Property

extras

Type

string

Description

A comma-delimited list of extra information to fetch for each returned record.

Currently supported fields are: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags, o_dims, views, media, path_alias, url_sq, url_t, url_s, url_m, url_o

Default

description

per_page¶

Property

per_page

Type

integer

Description

Number of photos to return per page. If this argument is omitted, it defaults to 500. The maximum allowed value is 500.

Default

20

page¶

Property

page

Type

integer

Description

The page of results to return. If this argument is omitted, it defaults to 1.

Default

media¶

Property

media

Type

string

Description

Filter results by media type. Possible values are all (default), photos or videos

Default

All

plugin.tx_sbportfolio2.settings.category¶

records¶

Property

records

Type

array

Description

Settings used to find records.

beginAt = The id of the category to begin at - the root category for the list . Examples:

10 : Gets all categories which are sub-categories of the category with the uid 10.

0 : Gets all categories which are not subcategories .

-1 means render a flat list .

0+ means render a tree.
depth = The number of levels in the tree to collect categories for, default is 1.

1 means only get the current level, 2 means get the first subcategories, etc..

depth has no effect if rendering a list, only a tree.
limit = The number of records to return.
sortByFields = The fields that can be used to sort records.
sortBy = The field (must be in sortByFields) to sort records by.
sortDir = The direction to sort records by.
selection = 1 : Automatic record selection, 2: Manual record selection
include = UIDs of records to include in manual selection
exclude = UIDs of records to exclude in automatic selection.

Default

Records {

beginAt = 0

depth = 1

limit = 10

sortByFields < plugin.tx_sbportfolio2.settings.sortByFields

sortByFields.datetime = datetime

sortBy = datetime

sortDir = DESC

selection = 1

#include =

#exclude =

}

clients.¶

Property

clients.

Type

array

Description

Setttings for getting client records related to a category.

Default

clients {

records < plugin.tx_sbportfolio2.settings.client.records

}

items.¶

Property

items.

Type

array

Description

Setttings for getting item records related to a category.

Default

items {

records < plugin.tx_sbportfolio2.settings.item.records

}

nextprevious.¶

Property

nextprevious.

Type

array

Description

field - The field used to find the next/previous records. Either 'uid', or 'crdate'.

There is no 'datetime' for categories!

Default

nextprevious {

field = crdate

}

pageBrowser.¶

Property

pageBrowser.

Type

array

Description

Page browser settings for this plugin.

Default

plugin.tx_sbportfolio2.settings.pageBrowser

pids.¶

Property

pids.

Type

array

Description

The page IDs were certain views are displayed.

Default

pids {

single = 1

}

plugin.tx_sbportfolio2.settings.slider¶

records¶

Property

records

Type

array

Description

Settings used to find records.

limit = The number of records to return.
sortByFields = The fields that can be used to sort records.
sortBy = The field (must be in sortByFields) to sort records by.
sortDir = The direction to sort records by.
selection = 1 : Automatic record selection, 2: Manual record selection
include = UIDs of records to include in manual selection
exclude = UIDs of records to exclude in automatic selection.

Default

records {

limit = 10

sortByFields < plugin.tx_sbportfolio2.settings.sortByFields

sortBy = crdate

sortDir = DESC

selection = 1

#include =

#exclude =

}

plugin.tx_sbportfolio2.settings.tag¶

records¶

Property

records

Type

array

Description

Settings used to find records.

limit = The number of records to return.
sortByFields = The fields that can be used to sort records.
sortBy = The field (must be in sortByFields) to sort records by.
sortDir = The direction to sort records by.
selection = 1 : Automatic record selection, 2: Manual record selection
include = UIDs of records to include in manual selection
exclude = UIDs of records to exclude in automatic selection.

Default

records {

limit = 10

sortByFields < plugin.tx_sbportfolio2.settings.sortByFields

sortBy = title

sortDir = ASC

selection = 1

#include =

#exclude =

}

pageBrowser.¶

Property

pageBrowser.

Type

array

Description

Page browser settings for this plugin.

Default

plugin.tx_sbportfolio2.settings.pageBrowser

plugin.tx_sbportfolio2.settings.testimonial¶

records¶

Property

records

Type

array

Description

Settings used to find records.

limit = The number of records to return.
sortByFields = The fields that can be used to sort records.
sortBy = The field (must be in sortByFields) to sort records by.
sortDir = The direction to sort records by.
selection = 1 : Automatic record selection, 2: Manual record selection
include = UIDs of records to include in manual selection
exclude = UIDs of records to exclude in automatic selection.

Default

records {

limit = 10

sortByFields < plugin.tx_sbportfolio2.settings.sortByFields

sortBy = crdate

sortDir = DESC

selection = 1

#include =

#exclude =

}

dateFormat¶

Property

dateFormat

Type

string

Description

The date format for record dates.

Default

{$plugin.tx_sbportfolio2.settings.dateFormat}

pageBrowser.¶

Property

pageBrowser.

Type

array

Description

Page browser settings for testimonial lists.

Default

pageBrowser {

itemsPerPage = 3

insertAbove = FALSE

insertBelow = TRUE

}

Templates¶

sb_portfolio2 is templated with Fluid, TYPO3's new templating system. You should first learn a bit about fluid and read about the ViewHelpers that come with fluid, all of which you can use in your templates.

http://wiki.typo3.org/Fluid#Standard_View_Helpers

The following sb_portfolio2 ViewHelpers are also available for you to use. You must add the correct namespace to your templates:

{namespace sbp2=Tx_SbPortfolio2_ViewHelpers}

The documentation has been written in the PHP so I won't duplicate it here, please look at the ViewHelpers code to see what properties each expects.

To-do List¶

Write a proper installation section
Write a tutorial section

Change Log¶

See the changelog text file in the sb_portfolio2 folder.

Bugs¶

Please report all bugs at the sb_portfolio2 forge page:

http://forge.typo3.org/projects/extension-sb_portfolio2/

40

EXT: SB Portfolio 2¶

EXT: SB Portfolio 2¶

Table of Contents¶

Introduction¶

What does it do?¶

Features:¶

What doesn't work at the moment¶

What's new in this version?¶

Manual¶

Viewhelpers¶

File records¶

Client records¶

Item records¶

Flickr¶

Misc.¶

Installation¶

Item Records¶

General Tab¶

Language¶

Title¶

Title (Full)¶

Title (Short)¶

Type of Item¶

Featured¶

In-progress¶

Date¶

Summary¶

Full description¶

Type Fields¶

Page¶

URL¶

File¶

File Information Palette¶

File Name¶

File Extension¶

File Size¶

File Path¶

Media Tab¶

Preview Image¶

Images¶

Image Folders¶

Films¶

Photoset ID¶

Related Tab¶

Link¶

Testimonial¶

Related Link¶

Related Files¶

Related Items¶

Categorisation Tab¶

Client¶

Categories¶

Tags¶

SEO Tab¶

OG Title¶

OG Type¶

OG Image¶

OG Description¶

FB App ID¶

FB Administrators¶

Visibility Tab¶

Hidden¶

Display From¶

Display Until¶

Category Records¶

General Tab¶

Language¶

Title¶

Title (Full)¶

Title (Short)¶

Summary¶

Full description¶

Media Tab¶

Image¶

Related Tab¶

Related Link¶

Related Files¶

Related Items¶

Categorisation Tab¶

Tags¶