DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

EXT: Pinned Sites

Author:Peter Sandberg Brun
Created:2010-01-13T18:27:41
Changed by:mpbrun
Changed:2011-04-07T13:45:59
Classification:pinned_sites
Keywords:pinned sites, ie9, forAdmins
Author:Peter Sandberg Brun, Mads Sandberg Brun
Dependencies:
Email:peter@mpbrun.dk,mads@mpbrun.dk
Info 4:
Language:en

img-1 img-2 EXT: Pinned Sites - pinned_sites

EXT: Pinned Sites

Extension Key: pinned_sites

Language: en

Keywords: pinned sites, ie9, forAdmins

Copyright 2011, Peter Sandberg Brun, Mads Sandberg Brun, <peter@mpbrun.dk,mads@mpbrun.dk>

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

- a GNU/GPL CMS/Framework available from www.typo3.org

Table of Contents

EXT: Pinned Sites 1

`Introduction 3 <#__RefHeading__14859_467305920>`_

What does it do? 3

Screenshots 3

`Administration 4 <#__RefHeading__14871_467305920>`_

Installation and setup 4

How to setup the extension 4

How to setup a folder with tasks / jump list items 4

How to localize the configuration 5

`Configuration 6 <#__RefHeading__14875_467305920>`_

TypoScript configuration 6

Introduction

What does it do?

This extension provides administrators an easy way to get the new feature of Internet Explorer 9 for Windows 7, namely Pinned Sites, on a TYPO3 website. This extension let you configure all the parameters for such a pinning. This includes the possibilities to define jump list tasks, and a custom jump list category generated either from an RSS feed or a TYPO3 folder.

More information about Pinned Sites can be found at:

This manual is also available as a PDF document. Click here to download it .

Screenshots

img-3 Example: A setup with a RSS feed jump list and some quick accessible tasks (shortcuts).

Administration

Installation and setup

Install the extension using Ext Manager .

On a SITE include Pinned Sites (pinned_sites) . This is done by going to Template → A page → Edit the whole template recordIncludes → Choose Pinned Sites (pinned_sites) under Include static (from extensions) .

How to setup the extension

To get the setup you want to have, then do the following to specify the precise setup:

Go to Template → A page → Choose Constant Editor → Under Category choose PLUGIN.PINNEDSITES .

Now you can define all the TypoScript configurations of the extension (see the section TypoScript configuration).

How to setup a folder with tasks / jump list items

The TypoScript property folderPidForTasks and folderPidForJumpList takes as parameters an int, which is expected to be and PID of a folder in TYPO3 containing shortcuts. A folder with such items can be setup as follows:

Go to Page .

Right click on a item and choose NewCreate a new page .

Change the type to: SysFolder

(For “folderPidForJumpList” the name of the folder will be the name of the custom jump list category.)

To add shortcuts to this folder (in other words: to add tasks/shortcuts to your jump list), do the following:

Right click on the folder and choose NewCreate a new page (inside) .

Change the type to: Shortcut or Link to external URL .

Give it a pagetitle . This will be the name of the item shown in the jump list.

The destination of the jump list item can be defined by either setting up Shortcut to page (for Shortcut)or URL (for Link to external URL).

If you want the jump list item to have another icon than the default chosen, then upload a ico file to the property Files of the shortcut.

The items of these jump list can be localized by using the standard TYPO3 localization of items/pages ( LocalizationCreate new page translation ). An example of this is shown on the image below.

img-4

How to localize the configuration

If you want to localize the configuration of this extension, e.g. say you want the Pinned Site to have an RSS feed in English as the jump list for your English site, and a RSS feed in Danish as the jump list for your Danish site, this can be done as follows:

Go to Template → A page → Choose Info/ModifyEdit the whole template record .

Under Constants you will see all the configurations you have done (starting with “plugin.tx_pinnedsites_pi.”)

To define the settings for another language, which for example have the id 2, enter: [globalVar = GP:L=2]

After this enter the settings your want for that language.

End it by entering the following: [global]

img-5 Example: Setup of a default language and a alternative language (here Danish and English)

FAQ:

I do not get any pinned sites on my pages, what do I do?

If you do not get any pinned sites on your pages and have included Pinned Sites (pinned_sites) in you template, it can be that something else is overriding it. Do the following to solve it:

Go to Template → A page → Choose Info/ModifyEdit the whole template record .

Under Setup enter (assuming the page object is called “page”): page.headerData.1296766713 < plugin.tx_pinnedsites_pi

Click Save document .

Configuration

TypoScript configuration

The following section will describe the different TypoScript constants that can be set. The default column is the values set by the TS template Pinned Sites (pinned_sites) .

“plugin.tx_pinnedsites_pi” have the following TypoScript properties.

General configuration
applicationName

Property

applicationName

Data type

string

Description

The name of the shortcut (Optional)

Default

msapplicationStarturl

Property

msapplicationStarturl

Data type

string

Description

The home page URL of the application (Optional)

Default

msapplicationTooltip

Property

msapplicationTooltip

Data type

string

Description

Optional text that is displayed as a tooltip when the mouse pointer hovers over the pinned site shortcut icon in the Windows Start menu or desktop. (Optional)

Default

msapplicationNavbuttonColor

Property

msapplicationNavbuttonColor

Data type

color

Description

The color of the Back and Forward buttons in the pinned site browser window (Optional)

Default

msapplicationWindowWidth

Property

msapplicationWindowWidth

Data type

int

Description

The initial width of the pinned site browser window (Optional)

Default

msapplicationWindowHeight

Property

msapplicationWindowHeight

Data type

int

Description

The initial height of the pinned site browser window (Optional)

Default

folderPidForJumpList

Property

folderPidForJumpList

Data type

int

Description

The PID for the folder containing a custom Jump List

Default

folderPidForTasks

Property

folderPidForTasks

Data type

int

Description

The PID for the folder containing the tasks. You can maximum have 5 tasks.

Default

rssForJumpList

Property

rssForJumpList

Data type

string

Description

An URL for a RSS feed to be used as a custom Jump List.

Default

whatToShowAsJumpList

Property

whatToShowAsJumpList

Data type

rss or folder

Description

Chooses between the RSS Feed jump list or folder jump list

Default

folder

cacheTime

Property

cacheTime

Data type

int

Description

The time to cache the content of plugin in seconds.

Default

defaultIcon

Property

defaultIcon

Data type

string

Description

An URL to an .ico file. This default icon is used, when no other icon for a jump list item is defined. If this is not defined the standard TYPO3 icon will be used.

Default

rssForJumpListItemsIcon

Property

rssForJumpListItemsIcon

Data type

string

Description

An URL to an .ico file. This icon will be used as icon for the RSS jump list items. If this is not defined, then the default icon will be used.

Default

rssForJumpListName

Property

rssForJumpListName

Data type

string

Description

Name of the jump list when using RSS. If this is not defined it will use the title found in the RSS Feed.

Default

rssForJumpListItemsCount

Property

rssForJumpListItemsCount

Data type

int

Description

The number of items shown in the RSS Feed Jump List. Maximum is 20.

Default

6