Overview ======== With this TYPO3 extension you can create responsive image maps in the backend. This extension ships an image editor that can be used to add areas and information to an image. ![Backend Editor](Documentation/Images/example_backend.png) Examples ======== Example 1: Default output ------------------------- Frontend output with configuration of example PageTS ![Example 1](https://bytebucket.org/blueways/bw_focuspoint_images/raw/master/Documentation/Images/example_frontend.jpg) Example 2: SVG Animation ------------------------ In this example the focus areas are animated via SVG. The additional information are displayed next to the image with some delay. ![Example 2](https://bytebucket.org/blueways/bw_focuspoint_images/raw/master/Documentation/Images/example_animation.gif) For administrators ================== ### Installation 1. Install via composer ``` {.bash} composer require blueways/bw-focuspoint-images ``` 2. Include TypoScript Enable the extension in the Extension Manager and include the **static TypoScript template** or manually include setup and constants. 3. Define your own wizard fields There are **no default fields** defined! An example with working frontend output can be found in the PageTS section. ### Usage Add the new content element "Image with Focuspoints" to any page, link a new image and start adding your focus areas. ![Backend view](https://bytebucket.org/blueways/bw_focuspoint_images/raw/master/Documentation/Images/backend-collage.jpg) ### Configuration #### PageTS To configure the fields in the focus point wizard, use the following **PageTS** settings. You can choose between **text**, **textarea**, **select** and **link** inputs in the wizard. This example configuration is used to generate the output shown in Example 1 ``` {.typoscript} mod.tx_bwfocuspointimages.settings.fields { name { title = LLL:EXT:bw_focuspoint_images/Resources/Private/Language/locallang_db.xlf:wizard.fields.name type = text } description { title = LLL:EXT:bw_focuspoint_images/Resources/Private/Language/locallang_db.xlf:wizard.fields.description type = textarea } color { title = LLL:EXT:bw_focuspoint_images/Resources/Private/Language/locallang_db.xlf:wizard.fields.color type = select options { red = LLL:EXT:bw_focuspoint_images/Resources/Private/Language/locallang_db.xlf:wizard.fields.color.red green = LLL:EXT:bw_focuspoint_images/Resources/Private/Language/locallang_db.xlf:wizard.fields.color.green blue = LLL:EXT:bw_focuspoint_images/Resources/Private/Language/locallang_db.xlf:wizard.fields.color.blue } } link { title = LLL:EXT:bw_focuspoint_images/Resources/Private/Language/locallang_db.xlf:wizard.fields.link type = link } } ``` ##### Adjusting the link wizard You can customize the display of the link wizard. Use the additional ```linkPopup``` to change the list of allowed file extensions, the displayed link fields or link options. The configuration is done like for [link inputs](https://docs.typo3.org/m/typo3/reference-tca/11.5/en-us/ColumnsConfig/Type/Input/Properties/LinkPopup.html#linkpopup). ``` {.typoscript} mod.tx_bwfocuspointimages.settings.fields { email { title = Hide all wizard tabs but email type = link linkPopup { blindLinkOptions = file, folder, page, spec, telephone, url } } pdf { title = Only files of .pdf or .docx extension type = link linkPopup { blindLinkFields = pdf, docx blindLinkOptions = email, folder, page, spec, telephone, url blindLinkFields = class, params, target, title } } } ``` #### Constants To override templates set your own paths via constants: ``` {.typoscript} plugin.tx_bwfocuspointimages { view { templateRootPath = partialRootPath = layoutRootPath = } } ``` To use the default rendering of **fluid\_styled\_content**, set Layout and Partial path to your `styles.content` setting and use the **Default** layout in your **FocuspointImage** template file. For developers ============== The table `sys_file_references` becomes extended for the field `focus_points`. This field is used to save the settings made in the backend editor in json format. To use the editor in other content elements with FAL images, use the following TCA to activate the palette: ``` {.php} $GLOBALS['TCA']['tt_content']['types']['your_list_type']['columnsOverrides'] = [ 'assets' => [ 'config' => [ 'overrideChildTca' => [ 'types' => [ \TYPO3\CMS\Core\Resource\File::FILETYPE_IMAGE => [ 'showitem' => 'focus_points,--palette--;;filePalette' ], ], 'columns' => [ 'uid_local' => [ 'config' => [ 'appearance' => [ 'elementBrowserAllowed' => $GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext'] ], ], ], ], ] ] ] ]; ``` This snippet assumes that references are done via `assets` column. Change this to your needs. To decode the JSON data and use the information in your template, use the `FocuspointProcessor`: ```typo3_typoscript tt_content.your_list_type { dataProcessing { 15 = Blueways\BwFocuspointImages\DataProcessing\FocuspointProcessor 15 { references.fieldName = assets as = image } } } ``` Upgrade ======= To version 4.x --------------- * TypoScript paths changed: * Old: `EXT:bw_focuspoint_images/Configuration/setup.txt` * New: `EXT:bw_focuspoint_images/Configuration/setup.typoscript` To version 3.x --------------- In version ```3.0.0``` the configuration of focuspoint fields has been moved to **PageTS** in order to make different settings possible in the page tree. Old TypoScript: ```plugin.tx_bwfocuspointimages.settings.fields..``` New PageTS: ```mod.tx_bwfocuspointimages.settings.fields..``` Just move your existing configuration to PageTS and adjust the prefix from ```plugin``` to ```mod```. Contribute ========== This extension was made by Maik Schneider: Feel free to contribute! * [Github-Repository](https://github.com/maikschneider/bw_focuspoint_images) Thanks to [blueways](https://www.blueways.de/) and [XIMA](https://www.xima.de/)!