.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt =================== 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 |img-1| EXT: SB Portfolio 2 - sb\_portfolio2 .. _EXT-SB-Portfolio-2: EXT: SB Portfolio 2 =================== Extension Key: sb\_portfolio2 Language: en Keywords: forEditors, forAdmins, forDevelopers, forIntermediates Copyright 2000-2010, Author Name, 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: Table of Contents ----------------- `EXT: SB Portfolio 2 1 <#__RefHeading__1357_1972601825>`_ **`Introduction 3 <#__RefHeading__1359_1972601825>`_** `What does it do? 3 <#__RefHeading__1361_1972601825>`_ `Features: 3 <#__RefHeading__1363_1972601825>`_ `What doesn't work at the moment 3 <#__RefHeading__1365_1972601825>`_ `What's new in this version? 3 <#__RefHeading__6821_2059369532>`_ **`Installation 5 <#__RefHeading__1367_1972601825>`_** **`Item Records 6 <#__RefHeading__6011_1720785869>`_** `General Tab 6 <#__RefHeading__1369_1972601825>`_ `Type Fields 6 <#__RefHeading__2905_154025061>`_ `File Information Palette 6 <#__RefHeading__2911_154025061>`_ `Media Tab 6 <#__RefHeading__1371_1972601825>`_ `Related Tab 7 <#__RefHeading__790_1224361696>`_ `Categorisation Tab 7 <#__RefHeading__792_1224361696>`_ `SEO Tab 7 <#__RefHeading__960_1224361696>`_ `Visibility Tab 7 <#__RefHeading__949_154025061>`_ **`Category Records 8 <#__RefHeading__951_154025061>`_** `General Tab 8 <#__RefHeading__1369_19726018251>`_ `Media Tab 8 <#__RefHeading__1371_19726018251>`_ `Related Tab 8 <#__RefHeading__790_12243616961>`_ `Categorisation Tab 8 <#__RefHeading__792_12243616961>`_ `SEO Tab 8 <#__RefHeading__960_12243616961>`_ `Visibility Tab 8 <#__RefHeading__953_154025061>`_ **`Client Records 9 <#__RefHeading__1164_154025061>`_** `General Tab 9 <#__RefHeading__1369_19726018252>`_ `Media Tab 9 <#__RefHeading__1371_19726018252>`_ `Related Tab 9 <#__RefHeading__790_12243616962>`_ `Categorisation Tab 9 <#__RefHeading__792_12243616962>`_ `SEO Tab 9 <#__RefHeading__960_12243616962>`_ `Visibility Tab 9 <#__RefHeading__949_1540250611>`_ **`File Records 11 <#__RefHeading__1471_154025061>`_** `General Tab 11 <#__RefHeading__1369_197260182521>`_ `File Information Palette 11 <#__RefHeading__1473_154025061>`_ `Visibility Tab 11 <#__RefHeading__949_15402506111>`_ **`Film Records 12 <#__RefHeading__2402_154025061>`_** `General Tab 12 <#__RefHeading__1369_1972601825211>`_ `Type Fields 12 <#__RefHeading__4608_154025061>`_ `File Information Palette 12 <#__RefHeading__1473_1540250611>`_ `Visibility Tab 12 <#__RefHeading__949_154025061111>`_ **`Image Records 13 <#__RefHeading__4241_154025061>`_** `General Tab 13 <#__RefHeading__1369_19726018252111>`_ `Image Information Palette 13 <#__RefHeading__1473_15402506111>`_ `Visibility Tab 13 <#__RefHeading__4243_154025061>`_ **`Image Folder Records 14 <#__RefHeading__4245_154025061>`_** `General Tab 14 <#__RefHeading__1369_197260182521111>`_ `Visibility Tab 14 <#__RefHeading__4247_154025061>`_ **`Link Records 15 <#__RefHeading__4249_154025061>`_** `General Tab 15 <#__RefHeading__1369_1972601825211111>`_ `Type Fields 15 <#__RefHeading__4612_154025061>`_ `File Information Palette 15 <#__RefHeading__4255_154025061>`_ `Visibility Tab 16 <#__RefHeading__4269_154025061>`_ **`Tag Records 17 <#__RefHeading__5534_154025061>`_** `General Tab 17 <#__RefHeading__1369_19726018252111111>`_ `Visibility Tab 17 <#__RefHeading__4269_1540250611>`_ **`Testimonial Records 18 <#__RefHeading__5536_154025061>`_** `General Tab 18 <#__RefHeading__1369_197260182521111111>`_ `Credit Tab 18 <#__RefHeading__5538_154025061>`_ `Visibility Tab 18 <#__RefHeading__4269_15402506111>`_ **`Slider Records 19 <#__RefHeading__5540_154025061>`_** `General Tab 19 <#__RefHeading__1369_19726018252111112>`_ `Type Fields 19 <#__RefHeading__4612_1540250612>`_ `Media Tab 19 <#__RefHeading__5933_154025061>`_ `Visibility Tab 19 <#__RefHeading__4269_1540250612>`_ **`Item Plugin 21 <#__RefHeading__6287_154025061>`_** `General Tab 21 <#__RefHeading__6623_1187495877>`_ **`Client Plugin 22 <#__RefHeading__6625_1187495877>`_** `General Tab 22 <#__RefHeading__6627_1187495877>`_ **`Category Plugin 23 <#__RefHeading__6629_1187495877>`_** `General Tab 23 <#__RefHeading__6631_1187495877>`_ **`Slider Plugin 24 <#__RefHeading__6633_1187495877>`_** `General Tab 24 <#__RefHeading__6635_1187495877>`_ **`Tag Plugin 25 <#__RefHeading__6637_1187495877>`_** `General Tab 25 <#__RefHeading__6639_1187495877>`_ **`Testimonial Plugin 26 <#__RefHeading__6641_1187495877>`_** `General Tab 26 <#__RefHeading__6643_1187495877>`_ **`Backend Module 27 <#__RefHeading__6645_1187495877>`_** `Import Function 27 <#__RefHeading__6289_154025061>`_ **`TypoScript Constant Reference 29 <#__RefHeading__6425_2059369532>`_** `plugin.tx\_sbportfolio2.view 29 <#__RefHeading__4190_9921872801>`_ `plugin.tx\_sbportfolio2.persistence 29 <#__RefHeading__6427_2059369532>`_ `plugin.tx\_sbportfolio2.settings 29 <#__RefHeading__6429_2059369532>`_ **`TypoScript Setup Reference 30 <#__RefHeading__4188_992187280>`_** `plugin.tx\_sbportfolio2.view 30 <#__RefHeading__6431_2059369532>`_ `plugin.tx\_sbportfolio2.persistence 30 <#__RefHeading__4192_992187280>`_ `plugin.tx\_sbportfolio2.settings 30 <#__RefHeading__4194_992187280>`_ `plugin.tx\_sbportfolio2.settings.pageBrowser 30 <#__RefHeading__6417_1375638942>`_ `plugin.tx\_sbportfolio2.settings.sortByFields 31 <#__RefHeading__6419_1375638942>`_ `plugin.tx\_sbportfolio2.settings.meta 31 <#__RefHeading__4885_992187280>`_ `plugin.tx\_sbportfolio2.settings.client 31 <#__RefHeading__6421_1375638942>`_ `plugin.tx\_sbportfolio2.settings.item 32 <#__RefHeading__6423_1375638942>`_ `plugin.tx\_sbportfolio2.settings.item.flickr 33 <#__RefHeading__6425_1375638942>`_ `plugin.tx\_sbportfolio2.settings.item.flickr.getInfo 33 <#__RefHeading__5374_2059369532>`_ `plugin.tx\_sbportfolio2.settings.item.flickr.getPhotos 33 <#__RefHeading__5376_2059369532>`_ `plugin.tx\_sbportfolio2.settings.category 34 <#__RefHeading__6427_1375638942>`_ `plugin.tx\_sbportfolio2.settings.slider 35 <#__RefHeading__6429_1375638942>`_ `plugin.tx\_sbportfolio2.settings.tag 35 <#__RefHeading__6431_1375638942>`_ `plugin.tx\_sbportfolio2.settings.testimonial 36 <#__RefHeading__6433_1375638942>`_ **`Templates 37 <#__RefHeading__6691_2059369532>`_** **`To-do List 38 <#__RefHeading__6013_1720785869>`_** **`Change Log 39 <#__RefHeading__6015_1720785869>`_** **`Bugs 40 <#__RefHeading__6017_1720785869>`_** .. _Introduction: Introduction ------------ .. _What-does-it-do: 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: 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: 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: What's new in this version? ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Manual: Manual """""" .. container:: table-row Change Manual Description Documented new features and TS settings. .. _Viewhelpers: Viewhelpers """"""""""" .. container:: table-row Change Viewhelpers Description Added image class specific classes .. _File-records: File records """""""""""" .. container:: table-row Change File records Description Added file type class to links of type = 1 (file) .. _Client-records: Client records """""""""""""" .. container:: table-row Change Client records Description Added logo field .. _Item-records: Item records """""""""""" .. container:: table-row 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: Flickr """""" .. container:: table-row Change Flickr Description Fixed problem with flickr trying to use a flickrimages oauth class. .. _Misc: Misc. """"" .. container:: table-row Change Misc. Description - Changed several templates slightly - Changed tca for clients, list, and tags - Added film host to film type 2: url .. ###### END~OF~TABLE ###### .. _Installation: Installation ------------ Install through the extension manager and add sb\_portfolio 2's default TypoScript to your TypoScript template. .. _Item-Records: Item Records ------------ .. _General-Tab: General Tab ^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Language: Language """""""" .. container:: table-row Field Language Description The item's language. Defaults to “Default”. .. _Title: Title """"" .. container:: table-row Field Title Description REQUIRED FIELD - The item's title. .. _Title-Full: Title (Full) """""""""""" .. container:: table-row Field Title (Full) Description The item's full title. .. _Title-Short: Title (Short) """"""""""""" .. container:: table-row Field Title (Short) Description The item's short title, to be used in the FE when space is restricted. .. _Type-of-Item: Type of Item """""""""""" .. container:: table-row 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: Featured """""""" .. container:: table-row Field Featured Description This item is featured. Content elements can be set to include or exclude featured items. .. _In-progress: In-progress """"""""""" .. container:: table-row 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: Date """" .. container:: table-row Field Date Description The item's date. Defaults to the current date/time. .. _Summary: Summary """"""" .. container:: table-row Field Summary Description A summary of the item. This could be used in lists. .. _Full-description: Full description """""""""""""""" .. container:: table-row Field Full description Description A full description of the item. This is an RTE and can be formatted, contain images, links etc. .. ###### END~OF~TABLE ###### .. _Type-Fields: Type Fields ^^^^^^^^^^^ The following additional fields are available depending on the type of item: .. ### BEGIN~OF~TABLE ### .. _Page: Page """" .. container:: table-row Type Page Field Page Description This is the page that the item should link to. .. _URL: URL """ .. container:: table-row Type URL Field URL Description This is the URL that the item should link to. .. _File: File """" .. container:: table-row Type File Field File Description This is a reference to a file in fileadmin. .. ###### END~OF~TABLE ###### .. _File-Information-Palette: 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. .. ### BEGIN~OF~TABLE ### .. _File-Name: File Name """"""""" .. container:: table-row Field File Name Description This is the file name of the file (without the file extension) .. _File-Extension: File Extension """""""""""""" .. container:: table-row Field File Extension Description This is the extension of the file, this will be something like “pdf” or “zip” etc. .. _File-Size: File Size """"""""" .. container:: table-row 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: File Path """"""""" .. container:: table-row Field File Path Description This is the path from fileadmin to the file .. ###### END~OF~TABLE ###### .. _Media-Tab: Media Tab ^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Preview-Image: Preview Image """"""""""""" .. container:: table-row Field Preview Image Description This is a single image record. This could be used in lists. .. _Images: Images """""" .. container:: table-row Field Images Description The item's images, these are separate image records. .. _Image-Folders: Image Folders """"""""""""" .. container:: table-row 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: Films """"" .. container:: table-row Field Films Description The item's films, these are separate film records. .. _Photoset-ID: Photoset ID """"""""""" .. container:: table-row 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. .. ###### END~OF~TABLE ###### .. _Related-Tab: Related Tab ^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Link: Link """" .. container:: table-row Field Link Description This is the main link for the item and is a link record, this could be a website, a file or whatever else you want. .. _Testimonial: Testimonial """"""""""" .. container:: table-row Field Testimonial Description This is a testimonial from your client for the item and is a testimonial record. .. _Related-Link: Related Link """""""""""" .. container:: table-row Field Related Link Description These are link records that relate to this item. .. _Related-Files: Related Files """"""""""""" .. container:: table-row Field Related Files Description These are file records that relate to this item. .. _Related-Items: Related Items """"""""""""" .. container:: table-row Field Related Items Description These are other item records that relate to this item. .. ###### END~OF~TABLE ###### .. _Categorisation-Tab: Categorisation Tab ^^^^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Client: Client """""" .. container:: table-row Field Client Description This is the client that the item was made for. .. _Categories: Categories """""""""" .. container:: table-row Field Categories Description These are the categories that help to classify the item. .. _Tags: Tags """" .. container:: table-row Field Tags Description These are tags used to classify the item. .. ###### END~OF~TABLE ###### .. _SEO-Tab: SEO Tab ^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _OG-Title: OG Title """""""" .. container:: table-row 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: OG Type """"""" .. container:: table-row 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: OG Image """""""" .. container:: table-row 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: OG Description """""""""""""" .. container:: table-row 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: FB App ID """"""""" .. container:: table-row 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: FB Administrators """"""""""""""""" .. container:: table-row 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. .. ###### END~OF~TABLE ###### .. _Visibility-Tab: Visibility Tab ^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Hidden: Hidden """""" .. container:: table-row Field Hidden Description Hides / Shows the item. Enable this check box to hide the item in the FE. .. _Display-From: Display From """""""""""" .. container:: table-row Field Display From Description A date and time when the item should start appearing in the FE. .. _Display-Until: Display Until """"""""""""" .. container:: table-row Field Display Until Description A date and time when the item should stop appearing in the FE. .. ###### END~OF~TABLE ###### .. _Category-Records: Category Records ---------------- .. _General-Tab: General Tab ^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Language: Language """""""" .. container:: table-row Field Language Description The category's language. Defaults to “Default”. .. _Title: Title """"" .. container:: table-row Field Title Description REQUIRED FIELD - The category's title. .. _Title-Full: Title (Full) """""""""""" .. container:: table-row Field Title (Full) Description The category's full title. .. _Title-Short: Title (Short) """"""""""""" .. container:: table-row Field Title (Short) Description The category's short title, to be used in the FE when space is restricted. .. _Summary: Summary """"""" .. container:: table-row Field Summary Description A summary of the category. This could be used in lists. .. _Full-description: Full description """""""""""""""" .. container:: table-row Field Full description Description A full description of the category. This is an RTE and can be formatted, contain images, links etc. .. ###### END~OF~TABLE ###### .. _Media-Tab: Media Tab ^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Image: Image """"" .. container:: table-row Field Image Description This is a single image record and is an icon or image to represent the category. .. ###### END~OF~TABLE ###### .. _Related-Tab: Related Tab ^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Related-Link: Related Link """""""""""" .. container:: table-row Field Related Link Description These are link records that relate to this category. Category links are inherited by items/clients within the category. .. _Related-Files: Related Files """"""""""""" .. container:: table-row 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: Related Items """"""""""""" .. container:: table-row Field Related Items Description These are item records that relate to this category. Category related items are inherited by items within the category. .. ###### END~OF~TABLE ###### .. _Categorisation-Tab: Categorisation Tab ^^^^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Tags: Tags """" .. container:: table-row Field Tags Description These are tags used to classify the category. Category tags are inherited by items/clients within the category. .. _Parent-Category: Parent Category """"""""""""""" .. container:: table-row 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. .. ###### END~OF~TABLE ###### .. _SEO-Tab: SEO Tab ^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _OG-Title: OG Title """""""" .. container:: table-row 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: OG Type """"""" .. container:: table-row 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: OG Image """""""" .. container:: table-row 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: OG Description """""""""""""" .. container:: table-row 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: FB App ID """"""""" .. container:: table-row 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: FB Administrators """"""""""""""""" .. container:: table-row 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. .. ###### END~OF~TABLE ###### .. _Visibility-Tab: Visibility Tab ^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Hidden: Hidden """""" .. container:: table-row Field Hidden Description Hides / Shows the category. Enable this check box to hide the category in the FE. .. _Display-From: Display From """""""""""" .. container:: table-row Field Display From Description A date and time when the category should start appearing in the FE. .. _Display-Until: Display Until """"""""""""" .. container:: table-row Field Display Until Description A date and time when the category should stop appearing in the FE. .. ###### END~OF~TABLE ###### .. _Client-Records: Client Records -------------- .. _General-Tab: General Tab ^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Language: Language """""""" .. container:: table-row Field Language Description The client's language. Defaults to “Default”. .. _Title: Title """"" .. container:: table-row Field Title Description REQUIRED FIELD - The client's title. .. _Title-Full: Title (Full) """""""""""" .. container:: table-row Field Title (Full) Description The client's full title. .. _Title-Short: Title (Short) """"""""""""" .. container:: table-row Field Title (Short) Description The client's short title, to be used in the FE when space is restricted. .. _Date: Date """" .. container:: table-row Field Date Description The client's date (when they first became a client). Defaults to the current date/time. .. _Summary: Summary """"""" .. container:: table-row Field Summary Description A summary of the client. This could be used in lists. .. _Full-description: Full description """""""""""""""" .. container:: table-row Field Full description Description A full description of the client. This is an RTE and can be formatted, contain images, links etc. .. ###### END~OF~TABLE ###### .. _Media-Tab: Media Tab ^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Image: Image """"" .. container:: table-row Field Image Description This is a single image record. This could be used in lists. .. ###### END~OF~TABLE ###### .. _Related-Tab: Related Tab ^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Link: Link """" .. container:: table-row 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: Testimonial """"""""""" .. container:: table-row Field Testimonial Description This is a testimonial from your client and is a testimonial record. .. _Related-Link: Related Link """""""""""" .. container:: table-row Field Related Link Description These are link records that relate to this client. .. _Related-Files: Related Files """"""""""""" .. container:: table-row Field Related Files Description These are file records that relate to this client. .. ###### END~OF~TABLE ###### .. _Categorisation-Tab: Categorisation Tab ^^^^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Categories: Categories """""""""" .. container:: table-row Field Categories Description These are the categories that help to classify the client. .. _Tags: Tags """" .. container:: table-row Field Tags Description These are tags used to classify the client. .. ###### END~OF~TABLE ###### .. _SEO-Tab: SEO Tab ^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _OG-Title: OG Title """""""" .. container:: table-row 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: OG Type """"""" .. container:: table-row 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: OG Image """""""" .. container:: table-row 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: OG Description """""""""""""" .. container:: table-row 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: FB App ID """"""""" .. container:: table-row 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: FB Administrators """"""""""""""""" .. container:: table-row 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. .. ###### END~OF~TABLE ###### .. _Visibility-Tab: Visibility Tab ^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Hidden: Hidden """""" .. container:: table-row Field Hidden Description Hides / Shows the client. Enable this check box to hide the client in the FE. .. _Display-From: Display From """""""""""" .. container:: table-row Field Display From Description A date and time when the client should start appearing in the FE. .. _Display-Until: Display Until """"""""""""" .. container:: table-row Field Display Until Description A date and time when the client should stop appearing in the FE. .. ###### END~OF~TABLE ###### .. _File-Records: File Records ------------ .. _General-Tab: General Tab ^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Language: Language """""""" .. container:: table-row Field Language Description The file's language. Defaults to “Default”. .. _Title: Title """"" .. container:: table-row Field Title Description REQUIRED FIELD - The file's title. .. _Title-Full: Title (Full) """""""""""" .. container:: table-row Field Title (Full) Description The file's full title. .. _Title-Short: Title (Short) """"""""""""" .. container:: table-row Field Title (Short) Description The file's short title, to be used in the FE when space is restricted. .. _Description: Description """"""""""" .. container:: table-row Field Description Description A description of the file. .. _File: File """" .. container:: table-row Field File Description This is a reference to a file in fileadmin. .. ###### END~OF~TABLE ###### .. _File-Information-Palette: 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. .. ### BEGIN~OF~TABLE ### .. _File-Name: File Name """"""""" .. container:: table-row Field File Name Description This is the file name of the file (without the file extension) .. _File-Extension: File Extension """""""""""""" .. container:: table-row Field File Extension Description This is the extension of the file, this will be something like “pdf” or “zip” etc. .. _File-Size: File Size """"""""" .. container:: table-row 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: File Path """"""""" .. container:: table-row Field File Path Description This is the path from fileadmin to the file .. ###### END~OF~TABLE ###### .. _Visibility-Tab: Visibility Tab ^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Hidden: Hidden """""" .. container:: table-row Field Hidden Description Hides / Shows the file. Enable this check box to hide the file in the FE. .. _Display-From: Display From """""""""""" .. container:: table-row Field Display From Description A date and time when the file should start appearing in the FE. .. _Display-Until: Display Until """"""""""""" .. container:: table-row Field Display Until Description A date and time when the file should stop appearing in the FE. .. ###### END~OF~TABLE ###### .. _Film-Records: Film Records ------------ .. _General-Tab: General Tab ^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Language: Language """""""" .. container:: table-row Field Language Description The film's language. Defaults to “Default”. .. _Title: Title """"" .. container:: table-row Field Title Description REQUIRED FIELD - The film's title. .. _Title-Full: Title (Full) """""""""""" .. container:: table-row Field Title (Full) Description The film's full title. .. _Title-Short: Title (Short) """"""""""""" .. container:: table-row Field Title (Short) Description The film's short title, to be used in the FE when space is restricted. .. _Type-of-Film: Type of Film """""""""""" .. container:: table-row 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: Description """"""""""" .. container:: table-row Field Description Description A description of the film. .. _Preview-Image: Preview Image """"""""""""" .. container:: table-row Field Preview Image Description This is a single image record. This could be used in lists. .. ###### END~OF~TABLE ###### .. _Type-Fields: Type Fields ^^^^^^^^^^^ The following additional fields are available depending on the type of film: .. ### BEGIN~OF~TABLE ### .. _Hosted-Film: Hosted Film """"""""""" .. container:: table-row 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: Hosted Film """"""""""" .. container:: table-row Type Hosted Film Field Host Film ID Description This is the ID of the film on the host's site. .. _File: File """" .. container:: table-row Type File Field Film File Description This is a reference to a film in fileadmin. .. _URL: URL """ .. container:: table-row Type URL Field Film URL Description This is a URL to a film or the site where the film is displayed. .. ###### END~OF~TABLE ###### .. _File-Information-Palette: 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. .. ### BEGIN~OF~TABLE ### .. _File-Name: File Name """"""""" .. container:: table-row Field File Name Description This is the file name of the file (without the file extension) .. _File-Extension: File Extension """""""""""""" .. container:: table-row Field File Extension Description This is the extension of the file, this will be something like “mov” or “mp4” etc. .. _File-Size: File Size """"""""" .. container:: table-row 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: File Path """"""""" .. container:: table-row Field File Path Description This is the path from fileadmin to the file .. ###### END~OF~TABLE ###### .. _Visibility-Tab: Visibility Tab ^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Hidden: Hidden """""" .. container:: table-row Field Hidden Description Hides / Shows the film. Enable this check box to hide the film in the FE. .. _Display-From: Display From """""""""""" .. container:: table-row Field Display From Description A date and time when the film should start appearing in the FE. .. _Display-Until: Display Until """"""""""""" .. container:: table-row Field Display Until Description A date and time when the film should stop appearing in the FE. .. ###### END~OF~TABLE ###### .. _Image-Records: Image Records ------------- .. _General-Tab: General Tab ^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Language: Language """""""" .. container:: table-row Field Language Description The image's language. Defaults to “Default”. .. _Title: Title """"" .. container:: table-row Field Title Description REQUIRED FIELD - The image's title. .. _Title-Full: Title (Full) """""""""""" .. container:: table-row Field Title (Full) Description The image's full title. .. _Title-Short: Title (Short) """"""""""""" .. container:: table-row Field Title (Short) Description The image's short title, to be used in the FE when space is restricted. .. _Image: Image """"" .. container:: table-row Field Image Description This is a reference to an image in fileadmin. .. _Description: Description """"""""""" .. container:: table-row Field Description Description A description of the film. .. _Caption: Caption """"""" .. container:: table-row Field Caption Description This is a caption to be displayed with the film .. ###### END~OF~TABLE ###### .. _Image-Information-Palette: 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. .. ### BEGIN~OF~TABLE ### .. _Image-Name: Image Name """""""""" .. container:: table-row Field Image Name Description This is the file name of the image (without the file extension) .. _Image-Extension: Image Extension """"""""""""""" .. container:: table-row Field Image Extension Description This is the extension of the image, this will be something like “jpg” or “png” etc. .. _Image-Size: Image Size """""""""" .. container:: table-row 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: Image Path """""""""" .. container:: table-row Field Image Path Description This is the path from fileadmin to the image. .. _Image-Width: Image Width """"""""""" .. container:: table-row Field Image Width Description The width of the image in pixels. .. _Image-Height: Image Height """""""""""" .. container:: table-row Field Image Height Description The height of the image in pixels. .. _Image-Orientation: Image Orientation """"""""""""""""" .. container:: table-row 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. .. ###### END~OF~TABLE ###### .. _Visibility-Tab: Visibility Tab ^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Hidden: Hidden """""" .. container:: table-row Field Hidden Description Hides / Shows the image. Enable this check box to hide the image in the FE. .. _Display-From: Display From """""""""""" .. container:: table-row Field Display From Description A date and time when the image should start appearing in the FE. .. _Display-Until: Display Until """"""""""""" .. container:: table-row Field Display Until Description A date and time when the image should stop appearing in the FE. .. ###### END~OF~TABLE ###### .. _Image-Folder-Records: Image Folder Records -------------------- .. _General-Tab: General Tab ^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Language: Language """""""" .. container:: table-row Field Language Description The image folder's language. Defaults to “Default”. .. _Title: Title """"" .. container:: table-row Field Title Description REQUIRED FIELD - The image folder's title. .. _Title-Full: Title (Full) """""""""""" .. container:: table-row Field Title (Full) Description The image folder's full title. .. _Title-Short: Title (Short) """"""""""""" .. container:: table-row Field Title (Short) Description The image folder's short title, to be used in the FE when space is restricted. .. _Description: Description """"""""""" .. container:: table-row Field Description Description A description of the image folder. .. _Folders: Folders """"""" .. container:: table-row Field Folders Description These are references to image folders within fileadmin. An image folder record can have more than one folder associated with it. .. ###### END~OF~TABLE ###### .. _Visibility-Tab: Visibility Tab ^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Hidden: Hidden """""" .. container:: table-row Field Hidden Description Hides / Shows the image folder. Enable this check box to hide the image folder in the FE. .. _Display-From: Display From """""""""""" .. container:: table-row Field Display From Description A date and time when the image folder should start appearing in the FE. .. _Display-Until: Display Until """"""""""""" .. container:: table-row Field Display Until Description A date and time when the image folder should stop appearing in the FE. .. ###### END~OF~TABLE ###### .. _Link-Records: Link Records ------------ .. _General-Tab: General Tab ^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Language: Language """""""" .. container:: table-row Field Language Description The links's language. Defaults to “Default”. .. _Title: Title """"" .. container:: table-row Field Title Description REQUIRED FIELD - The links's title. .. _Title-Full: Title (Full) """""""""""" .. container:: table-row Field Title (Full) Description The links's full title. .. _Title-Short: Title (Short) """"""""""""" .. container:: table-row Field Title (Short) Description The links's short title, to be used in the FE when space is restricted. .. _Type-of-Link: Type of Link """""""""""" .. container:: table-row 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. .. ###### END~OF~TABLE ###### .. _Type-Fields: Type Fields ^^^^^^^^^^^ The following additional fields are available depending on the type of link: .. ### BEGIN~OF~TABLE ### .. _URL: URL """ .. container:: table-row Type URL Field URL Description A URL to a website or file on another site. .. _File: File """" .. container:: table-row Type File Field File Description This is a reference to a film in fileadmin. .. _Page: Page """" .. container:: table-row Type Page Field Page Description A page that the link links to. .. _Item: Item """" .. container:: table-row Type Item Field Item Description A portfolio item that the link should link to. .. _Client: Client """""" .. container:: table-row Type Client Field Client Description A portfolio client that the link should link to. .. _Category: Category """""""" .. container:: table-row Type Category Field Category Description A portfolio category that the link should link to. .. _Items-filtered-by-category: Items filtered by category """""""""""""""""""""""""" .. container:: table-row Type Items filtered by category Field Category Description A portfolio category that items should be filtered by. .. _Items-filtered-by-client: Items filtered by client """""""""""""""""""""""" .. container:: table-row Type Items filtered by client Field Client Description A portfolio client that items should be filtered by. .. _Items-filtered-by-tag: Items filtered by tag """"""""""""""""""""" .. container:: table-row Type Items filtered by tag Field Tag Description A portfolio tag that items should be filtered by. .. _Clients-filtered-by-category: Clients filtered by category """""""""""""""""""""""""""" .. container:: table-row Type Clients filtered by category Field Category Description A portfolio category that clients should be filtered by. .. _Clients-filtered-by-tag: Clients filtered by tag """"""""""""""""""""""" .. container:: table-row Type Clients filtered by tag Field Tag Description A portfolio tag that clients should be filtered by. .. ###### END~OF~TABLE ###### .. _File-Information-Palette: 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. .. ### BEGIN~OF~TABLE ### .. _File-Name: File Name """"""""" .. container:: table-row Field File Name Description This is the file name of the file (without the file extension) .. _File-Extension: File Extension """""""""""""" .. container:: table-row Field File Extension Description This is the extension of the file, this will be something like “pdf” or “zip” etc. .. _File-Size: File Size """"""""" .. container:: table-row 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: File Path """"""""" .. container:: table-row Field File Path Description This is the path from fileadmin to the file .. ###### END~OF~TABLE ###### .. _Visibility-Tab: Visibility Tab ^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Hidden: Hidden """""" .. container:: table-row Field Hidden Description Hides / Shows the link. Enable this check box to hide the link in the FE. .. _Display-From: Display From """""""""""" .. container:: table-row Field Display From Description A date and time when the link should start appearing in the FE. .. _Display-Until: Display Until """"""""""""" .. container:: table-row Field Display Until Description A date and time when the link should stop appearing in the FE. .. ###### END~OF~TABLE ###### .. _Tag-Records: Tag Records ----------- .. _General-Tab: General Tab ^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Language: Language """""""" .. container:: table-row Field Language Description The tags's language. Defaults to “Default”. .. _Title: Title """"" .. container:: table-row Field Title Description REQUIRED FIELD - The tags's title (the tag itself). .. _Description: Description """"""""""" .. container:: table-row Field Description Description A description of the tag. .. ###### END~OF~TABLE ###### .. _Visibility-Tab: Visibility Tab ^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Hidden: Hidden """""" .. container:: table-row Field Hidden Description Hides / Shows the tag. Enable this check box to hide the tag in the FE. .. _Display-From: Display From """""""""""" .. container:: table-row Field Display From Description A date and time when the tag should start appearing in the FE. .. _Display-Until: Display Until """"""""""""" .. container:: table-row Field Display Until Description A date and time when the tag should stop appearing in the FE. .. ###### END~OF~TABLE ###### .. _Testimonial-Records: Testimonial Records ------------------- .. _General-Tab: General Tab ^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Language: Language """""""" .. container:: table-row Field Language Description The testimonial's language. Defaults to “Default”. .. _Title: Title """"" .. container:: table-row Field Title Description REQUIRED FIELD - The testimonial's title. .. _Testimonial: Testimonial """"""""""" .. container:: table-row Field Testimonial Description The tesimonial text. .. _Date: Date """" .. container:: table-row Field Date Description The date that the testimonial was made. .. ###### END~OF~TABLE ###### .. _Credit-Tab: Credit Tab ^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Name: Name """" .. container:: table-row Field Name Description The name of the person making the testimonial. .. _Company: Company """"""" .. container:: table-row Field Company Description The company that the person making the testimonial works for. .. _Position: Position """""""" .. container:: table-row Field Position Description The position in the company that the person making the testimonial has. .. _Image: Image """"" .. container:: table-row Field Image Description This is an image record. This could be an image of the person making the testimonial or the companies logo. .. ###### END~OF~TABLE ###### .. _Visibility-Tab: Visibility Tab ^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Hidden: Hidden """""" .. container:: table-row Field Hidden Description Hides / Shows the testimonial. Enable this check box to hide the testimonial in the FE. .. _Display-From: Display From """""""""""" .. container:: table-row Field Display From Description A date and time when the testimonial should start appearing in the FE. .. _Display-Until: Display Until """"""""""""" .. container:: table-row Field Display Until Description A date and time when the testimonial should stop appearing in the FE. .. ###### END~OF~TABLE ###### .. _Slider-Records: Slider Records -------------- .. _General-Tab: General Tab ^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Language: Language """""""" .. container:: table-row Field Language Description The slider's language. Defaults to “Default”. .. _Title: Title """"" .. container:: table-row Field Title Description REQUIRED FIELD - The slider's title. .. _Title-Full: Title (Full) """""""""""" .. container:: table-row Field Title (Full) Description The slider's full title. .. _Title-Short: Title (Short) """"""""""""" .. container:: table-row Field Title (Short) Description The slider's short title, to be used in the FE when space is restricted. .. _Type-of-Slider: Type of Slider """""""""""""" .. container:: table-row 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: Summary """"""" .. container:: table-row Field Summary Description A summary of the slider. .. _Full-description: Full description """""""""""""""" .. container:: table-row Field Full description Description A full description of the slider. This is an RTE and can be formatted, contain images, links etc. .. ###### END~OF~TABLE ###### .. _Type-Fields: Type Fields ^^^^^^^^^^^ The following additional fields are available depending on the type of slider: .. ### BEGIN~OF~TABLE ### .. _URL: URL """ .. container:: table-row Type URL Field URL Description A URL to a website or file on another site. .. _Page: Page """" .. container:: table-row Type Page Field Page Description A page that the slider links to. .. _Item: Item """" .. container:: table-row Type Item Field Item Description A portfolio item that the slider should link to. .. _Client: Client """""" .. container:: table-row Type Client Field Client Description A portfolio client that the slider should link to. .. _Category: Category """""""" .. container:: table-row Type Category Field Category Description A portfolio category that the slider should link to. .. _Items-filtered-by-category: Items filtered by category """""""""""""""""""""""""" .. container:: table-row Type Items filtered by category Field Category Description A portfolio category that items should be filtered by. .. _Items-filtered-by-client: Items filtered by client """""""""""""""""""""""" .. container:: table-row Type Items filtered by client Field Client Description A portfolio client that items should be filtered by. .. _Items-filtered-by-tag: Items filtered by tag """"""""""""""""""""" .. container:: table-row Type Items filtered by tag Field Tag Description A portfolio tag that items should be filtered by. .. _Clients-filtered-by-category: Clients filtered by category """""""""""""""""""""""""""" .. container:: table-row Type Clients filtered by category Field Category Description A portfolio category that clients should be filtered by. .. _Clients-filtered-by-tag: Clients filtered by tag """"""""""""""""""""""" .. container:: table-row Type Clients filtered by tag Field Tag Description A portfolio tag that clients should be filtered by. .. ###### END~OF~TABLE ###### .. _Media-Tab: Media Tab ^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Image: Image """"" .. container:: table-row Field Image Description A reference to an image file in fileadmin. This is the main image of the slider. .. _Image-Rollover: Image (Rollover) """""""""""""""" .. container:: table-row Field Image (Rollover) Description A reference to an image file in fileadmin. This is a rollover for the slider image (if required). .. _Icon: Icon """" .. container:: table-row Field Icon Description A reference to an image file in fileadmin. This is an icon for the slider (if required). .. _Logo: Logo """" .. container:: table-row Field Logo Description A reference to an image file in fileadmin. This is a logo for the slider (if required). .. ###### END~OF~TABLE ###### .. _Visibility-Tab: Visibility Tab ^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Hidden: Hidden """""" .. container:: table-row Field Hidden Description Hides / Shows the slider. Enable this check box to hide the slider in the FE. .. _Display-From: Display From """""""""""" .. container:: table-row Field Display From Description A date and time when the slider should start appearing in the FE. .. _Display-Until: Display Until """"""""""""" .. container:: table-row Field Display Until Description A date and time when the slider should stop appearing in the FE. .. ###### END~OF~TABLE ###### .. _Item-Plugin: 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: General Tab ^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Record-selection: Record selection """""""""""""""" .. container:: table-row 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: Number of items """"""""""""""" .. container:: table-row Field Number of items Visibility Automatic Description How many items in total should be displayed. .. _Number-of-items-per-page: Number of items per page """""""""""""""""""""""" .. container:: table-row Field Number of items per page Visibility Always Description How many items should be displayed on each page. .. _Sort-field: Sort field """""""""" .. container:: table-row Field Sort field Visibility Automatic Description Sort the records by: - Title - ID - Date / Time - Updated Date - Creation Date .. _Sort-direction: Sort direction """""""""""""" .. container:: table-row Field Sort direction Visibility Automatic Description Either ascending or descending .. _Featured-Items: Featured Items """""""""""""" .. container:: table-row Field Featured Items Visibility Automatic Description This setting controls whether featured items are displayed or not. Options are: \- Include featured items \- Exclude featured items \- Only featured items .. _In-progress-Items: In-progress Items """"""""""""""""" .. container:: table-row 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: Exclude these items """"""""""""""""""" .. container:: table-row Field Exclude these items Visibility Automatic Description Select which items are to be excluded from display. .. _Items-to-display: Items to display """""""""""""""" .. container:: table-row Field Items to display Visibility Manual Description Select which items are to be display.ed. .. ###### END~OF~TABLE ###### .. _Client-Plugin: 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: General Tab ^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Record-selection: Record selection """""""""""""""" .. container:: table-row 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: Number of clients """"""""""""""""" .. container:: table-row Field Number of clients Visibility Automatic Description How many clients in total should be displayed. .. _Number-of-clients-per-page: Number of clients per page """""""""""""""""""""""""" .. container:: table-row Field Number of clients per page Visibility Always Description How many clients should be displayed on each page. .. _Sort-field: Sort field """""""""" .. container:: table-row Field Sort field Visibility Automatic Description Sort the records by: - Title - ID - Date / Time - Updated Date - Creation Date .. _Sort-direction: Sort direction """""""""""""" .. container:: table-row Field Sort direction Visibility Automatic Description Either ascending or descending .. _Exclude-these-clients: Exclude these clients """"""""""""""""""""" .. container:: table-row Field Exclude these clients Visibility Automatic Description Select which clients are to be excluded from display. .. _Clients-to-display: Clients to display """""""""""""""""" .. container:: table-row Field Clients to display Visibility Manual Description Select which clients are to be display.ed. .. ###### END~OF~TABLE ###### .. _Category-Plugin: 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: General Tab ^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Record-selection: Record selection """""""""""""""" .. container:: table-row 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: Number of categories """""""""""""""""""" .. container:: table-row Field Number of categories Visibility Automatic Description How many categories in total should be displayed. .. _Number-of-categories-per-page: Number of categories per page """"""""""""""""""""""""""""" .. container:: table-row Field Number of categories per page Visibility Always Description How many categories should be displayed on each page. .. _Sort-field: Sort field """""""""" .. container:: table-row Field Sort field Visibility Automatic Description Sort the records by: - Title - ID - Date / Time - Updated Date - Creation Date .. _Sort-direction: Sort direction """""""""""""" .. container:: table-row Field Sort direction Visibility Automatic Description Either ascending or descending .. _Display-categories-as: Display categories as: """""""""""""""""""""" .. container:: table-row 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: Select the start of the tree """""""""""""""""""""""""""" .. container:: table-row 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: Number of levels in the tree to display """"""""""""""""""""""""""""""""""""""" .. container:: table-row 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: Exclude these categories """""""""""""""""""""""" .. container:: table-row Field Exclude these categories Visibility Automatic Description Select which categories are to be excluded from display. .. _Categories-to-display: Categories to display """"""""""""""""""""" .. container:: table-row Field Categories to display Visibility Manual Description Select which categories are to be display.ed. .. ###### END~OF~TABLE ###### .. _Slider-Plugin: 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: General Tab ^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Record-selection: Record selection """""""""""""""" .. container:: table-row 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: Number of sliders """"""""""""""""" .. container:: table-row Field Number of sliders Visibility Automatic Description How many slider items in total should be displayed. .. _Number-of-sliders-per-page: Number of sliders per page """""""""""""""""""""""""" .. container:: table-row Field Number of sliders per page Visibility Automatic Description How many categories should be displayed on each page. .. _Sort-field: Sort field """""""""" .. container:: table-row Field Sort field Visibility Automatic Description Sort the records by: - Title - ID - Date / Time - Updated Date - Creation Date .. _Sort-direction: Sort direction """""""""""""" .. container:: table-row Field Sort direction Visibility Automatic Description Either ascending or descending .. _Exclude-these-sliders: Exclude these sliders """"""""""""""""""""" .. container:: table-row Field Exclude these sliders Visibility Automatic Description Select which slider items are to be excluded from display. .. _Sliders-to-display: Sliders to display """""""""""""""""" .. container:: table-row Field Sliders to display Visibility Manual Description Select which slider items are to be display.ed. .. ###### END~OF~TABLE ###### .. _Tag-Plugin: 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: General Tab ^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Record-selection: Record selection """""""""""""""" .. container:: table-row 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: Number of tags """""""""""""" .. container:: table-row Field Number of tags Visibility Automatic Description How many tags in total should be displayed. .. _Number-of-tags-per-page: Number of tags per page """"""""""""""""""""""" .. container:: table-row Field Number of tags per page Visibility Always Description How many tags should be displayed on each page. .. _Sort-field: Sort field """""""""" .. container:: table-row Field Sort field Visibility Automatic Description Sort the records by: - Title - ID - Date / Time - Updated Date - Creation Date .. _Sort-direction: Sort direction """""""""""""" .. container:: table-row Field Sort direction Visibility Automatic Description Either ascending or descending .. _Exclude-these-tags: Exclude these tags """""""""""""""""" .. container:: table-row Field Exclude these tags Visibility Automatic Description Select which tags are to be excluded from display. .. _Tags-to-display: Tags to display """"""""""""""" .. container:: table-row Field Tags to display Visibility Manual Description Select which tags are to be display.ed. .. ###### END~OF~TABLE ###### .. _Testimonial-Plugin: 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: General Tab ^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _Record-selection: Record selection """""""""""""""" .. container:: table-row 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: Number of testimonials """""""""""""""""""""" .. container:: table-row Field Number of testimonials Visibility Automatic Description How many testimonials in total should be displayed. .. _Number-of-testimonials-per-page: Number of testimonials per page """"""""""""""""""""""""""""""" .. container:: table-row Field Number of testimonials per page Visibility Always Description How many testimonials should be displayed on each page. .. _Sort-field: Sort field """""""""" .. container:: table-row Field Sort field Visibility Automatic Description Sort the records by: - Title - ID - Date / Time - Updated Date - Creation Date .. _Sort-direction: Sort direction """""""""""""" .. container:: table-row Field Sort direction Visibility Automatic Description Either ascending or descending .. _Exclude-these-testimonials: Exclude these testimonials """""""""""""""""""""""""" .. container:: table-row Field Exclude these testimonials Visibility Automatic Description Select which testimonials are to be excluded from display. .. _Testimonials-to-display: Testimonials to display """"""""""""""""""""""" .. container:: table-row Field Testimonials to display Visibility Manual Description Select which testimonials are to be display.ed. .. ###### END~OF~TABLE ###### .. _Backend-Module: Backend Module -------------- At the moment there is only one BE module function: Import. .. _Import-Function: Import Function ^^^^^^^^^^^^^^^ This module allows you to import records from sb\_portfolio to sb\_portfolio2. |img-2| 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: |img-3| 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: TypoScript Constant Reference ----------------------------- .. _plugin-tx-sbportfolio2-view: plugin.tx\_sbportfolio2.view ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _templateRootPath: templateRootPath """""""""""""""" .. container:: table-row Property templateRootPath Type string Description A path to the template root. Default EXT:sb\_portfolio2/Resources/Private/Templates/ .. _partialRootPath: partialRootPath """"""""""""""" .. container:: table-row Property partialRootPath Type string Description A path to the template partial. Default EXT:sb\_portfolio2/Resources/Private/Partials/ .. _layoutRootPath: layoutRootPath """""""""""""" .. container:: table-row Property layoutRootPath Type string Description A path to the template layout. Default EXT:sb\_portfolio2/Resources/Private/Layouts/ .. ###### END~OF~TABLE ###### .. _plugin-tx-sbportfolio2-persistence: plugin.tx\_sbportfolio2.persistence ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _storagePid: storagePid """""""""" .. container:: table-row 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} .. ###### END~OF~TABLE ###### .. _plugin-tx-sbportfolio2-settings: plugin.tx\_sbportfolio2.settings ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _api-key: api\_key """""""" .. container:: table-row Property api\_key Type string Description Flickr API Key. Default .. _app-id: app\_id """"""" .. container:: table-row 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: admins """""" .. container:: table-row 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: site\_name """""""""" .. container:: table-row Property site\_name Type string Description Site Name. The OG site name meta tag value. Default .. _dateFormat: dateFormat """""""""" .. container:: table-row 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 .. ###### END~OF~TABLE ###### .. _TypoScript-Setup-Reference: TypoScript Setup Reference -------------------------- .. _plugin-tx-sbportfolio2-view: plugin.tx\_sbportfolio2.view ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _templateRootPath: templateRootPath """""""""""""""" .. container:: table-row Property templateRootPath Type string Description A path to the template root. Default {$plugin.tx\_sbportfolio2.view.templateRootPath} .. _partialRootPath: partialRootPath """"""""""""""" .. container:: table-row Property partialRootPath Type string Description A path to the template partial. Default {$plugin.tx\_sbportfolio2.view.partialRootPath} .. _layoutRootPath: layoutRootPath """""""""""""" .. container:: table-row Property layoutRootPath Type string Description A path to the template layout. Default {$plugin.tx\_sbportfolio2.view.layoutRootPath} .. ###### END~OF~TABLE ###### .. _plugin-tx-sbportfolio2-persistence: plugin.tx\_sbportfolio2.persistence ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _storagePid: storagePid """""""""" .. container:: table-row 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} .. ###### END~OF~TABLE ###### .. _plugin-tx-sbportfolio2-settings: plugin.tx\_sbportfolio2.settings ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _pageBrowser: pageBrowser. """""""""""" .. container:: table-row Property pageBrowser. Type array Description Default settings for the page browser. Default See the relevant table below. .. _sortByFields: sortByFields. """"""""""""" .. container:: table-row Property sortByFields. Type array Description Default settings for sorting records. Default See the relevant table below. .. _meta: meta. """"" .. container:: table-row Property meta. Type array Description Meta tags for single views. Default See the relevant table below. .. _client: client. """"""" .. container:: table-row Property client. Type array Description Settings for clients. Default See the relevant table below. .. _item: item. """"" .. container:: table-row Property item. Type array Description Settings for items. Default See the relevant table below. .. _category: category. """"""""" .. container:: table-row Property category. Type array Description Settings for categories. Default See the relevant table below. .. _slider: slider. """"""" .. container:: table-row Property slider. Type array Description Settings for content sliders. Default See the relevant table below. .. _tag: tag. """" .. container:: table-row Property tag. Type array Description Settings for tags. Default See the relevant table below. .. _testimonial: testimonial. """""""""""" .. container:: table-row Property testimonial. Type array Description Settings for testimonials. Default See the relevant table below. .. ###### END~OF~TABLE ###### .. _plugin-tx-sbportfolio2-settings-pageBrowser: plugin.tx\_sbportfolio2.settings.pageBrowser ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _itemsPerPage: itemsPerPage. """"""""""""" .. container:: table-row Property itemsPerPage. Type integer Description The number items per page. Default 10 .. _insertAbove: insertAbove """"""""""" .. container:: table-row Property insertAbove Type boolean Description Should the page browser buttons be shown before the records? Default FALSE .. _insertBelow: insertBelow """"""""""" .. container:: table-row Property insertBelow Type boolean Description Should the page browser buttons be shown after the records? Default TRUE .. _maximumNumberOfLinks: maximumNumberOfLinks """""""""""""""""""" .. container:: table-row Property maximumNumberOfLinks Type integer Description The number of clickable “pages” to show in the page browser. Default 50 .. ###### END~OF~TABLE ###### .. _plugin-tx-sbportfolio2-settings-sortByFields: plugin.tx\_sbportfolio2.settings.sortByFields ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _tstamp: tstamp """""" .. container:: table-row Property tstamp Type string Description This is a field to sort by. Default tstamp .. _crdate: crdate """""" .. container:: table-row Property crdate Type string Description This is a field to sort by. Default crdate .. _title: title """"" .. container:: table-row Property title Type string Description This is a field to sort by. Default title .. _uid: uid """ .. container:: table-row Property uid Type string Description This is a field to sort by. Default uid .. ###### END~OF~TABLE ###### .. _plugin-tx-sbportfolio2-settings-meta: plugin.tx\_sbportfolio2.settings.meta ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _image-image: image/image. """""""""""" .. container:: table-row 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: url/url. """""""" .. container:: table-row 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: site\_name """""""""" .. container:: table-row Property site\_name Type sting Description Used to create the OG Site Name meta tag. Default {$plugin.tx\_sbportfolio2.settings.site\_name} .. _app-id: app\_id """"""" .. container:: table-row 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: admins """""" .. container:: table-row 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} .. ###### END~OF~TABLE ###### .. _plugin-tx-sbportfolio2-settings-client: plugin.tx\_sbportfolio2.settings.client ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _records: records """"""" .. container:: table-row 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: dateFormat """""""""" .. container:: table-row Property dateFormat Type string Description The date format for record dates. Default {$plugin.tx\_sbportfolio2.settings.dateFormat} .. _items: items. """""" .. container:: table-row Property items. Type array Description limit = A limit to the number of items shown on the client single page. Default items { limit = 3 } .. _nextprevious: nextprevious. """"""""""""" .. container:: table-row 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: pageBrowser. """""""""""" .. container:: table-row Property pageBrowser. Type array Description Page browser settings for this plugin. Default plugin.tx\_sbportfolio2.settings.pageBrowser .. _pids: pids. """"" .. container:: table-row Property pids. Type array Description The page IDs were certain views are displayed. Default pids { list = 1 single = 1 } .. ###### END~OF~TABLE ###### .. _plugin-tx-sbportfolio2-settings-item: plugin.tx\_sbportfolio2.settings.item ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _records: records """"""" .. container:: table-row 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: dateFormat """""""""" .. container:: table-row Property dateFormat Type string Description The date format for record dates. Default {$plugin.tx\_sbportfolio2.settings.dateFormat} .. _films: films. """""" .. container:: table-row 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: flickr. """"""" .. container:: table-row Property flickr. Type array Description The settings for flickr. Default See below. .. _imageFolders: imageFolders """""""""""" .. container:: table-row Property imageFolders Type array Description Default imageFolders { sorting = 1 limit = 1 } .. _nextprevious: nextprevious. """"""""""""" .. container:: table-row 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: pageBrowser. """""""""""" .. container:: table-row Property pageBrowser. Type array Description Page browser settings for this plugin. Default plugin.tx\_sbportfolio2.settings.pageBrowser .. _pids: pids. """"" .. container:: table-row Property pids. Type array Description The page IDs were certain views are displayed. Default pids { list = 1 single = 1 } .. ###### END~OF~TABLE ###### .. _plugin-tx-sbportfolio2-settings-item-flickr: plugin.tx\_sbportfolio2.settings.item.flickr ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _api-key: api\_key """""""" .. container:: table-row Property api\_key Type string Description The date format for item dates. Default {$plugin.tx\_sbportfolio2.settings.api\_key} .. _photosets: photosets """"""""" .. container:: table-row Property photosets Type array Description Settings for flickr API methods used to display flickr sets Default .. _photosets-getInfo: photosets.getInfo """"""""""""""""" .. container:: table-row Property photosets.getInfo Type array Description Settings for the flickr API method “flickr.photosets.getInfo” Default See below. .. _photosets-getPhotos: photosets.getPhotos """"""""""""""""""" .. container:: table-row Property photosets.getPhotos Type array Description Settings for the flickr API method “flickr.photosets.getPhotos” Default See below. .. ###### END~OF~TABLE ###### .. _plugin-tx-sbportfolio2-settings-item-flickr-getInfo: plugin.tx\_sbportfolio2.settings.item.flickr.getInfo ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _method: method """""" .. container:: table-row Property method Type string Description The name of the flickr API method.Used internally, DON'T CHANGE Default flickr.photosets.getInfo .. ###### END~OF~TABLE ###### .. _plugin-tx-sbportfolio2-settings-item-flickr-getPhotos: plugin.tx\_sbportfolio2.settings.item.flickr.getPhotos ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _method: method """""" .. container:: table-row Property method Type string Description The name of the flickr API method.Used internally, DON'T CHANGE Default flickr.photosets.getPhotos .. _extras: extras """""" .. container:: table-row 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: per\_page """"""""" .. container:: table-row 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: page """" .. container:: table-row Property page Type integer Description The page of results to return. If this argument is omitted, it defaults to 1. Default .. _media: media """"" .. container:: table-row Property media Type string Description Filter results by media type. Possible values are all (default), photos or videos Default All .. ###### END~OF~TABLE ###### .. _plugin-tx-sbportfolio2-settings-category: plugin.tx\_sbportfolio2.settings.category ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _records: records """"""" .. container:: table-row 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: clients. """""""" .. container:: table-row Property clients. Type array Description Setttings for getting client records related to a category. Default clients { records < plugin.tx\_sbportfolio2.settings.client.records } .. _items: items. """""" .. container:: table-row Property items. Type array Description Setttings for getting item records related to a category. Default items { records < plugin.tx\_sbportfolio2.settings.item.records } .. _nextprevious: nextprevious. """"""""""""" .. container:: table-row 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: pageBrowser. """""""""""" .. container:: table-row Property pageBrowser. Type array Description Page browser settings for this plugin. Default plugin.tx\_sbportfolio2.settings.pageBrowser .. _pids: pids. """"" .. container:: table-row Property pids. Type array Description The page IDs were certain views are displayed. Default pids { single = 1 } .. ###### END~OF~TABLE ###### .. _plugin-tx-sbportfolio2-settings-slider: plugin.tx\_sbportfolio2.settings.slider ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _records: records """"""" .. container:: table-row 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 = } .. ###### END~OF~TABLE ###### .. _plugin-tx-sbportfolio2-settings-tag: plugin.tx\_sbportfolio2.settings.tag ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _records: records """"""" .. container:: table-row 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: pageBrowser. """""""""""" .. container:: table-row Property pageBrowser. Type array Description Page browser settings for this plugin. Default plugin.tx\_sbportfolio2.settings.pageBrowser .. ###### END~OF~TABLE ###### .. _plugin-tx-sbportfolio2-settings-testimonial: plugin.tx\_sbportfolio2.settings.testimonial ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _records: records """"""" .. container:: table-row 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: dateFormat """""""""" .. container:: table-row Property dateFormat Type string Description The date format for record dates. Default {$plugin.tx\_sbportfolio2.settings.dateFormat} .. _pageBrowser: pageBrowser. """""""""""" .. container:: table-row Property pageBrowser. Type array Description Page browser settings for testimonial lists. Default pageBrowser { itemsPerPage = 3 insertAbove = FALSE insertBelow = TRUE } .. ###### END~OF~TABLE ###### .. _Templates: 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: To-do List ---------- - Write a proper installation section - Write a tutorial section .. _Change-Log: Change Log ---------- See the changelog text file in the sb\_portfolio2 folder. .. _Bugs: Bugs ---- Please report all bugs at the sb\_portfolio2 forge page: :: http://forge.typo3.org/projects/extension-sb_portfolio2/ |img-1| 40 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :border: 0 .. :height: 21 .. :hspace: 9 .. :id: Grafik2 .. :name: Grafik2 .. :width: 87 .. |img-2| image:: img-2.png .. :align: left .. :border: 0 .. :height: 214 .. :id: Grafik1 .. :name: Grafik1 .. :width: 450 .. |img-3| image:: img-3.png .. :align: left .. :border: 0 .. :height: 473 .. :id: Grafik3 .. :name: Grafik3 .. :width: 424