Skip to content

Commit

Permalink
[DOC] Updated documentation
Browse files Browse the repository at this point in the history
Refs #209
  • Loading branch information
derhansen committed Jan 29, 2020
1 parent 15d64cc commit bda3411
Show file tree
Hide file tree
Showing 9 changed files with 19 additions and 96 deletions.
6 changes: 6 additions & 0 deletions Documentation/Breakingchanges/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@
Breaking changes
----------------

Version 5.0.0
~~~~~~~~~~~~~

This version contains several breaking changes. Make sure to read the changelog, which also contains
important information about those changes: https://github.com/derhansen/sf_banners/releases/tag/5.0.0

Version 4.0.0
~~~~~~~~~~~~~

Expand Down
40 changes: 0 additions & 40 deletions Documentation/Configuration/ExtensionSettings/Index.rst

This file was deleted.

1 change: 0 additions & 1 deletion Documentation/Configuration/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,4 @@ Configuration

Reference/Index
Routing/Index
ExtensionSettings/Index

8 changes: 0 additions & 8 deletions Documentation/Faq/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,6 @@ at the top of all other JavaScript libraries.
If banners still do not get displayed and you use TYPO3 9.5 and the PageType Route Enhancer, make
sure that you configured a mapping - see :ref:`routing`

How to implement click tracking for Flash-banners?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The extension makes use the clicktag, which can be implemented in
flash-banners. More information about how to create a flash-banner
with a clicktag can be found at `http://www.flashclicktag.com/
<http://www.flashclicktag.com/>`_

Can I use my own templates?
^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down
7 changes: 3 additions & 4 deletions Documentation/Introduction/WhatDoesItDo/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,8 @@ What does it do?
^^^^^^^^^^^^^^^^

Banner-Management allows you to manage banners on your TYPO3 website.
It supports image, HTML and flash banners. Banner can be assigned
multiple categories which allows a flexible way of displaying them on
a TYPO3 website.
It supports image and HTML banners. Banner can be assigned multiple
categories which allows a flexible way of displaying them on a TYPO3 website.

The Extension fetches the banners for the desired page
**asynchronously** by using AJAX (jQuery), so the page load time is'nt
Expand All @@ -35,5 +34,5 @@ counted by using a clicktag.
The extension can be used as a plugin or by TypoScript.

The extension is developed with Extbase and Fluid and the current version
support TYPO3 8.7 LTS and TYPO3 9.5 LTS
support TYPO3 9.5 LTS and TYPO3 10.4 LTS

6 changes: 3 additions & 3 deletions Documentation/Settings.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@
[general]

project = Banner-Management
version = 4.0
release = 4.0.2
version = 5.0
release = 5.0.0
t3author = Torben Hansen
copyright = 2013 - 2019 by Torben Hansen
copyright = 2013 - 2020 by Torben Hansen

description = Official documentation for the TYPO3 Extension "Banner Management"

Expand Down
2 changes: 1 addition & 1 deletion Documentation/UsersManual/Installation/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,5 @@ following:
displaymode you want to use. Next select the desired startingpoint
(sysfolder created in step 3) and/or categories.

#. For TYPO3 9.5 LTS make sure to configure the mapping for the PageType Route Enhancer properly
#. For TYPO3 9.5+ LTS make sure to configure the mapping for the PageType Route Enhancer properly
(see :ref:`routing`), so the extension is able to fetch Banners and count Clicks.
2 changes: 1 addition & 1 deletion Documentation/UsersManual/Jquery/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ JavaScript libs that come from the extension.
To avoid any problems/conflicts, I recommend to include jQuery as shown below::

page.includeJSFooter {
bannerJQuery = //ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js
bannerJQuery = //ajax.googleapis.com/ajax/libs/jquery/3.4.1/jquery.min.js
bannerJQuery.external = 1
bannerJQuery.forceOnTop = 1
}
Expand Down
43 changes: 5 additions & 38 deletions Documentation/UsersManual/SettingsForBanners/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The title of the banner.
Type
""""

Image, HTML or Flash.
Image or HTML.


Language
Expand All @@ -44,13 +44,11 @@ Description
A description for the banner


Image
"""""
Assets
""""""

The image which is displayed by the plugin. Please note, that the
extension is not able to resize the banner, so you must upload it with
the final dimensions. *Only available, when the banner type is set to
“Image”.*
The asset (usually an image) which is displayed by the plugin. Please note, that the
extension is not able to resize the banner, so you must upload it with the final dimensions.


HTML
Expand All @@ -59,37 +57,6 @@ HTML
The HTML Code for the banner. *Only available, when the banner type is
set to* *“HTML”.*


Flash
"""""

The Flash-File for the banner. *Only available, when the banner type
is set to “Flash”.*


Width / height
""""""""""""""

The width and height of the Flash-File. *Only available, when the
banner type is set to “Flash”.*


Wmode
"""""

Flash wmode setting. If not set, the extensions default setting is
used (configured in the extensions constants). *Only available, when
the banner type is set to “Flash”.*


AllowScriptAccess
"""""""""""""""""

Flash allowScriptAccess setting. If not set, the extensions default
setting is used (configured in the extensions constants). *Only
available, when the banner type is set to “Flash”.*


Margintop, marginright, marginbottom and marginleft
"""""""""""""""""""""""""""""""""""""""""""""""""""

Expand Down

0 comments on commit bda3411

Please sign in to comment.