first commit
This commit is contained in:
commit
e81864e683
2984 files changed
+267797
No files matched your search
@@ -0,0 +1,26 @@
|
||||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: ../Includes.txt
|
||||
|
||||
|
||||
.. _admin-manual:
|
||||
|
||||
Administrator manual
|
||||
====================
|
||||
|
||||
.. only:: html
|
||||
|
||||
This chapter describes how to manage the extension from a superuser point of view.
|
||||
|
||||
For a complete changelog please see the release notes on `GitHub <https://github.com/benjaminkott/bootstrap_package/releases/>`_.
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 5
|
||||
:titlesonly:
|
||||
|
||||
Migration/6-2-14
|
||||
Migration/6-2-11
|
||||
+330
@@ -0,0 +1,330 @@
|
||||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: ../../Includes.txt
|
||||
|
||||
|
||||
.. _migration_6.2.11:
|
||||
|
||||
=============================
|
||||
Upgrade from 6.2.10 to 6.2.11
|
||||
=============================
|
||||
|
||||
This document will only cover **breaking changes**, that could happen while
|
||||
overriding the Bootstrap Package.
|
||||
|
||||
|
||||
|
||||
|
||||
Support multilevel tree in subnavigation
|
||||
========================================
|
||||
|
||||
Frontend output of the submenu has changed and the 3rd level is now displayed
|
||||
by default. You will need to adapt this change if you are not using the theme
|
||||
that comes with the Bootstrap Package.
|
||||
|
||||
Before
|
||||
------
|
||||
|
||||
**Markup**
|
||||
|
||||
.. code-block:: html
|
||||
|
||||
<div class="hidden-print hidden-xs hidden-sm" role="complementary">
|
||||
<nav class="list-group">
|
||||
<a class="list-group-item active" href="#">Link 1</a>
|
||||
<a class="list-group-item active" href="#">Link 2</a>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
After
|
||||
------
|
||||
|
||||
**Markup**
|
||||
|
||||
.. code-block:: html
|
||||
|
||||
<nav class="hidden-print hidden-xs hidden-sm" role="complementary">
|
||||
<ul class="nav nav-sidebar">
|
||||
<li><a href="#">Link 1</a></li>
|
||||
<li class="active">
|
||||
<a href="#">Link 2</a>
|
||||
<ul>
|
||||
<li class="active"><a href="#">Link 2.1">Link 2.1</a></li>
|
||||
<li><a href="#">Link 2.2">Link 2.2</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
|
||||
|
||||
|
||||
Drop version number for jQuery in filename
|
||||
==========================================
|
||||
|
||||
Previously we appended the version number to the jQuery filename, this has lead
|
||||
to missing jQuery versions if files were moved outside the bootstrap_package.
|
||||
We are not removing the version number to prevent jQuery is missing, this makes
|
||||
it also more easy to maintain in the build process. Check your TypoScript setup
|
||||
for possible overrides.
|
||||
|
||||
Before
|
||||
------
|
||||
|
||||
**TypoScript Setup**
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
page.includeJSFooterLibs {
|
||||
jquery = {$page.includePath.javascript}Libs/jquery-x.xx.xx.min.js
|
||||
}
|
||||
|
||||
After
|
||||
------
|
||||
|
||||
**TypoScript Setup**
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
page.includeJSFooterLibs {
|
||||
jquery = {$page.includePath.javascript}Libs/jquery.min.js
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
Use default Bootstrap markup for navigation toggle
|
||||
==================================================
|
||||
|
||||
In previous builds Glyphicon icons were used to represent the toggle state of
|
||||
the main menu for smaller screen sizes. Also the toggle js was always loaded in
|
||||
within the main.js javascript file from the Bootstrap Package. This has lead to
|
||||
problems when the icon font was changed or the main javascript file was
|
||||
externally overriden.
|
||||
|
||||
Instead of adapting the custom markup to your theme the default bootstrap markup
|
||||
is now in use, so its working now also out of the box also if the custom theme
|
||||
from the Bootstrap Package is not included. The toggle state is now solved via
|
||||
a CSS class toggle and a bit of custom css in the Bootstrap Package theme. The
|
||||
JavaScript toggle functionality has been move into a single file so it can be
|
||||
easily turned of if you do not need it.
|
||||
|
||||
Before
|
||||
------
|
||||
|
||||
**Markup**
|
||||
|
||||
.. code-block:: html
|
||||
|
||||
<button class="navbar-toggle navbar-toggle-menu" type="button" data-toggle="collapse" data-target=".navbar-collapse">
|
||||
<span class="glyphicon glyphicon-list"></span>
|
||||
<span class="sr-only">Toggle navigation</span>
|
||||
</button>
|
||||
|
||||
After
|
||||
------
|
||||
|
||||
**Markup**
|
||||
|
||||
.. code-block:: html
|
||||
|
||||
<button class="navbar-toggle collapsed" type="button" data-toggle="collapse" data-target=".navbar-collapse">
|
||||
<span class="sr-only">Toggle navigation</span>
|
||||
<span class="icon-bar"></span>
|
||||
<span class="icon-bar"></span>
|
||||
<span class="icon-bar"></span>
|
||||
</button>
|
||||
|
||||
**TypoScript Setup**
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
page.includeJSFooterlibs {
|
||||
#### Toggle collapsed CSS class on the navbar toggle button
|
||||
bootstrap_navbartoggle = {$page.includePath.javascript}Libs/bootstrap.navbartoggle.min.js
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
Custom Lightbox JavaScript has been moved
|
||||
=========================================
|
||||
|
||||
In order to make the package more modular we removed the main.js file in favor
|
||||
of single files for each functionality so it can be added or removed more easily.
|
||||
|
||||
After
|
||||
------
|
||||
|
||||
**TypoScript Setup**
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
page.includeJSFooterlibs {
|
||||
#### Basic lightbox implementation for bootstrap
|
||||
bootstrap_lightbox = {$page.includePath.javascript}Libs/bootstrap.lightbox.min.js
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
LESS files have been moved private to public
|
||||
============================================
|
||||
|
||||
The resources folder in TYPO3 extensions is protected by default that made it
|
||||
impossible to make real usage of CSS SourceMaps. The files have been moved to
|
||||
Resources/Public, please ensure that your update your references to these files.
|
||||
|
||||
Before
|
||||
------
|
||||
|
||||
.. code-block:: html
|
||||
|
||||
EXT:bootstrap_package/Resources/Private/Less/
|
||||
|
||||
After
|
||||
------
|
||||
|
||||
.. code-block:: html
|
||||
|
||||
EXT:bootstrap_package/Resources/Public/Less/
|
||||
|
||||
|
||||
|
||||
|
||||
Corrected calculation of relative paths in build in LESS parser
|
||||
===============================================================
|
||||
|
||||
Calculation of relative paths in less should now be resolved correctly.
|
||||
The wired relative paths you have to set before will no longer be working and
|
||||
you need to set the constants now relative from the LESS file that is parsed.
|
||||
|
||||
Before
|
||||
------
|
||||
|
||||
**TypoScript Constants**
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
plugin.bootstrap_package {
|
||||
settings.less {
|
||||
icon-font-path = "../../../../../typo3conf/ext/bootstrap_package/Resources/Public/Fonts/"
|
||||
}
|
||||
}
|
||||
|
||||
After
|
||||
-----
|
||||
|
||||
**TypoScript Constants**
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
plugin.bootstrap_package {
|
||||
settings.less {
|
||||
icon-font-path = "../../Fonts/"
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
Template Fallbacks
|
||||
==================
|
||||
|
||||
We enabled fallbacks for page templates, so you can extend the package without
|
||||
the need to copy all the templates if you want to change parts of the templates.
|
||||
|
||||
Before
|
||||
------
|
||||
|
||||
**TypoScript Setup**
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
page.10 {
|
||||
file.stdWrap.cObject = CASE
|
||||
file.stdWrap.cObject {
|
||||
|
||||
key.data = levelfield:-1, backend_layout_next_level, slide
|
||||
key.override.field = backend_layout
|
||||
|
||||
bootstrap_package__default_clean = TEXT
|
||||
bootstrap_package__default_clean.value = {$page.fluidtemplate.templateRootPath}DefaultClean.html
|
||||
bootstrap_package__default_clean.insertData = 1
|
||||
|
||||
...
|
||||
|
||||
}
|
||||
partialRootPath = {$page.fluidtemplate.partialRootPath}
|
||||
layoutRootPath = {$page.fluidtemplate.layoutRootPath}
|
||||
}
|
||||
|
||||
After
|
||||
-----
|
||||
|
||||
**TypoScript Setup**
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
page.10 {
|
||||
templateName = TEXT
|
||||
templateName.stdWrap.cObject = CASE
|
||||
templateName.stdWrap.cObject {
|
||||
|
||||
key.data = levelfield:-1, backend_layout_next_level, slide
|
||||
key.override.field = backend_layout
|
||||
|
||||
bootstrap_package__default_clean = TEXT
|
||||
bootstrap_package__default_clean.value = DefaultClean
|
||||
|
||||
...
|
||||
|
||||
}
|
||||
templateRootPaths {
|
||||
0 = EXT:bootstrap_package/Resources/Private/Templates/Page/
|
||||
1 = {$page.fluidtemplate.templateRootPath}
|
||||
}
|
||||
partialRootPaths {
|
||||
0 = EXT:bootstrap_package/Resources/Private/Partials/Page/
|
||||
1 = {$page.fluidtemplate.partialRootPath}
|
||||
}
|
||||
layoutRootPaths {
|
||||
0 = EXT:bootstrap_package/Resources/Private/Layouts/Page/
|
||||
1 = {$page.fluidtemplate.layoutRootPath}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
Deprecated fallbacks
|
||||
====================
|
||||
|
||||
Fallbacks for deprecated backendlayout keys have been removed,
|
||||
use the alternatives instead.
|
||||
|
||||
**Removed Templates**
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
bootstrap_package__default_subnavigation
|
||||
bootstrap_package__default_subnavigation_2_columns
|
||||
|
||||
**Alternatives Templates**
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
bootstrap_package__default_subnavigation_right
|
||||
bootstrap_package__default_subnavigation_right_2_columns
|
||||
|
||||
|
||||
|
||||
|
||||
Support for EXT:THEMES removed
|
||||
==============================
|
||||
|
||||
Through lack of resources we removed the support for ext:themes.
|
||||
It is not planned to support ext:themes in the future again.
|
||||
+94
@@ -0,0 +1,94 @@
|
||||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: ../../Includes.txt
|
||||
|
||||
|
||||
.. _migration_6.2.14:
|
||||
|
||||
=============================
|
||||
Upgrade from 6.2.13 to 6.2.14
|
||||
=============================
|
||||
|
||||
This document will only cover **breaking changes**, that could happen while
|
||||
overriding the Bootstrap Package.
|
||||
|
||||
|
||||
|
||||
|
||||
Backend Layout Keys
|
||||
===================
|
||||
|
||||
Backend Layout configurations via PageTS have native support in TYPO3
|
||||
Versions >= 7.4. To make it more easy to upgrade new installations the prefix
|
||||
has been changed in the Bootstrap Package to match the new default that´s
|
||||
available in TYPO3 7.4 and newer versions.
|
||||
|
||||
The Prefix for Backend Layouts has been changed from "bootstrap_package" to
|
||||
"pagets". If you have been referring to these values before you need to adapt
|
||||
the new prefix for your own layouts in your TypoScript Configuration.
|
||||
|
||||
Please adapt to the new prefix and use the UpdateScript inside the
|
||||
Bootstrap Package extension from the extension manager. This will update all
|
||||
pages in the database and change the prefix from "bootstrap_package" to "pagets".
|
||||
|
||||
Note:
|
||||
The update script checks if an update is needed.
|
||||
If there is nothing to do the icon for the Update script will not be shown.
|
||||
|
||||
The new Provider in the TYPO3 Core is a port from the Bootstrap Package.
|
||||
That means that there is no need to do any further changes. The configuration
|
||||
stays exactly the same.
|
||||
|
||||
Before
|
||||
------
|
||||
|
||||
**Markup**
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
page = PAGE
|
||||
page {
|
||||
10 = FLUIDTEMPLATE
|
||||
10 {
|
||||
templateName = TEXT
|
||||
templateName.stdWrap.cObject = CASE
|
||||
templateName.stdWrap.cObject {
|
||||
...
|
||||
|
||||
bootstrap_package__default_clean = TEXT
|
||||
bootstrap_package__default_clean.value = DefaultClean
|
||||
|
||||
...
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
After
|
||||
------
|
||||
|
||||
**Markup**
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
page = PAGE
|
||||
page {
|
||||
10 = FLUIDTEMPLATE
|
||||
10 {
|
||||
templateName = TEXT
|
||||
templateName.stdWrap.cObject = CASE
|
||||
templateName.stdWrap.cObject {
|
||||
...
|
||||
|
||||
pagets__default_clean = TEXT
|
||||
pagets__default_clean.value = DefaultClean
|
||||
|
||||
...
|
||||
}
|
||||
}
|
||||
}
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: ../../Includes.txt
|
||||
|
||||
|
||||
=======================
|
||||
Extension Configuration
|
||||
=======================
|
||||
|
||||
Use the extension manager to adjust the Bootstrap Package to your needs.
|
||||
|
||||
|
||||
PageTsConfig
|
||||
============
|
||||
|
||||
The Bootstrap Package has a lot of PageTsConfig defaults.
|
||||
In some cases it can be useful to deactivate some of them if you do not need them.
|
||||
+291
@@ -0,0 +1,291 @@
|
||||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: ../../Includes.txt
|
||||
|
||||
|
||||
===============
|
||||
Image Rendering
|
||||
===============
|
||||
|
||||
Bootstrap Package comes with a very flexible responsive image rendering and
|
||||
supports multiple variants for various device sizes. Each variant defines the
|
||||
**break point**, **width** and the optional **sizes** for high resolution image
|
||||
support.
|
||||
|
||||
|
||||
|
||||
Image Variants
|
||||
==============
|
||||
|
||||
Image variants are used to represent the breakpoints of the design. These
|
||||
variants have to be defined according the definitions in the style sheet.
|
||||
Bootstrap Package defines these variants by default:
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
lib.contentElement.settings.responsiveimages.variants {
|
||||
default {
|
||||
breakpoint = 1200
|
||||
width = 1100
|
||||
}
|
||||
large {
|
||||
breakpoint = 992
|
||||
width = 920
|
||||
}
|
||||
medium {
|
||||
breakpoint = 768
|
||||
width = 680
|
||||
}
|
||||
small {
|
||||
breakpoint = 576
|
||||
width = 500
|
||||
}
|
||||
extrasmall {
|
||||
breakpoint = unset
|
||||
width = 374
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
The **breakpoint** defines the minimal device width where the **width** gets
|
||||
applied. Having a device with a width of 1200 pixels or more uses an image width
|
||||
of 1100 pixels, devices of 992 up to 1199 pixels width use an image width of
|
||||
920 pixels and so on.
|
||||
|
||||
|
||||
For each of these variants the multiplier of size **1x** is set to 1, see next
|
||||
section for more about the high-resolution image support:
|
||||
|
||||
* default
|
||||
|
||||
* breakpoint
|
||||
* width
|
||||
* sizes
|
||||
|
||||
* 1x
|
||||
|
||||
* multiplier: 1
|
||||
|
||||
|
||||
Example of changing the default configuration for the default variant.
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
lib.contentElement.settings.responsiveimages.variants {
|
||||
default {
|
||||
breakpoint = 1200
|
||||
width = 1100
|
||||
}
|
||||
|
||||
|
||||
High Resolution Images
|
||||
----------------------
|
||||
|
||||
There is a key called sizes in every variant that should be rendered. This
|
||||
dataset consists of several entries, each with a default key for a normal
|
||||
rendering (1x). This key will be added automatically, and it is always available.
|
||||
It is not possible to store sizes smaller than 1. Each size contains a
|
||||
multiplier, which is multiplied by the base size.
|
||||
|
||||
Example calculations:
|
||||
|
||||
Base width: 1000px
|
||||
|
||||
* Minimum Device Pixel Ratio = 1
|
||||
|
||||
* Multiplier = 1
|
||||
* Result: 1000px
|
||||
|
||||
* Minimum Device Pixel Ratio = 1.5
|
||||
|
||||
* Multiplier = 1.25
|
||||
* Result: 1250px
|
||||
|
||||
* Minimum Device Pixel Ratio = 2
|
||||
|
||||
* Multiplier = 1.5
|
||||
* Result: 1500px
|
||||
|
||||
|
||||
Example configuration to enable high-resolution support for the default variant
|
||||
for devices with a minimum device pixel ratio from 1.5 and 2.
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
lib.contentElement.settings.responsiveimages.variants {
|
||||
default {
|
||||
sizes {
|
||||
1\.5x {
|
||||
multiplier = 1.5
|
||||
}
|
||||
2x {
|
||||
multiplier = 2
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
The data for image rendering is now extended with a sub-set for high-resolution
|
||||
variants. If you did not overwrite the default templates, it will just work as
|
||||
soon as you add the configuration. If you have overwritten the default
|
||||
templates, it will still work as before, but you need to add the new support for
|
||||
high-resolution images yourself.
|
||||
|
||||
Please check the new updated templates and adjust your code if you want this
|
||||
support.
|
||||
|
||||
|
||||
Configuration by Variant
|
||||
------------------------
|
||||
|
||||
For each **variant** the following configuration options are possible:
|
||||
|
||||
* breakpoint
|
||||
* width
|
||||
* aspectRatio
|
||||
* sizes
|
||||
|
||||
|
||||
Configuration by Backend Layout
|
||||
-------------------------------
|
||||
|
||||
For each **backend layout** the following configuration options are possible
|
||||
for each defined **column** and **variant**:
|
||||
|
||||
* multiplier
|
||||
* gutters
|
||||
* corrections
|
||||
|
||||
|
||||
Example configuration for backend layouts.
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
lib.contentElement.settings.responsiveimages.backendlayout {
|
||||
my_layout { # this is the BE layout
|
||||
0 { # this is the column to be modified
|
||||
multiplier {
|
||||
default = 0.75
|
||||
large = 0.75
|
||||
}
|
||||
gutters {
|
||||
default = 40
|
||||
large = 40
|
||||
}
|
||||
corrections {
|
||||
default = 25
|
||||
large = 25
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Configuration by Content Element
|
||||
--------------------------------
|
||||
|
||||
For each **content element** the following configuration options are possible
|
||||
for each defined **variant** or **specific property**:
|
||||
|
||||
* multiplier
|
||||
* gutters
|
||||
* corrections
|
||||
|
||||
|
||||
Example configuration for content elements.
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
lib.contentElement.settings.responsiveimages.contentelements {
|
||||
my_content_element { # this is the content element
|
||||
my_custom_property { # this is a content element specific property, depends on the implementation and is optional
|
||||
multiplier {
|
||||
default = 0.5
|
||||
large = 0.5
|
||||
medium = 0.5
|
||||
}
|
||||
gutters {
|
||||
default = 24
|
||||
large = 24
|
||||
medium = 24
|
||||
}
|
||||
corrections {
|
||||
default = 25
|
||||
large = 25
|
||||
medium = 25
|
||||
small = 50
|
||||
extrasmall = 50
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Configuration options explained
|
||||
-------------------------------
|
||||
|
||||
Options for variants:
|
||||
|
||||
+---------------+-----------+-------------------------------------------------+
|
||||
| Property | Data Type | Description |
|
||||
+===============+===========+=================================================+
|
||||
| breakpoint | integer | Defines the minimal width in pixels of the |
|
||||
| | | device |
|
||||
+---------------+-----------+-------------------------------------------------+
|
||||
| width | integer | Defines the effective width in pixels for |
|
||||
| | | images for this variant |
|
||||
+---------------+-----------+-------------------------------------------------+
|
||||
| aspectRatio | float | Optional, defines the default aspect ratio |
|
||||
| | | which will override all previously defined |
|
||||
| | | ratios on image level |
|
||||
+---------------+-----------+-------------------------------------------------+
|
||||
| sizes | array | Optional, defines the available high resolution |
|
||||
| | | image multiplier for a minimal device pixel |
|
||||
| | | ratio per variant |
|
||||
+---------------+-----------+-------------------------------------------------+
|
||||
|
||||
|
||||
Options for backend layouts and content elements:
|
||||
|
||||
+---------------+-----------+-------------------------------------------------+
|
||||
| Property | Data Type | Description |
|
||||
+===============+===========+=================================================+
|
||||
| multiplier | integer | The width is multiplied with this value |
|
||||
+---------------+-----------+-------------------------------------------------+
|
||||
| gutters | integer | This value is added to the width before |
|
||||
| | | applying the multiplier and substracted |
|
||||
| | | afterwards |
|
||||
+---------------+-----------+-------------------------------------------------+
|
||||
| corrections | integer | This value is added as last step to the width |
|
||||
| | | after all other calculations |
|
||||
+---------------+-----------+-------------------------------------------------+
|
||||
|
||||
|
||||
The options **gutters** and **corrections** are needed if you want to be pixel
|
||||
perfect. Means if you have a 1 pixel outline for example and want this to be
|
||||
subtracted from the width you can do this kind of corrections late in the
|
||||
calculation process.
|
||||
|
||||
* Example `Accordion <https://github.com/benjaminkott/bootstrap_package/blob/master/Configuration/TypoScript/ContentElement/Element/Accordion.typoscript#L44>`__:
|
||||
Here a correction is added to remove the inner padding of the container.
|
||||
|
||||
* Example `Card Group <https://github.com/benjaminkott/bootstrap_package/blob/master/Configuration/TypoScript/ContentElement/Element/CardGroup.typoscript#L50>`__:
|
||||
The border is substracted here.
|
||||
|
||||
|
||||
|
||||
Crop Variants
|
||||
=============
|
||||
|
||||
The Bootstrap Package predefines some cropping variants which can easily be changed
|
||||
or extended by your sitepackage.
|
||||
|
||||
The following crop variants are defined by default:
|
||||
|
||||
* 16:9, for a fixed ratio
|
||||
* 4:3, for a fixed ratio
|
||||
* 1:1, for a fixed ratio
|
||||
* NaN, for a free ration
|
||||
@@ -0,0 +1,20 @@
|
||||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: ../Includes.txt
|
||||
|
||||
|
||||
==============================
|
||||
Configuration
|
||||
==============================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 5
|
||||
:titlesonly:
|
||||
:glob:
|
||||
|
||||
Extension/Index
|
||||
ImageRendering/Index
|
||||
TypoScript/Index
|
||||
+240
@@ -0,0 +1,240 @@
|
||||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: ../../Includes.txt
|
||||
|
||||
|
||||
==========
|
||||
TypoScript
|
||||
==========
|
||||
Bootstrap Package was built to be as adjustable as possible, so nothing is fixed and everything can be overridden with TypoScript constants.
|
||||
The constants are grouped in basic and advanced settings. Use the **TYPO3 Constant Editor** in the backend to modify the values.
|
||||
|
||||
|
||||
Bootstrap Package: Basic Constants
|
||||
==================================
|
||||
The basic settings will provide easy to use and understandable options for that are used mainly for styling and appearance.
|
||||
|
||||
|
||||
page.logo
|
||||
---------
|
||||
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| Property | Data Type | |
|
||||
+===================================+===============+=======================================================================+
|
||||
| file | string | EXT:bootstrap_package/Resources/Public/Images/BootstrapPackage.png |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| height | integer | 60 |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| width | integer | 210 |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| alt | string | |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
|
||||
**Example:**
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
page {
|
||||
logo {
|
||||
file = fileadmin/Theme/Logo.png
|
||||
height = 50
|
||||
width = 150
|
||||
alt =
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
page.meta
|
||||
---------
|
||||
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| Property | Data Type | |
|
||||
+===================================+===============+=======================================================================+
|
||||
| description | string | |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| author | string | |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| keywords | string | |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
|
||||
|
||||
page.theme
|
||||
----------
|
||||
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| Property | Data Type | |
|
||||
+===================================+===============+=======================================================================+
|
||||
| navigation.style | options | **default** | inverse |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| navigation.type | options | **0** | top | bottom |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| breadcrumb | boolean | **1** | 0 |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| breadcrumbEnableLevel | integer+ | **2** |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
|
||||
|
||||
page.theme.copyright
|
||||
--------------------
|
||||
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| Property | Data Type | |
|
||||
+===================================+===============+=======================================================================+
|
||||
| enable | boolean | **1** | 0 |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| text | string | Built on a Windows 8.1 Surface Pro. Running with TYPO3. |
|
||||
| | | Made with <3 by Benjamin Kott |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
|
||||
|
||||
page.theme.news
|
||||
---------------
|
||||
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| Property | Data Type | |
|
||||
+===================================+===============+=======================================================================+
|
||||
| list.header_position | options | **left** | center | right |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| list.header_layout | options | 1 | **2** | 3 | 4 | 5 |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| list.imageorient | options | 0 | 1 | 2 | 8 | 9 | 10 | 17 | 18 | **25** | 26 |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| list.imagecols | options | **1** | 2 | 3 | 4 | 5 | 6 |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| list.maxW | integer | 1140 |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| list.maxWInText | integer+ | |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| pagination.itemsperpage | integer | 5 |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
|
||||
|
||||
page.theme.language
|
||||
-------------------
|
||||
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| Property | Data Type | |
|
||||
+===================================+===============+=======================================================================+
|
||||
| enable | boolean | **1** | 0 |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| languageValue | string | **auto** | 0,1,2 |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
|
||||
|
||||
Bootstrap Package: Advanced Constants
|
||||
=====================================
|
||||
The advanced settings should be used only if you really know what you are doing.
|
||||
|
||||
|
||||
page.fluidtemplate
|
||||
------------------
|
||||
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| Property | Data Type | |
|
||||
+===================================+===============+=======================================================================+
|
||||
| layoutRootPath | string | EXT:bootstrap_package/Resources/Private/Layouts/Page/ |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| partialRootPath | string | EXT:bootstrap_package/Resources/Private/Partials/Page/ |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| templateRootPath | string | EXT:bootstrap_package/Resources/Private/Templates/Page/ |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
|
||||
|
||||
page.includePath
|
||||
----------------
|
||||
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| Property | Data Type | |
|
||||
+===================================+===============+=======================================================================+
|
||||
| css | string | EXT:bootstrap_package/Resources/Public/Css/ |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| icons | string | EXT:bootstrap_package/Resources/Public/Icons/ |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| javascript | string | EXT:bootstrap_package/Resources/Public/JavaScript/ |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
|
||||
|
||||
page.meta
|
||||
---------
|
||||
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| Property | Data Type | |
|
||||
+===================================+===============+=======================================================================+
|
||||
| viewport | string | width=device-width, initial-scale=1 |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| robots | string | index,follow |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| apple-mobile-web-app-capable | string | no |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| compatible | string | IE=edge,chrome=1 |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| google | string | notranslate |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
|
||||
|
||||
page.tracking.google
|
||||
--------------------
|
||||
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| Property | Data Type | |
|
||||
+===================================+===============+=======================================================================+
|
||||
| trackingID | string | |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| anonymizeIp | boolean | **1** | 0 |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
|
||||
|
||||
config
|
||||
------
|
||||
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| Property | Data Type | |
|
||||
+===================================+===============+=======================================================================+
|
||||
| no_cache | boolean | 1 | **0** |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| removeDefaultJS | options | **0** | 1 | external |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| compressJs | boolean | **1** | 0 |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| compressCss | boolean | **1** | 0 |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| concatenateJs | boolean | **1** | 0 |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| concatenateCss | boolean | **1** | 0 |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| admPanel | boolean | **1** | 0 |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| prefixLocalAnchors | options | EMPTY | **all** | cached | output |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| headerComment | string | Based on the TYPO3 Bootstrap Package |
|
||||
| | | by Benjamin Kott - http://www.bk2k.info |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
|
||||
|
||||
plugin.bootstrap_package.settings
|
||||
---------------------------------
|
||||
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| Property | Data Type | |
|
||||
+===================================+===============+=======================================================================+
|
||||
| overrideParserVariables | boolean | **1** | 0 |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| cssSourceMapping | boolean | 1 | **0** |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
|
||||
|
||||
plugin.bootstrap_package_contentelements.view
|
||||
---------------------------------------------
|
||||
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| Property | Data Type | |
|
||||
+===================================+===============+=======================================================================+
|
||||
| layoutRootPath | string | EXT:bootstrap_package/Resources/Private/Layouts/ContentElements/ |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| partialRootPath | string | EXT:bootstrap_package/Resources/Private/Partials/ContentElements/ |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
| templateRootPath | string | EXT:bootstrap_package/Resources/Private/Templates/ContentElements/ |
|
||||
+-----------------------------------+---------------+-----------------------------------------------------------------------+
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 130 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 56 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 90 KiB |
BIN
Binary file not shown.
|
After Width: | Height: | Size: 96 KiB |
@@ -0,0 +1,21 @@
|
||||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. This is 'Includes.txt'. It is included at the very top of each and
|
||||
every ReST source file in this documentation project (= manual).
|
||||
|
||||
|
||||
.. ==================================================
|
||||
.. DEFINE SOME TEXT ROLES
|
||||
.. --------------------------------------------------
|
||||
|
||||
.. role:: typoscript(code)
|
||||
|
||||
.. role:: ts(typoscript)
|
||||
:class: typoscript
|
||||
|
||||
.. role:: php(code)
|
||||
|
||||
.. highlight:: php
|
||||
@@ -0,0 +1,61 @@
|
||||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: Includes.txt
|
||||
|
||||
|
||||
.. _start:
|
||||
|
||||
=============================================================
|
||||
Bootstrap Package
|
||||
=============================================================
|
||||
|
||||
.. only:: html
|
||||
|
||||
:Classification:
|
||||
bootstrap_package
|
||||
|
||||
:Version:
|
||||
|release|
|
||||
|
||||
:Language:
|
||||
en
|
||||
|
||||
:Description:
|
||||
Bootstrap Package delivers a full configured frontend theme for TYPO3, based on the Bootstrap CSS Framework.
|
||||
|
||||
:Keywords:
|
||||
Theme, Bootstrap
|
||||
|
||||
:Copyright:
|
||||
2014
|
||||
|
||||
:Author:
|
||||
Benjamin Kott
|
||||
|
||||
:Email:
|
||||
info@bk2k.info
|
||||
|
||||
:License:
|
||||
This document is published under the Open Content License
|
||||
available from http://www.opencontent.org/opl.shtml
|
||||
|
||||
:Rendered:
|
||||
|today|
|
||||
|
||||
The content of this document is related to TYPO3,
|
||||
a GNU/GPL CMS/Framework available from `www.typo3.org <http://www.typo3.org/>`_.
|
||||
|
||||
|
||||
**Table of Contents**
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 5
|
||||
:titlesonly:
|
||||
:glob:
|
||||
|
||||
Introduction/Index
|
||||
Configuration/Index
|
||||
AdministratorManual/Index
|
||||
@@ -0,0 +1,58 @@
|
||||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: ../Includes.txt
|
||||
|
||||
|
||||
==============================
|
||||
Introduction
|
||||
==============================
|
||||
|
||||
Bootstrap Package is a theme for TYPO3 CMS based on the `Bootstrap CSS Framework <http://getbootstrap.com/>`_ Version 3.3.7
|
||||
|
||||
Features
|
||||
==============================
|
||||
|
||||
* Full configured TypoScript Setup provided as Static Template
|
||||
* Completely adjustable via TypoScript Constants
|
||||
* TYPO3 CMS rendering is adjusted to the needs of `Bootstrap CSS Framework <http://getbootstrap.com/>`_
|
||||
|
||||
* Layouts for all Content Elements
|
||||
* Section Frames
|
||||
|
||||
* Bootstrap specific Content Elements
|
||||
|
||||
* Accordion
|
||||
* External Media
|
||||
* Carousel
|
||||
* List Group
|
||||
* Tab
|
||||
* Text and Icon
|
||||
|
||||
* Individual Page Layouts
|
||||
* Built-in Less Parser
|
||||
|
||||
* All Variables are configurable via Constant Editor
|
||||
* Less support in page.includeCSS property
|
||||
|
||||
* Backend Layouts via PageTsConfig
|
||||
|
||||
|
||||
Screenshots
|
||||
==============================
|
||||
|
||||
.. figure:: ../Images/Screens/Desktop.jpg
|
||||
:width: 500px
|
||||
:alt: Desktop
|
||||
|
||||
.. figure:: ../Images/Screens/Tablet.jpg
|
||||
:width: 400px
|
||||
:alt: Tablet
|
||||
|
||||
.. figure:: ../Images/Screens/Mobile.jpg
|
||||
:width: 180px
|
||||
:alt: Mobile
|
||||
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
# coding: utf-8
|
||||
[general]
|
||||
project = Bootstrap Package
|
||||
version = 12.0.10
|
||||
release = 12.0.10
|
||||
copyright = since 2014 by Benjamin Kott
|
||||
|
||||
[html_theme_options]
|
||||
github_branch = BP_12-0
|
||||
github_repository = benjaminkott/bootstrap_package
|
||||
project_contact = info@bk2k.info
|
||||
project_discussions = https://typo3.slack.com/messages/bootstrap-package
|
||||
project_home = https://www.bootstrap-package.com
|
||||
project_issues = https://github.com/benjaminkott/bootstrap_package/issues
|
||||
project_repository = https://github.com/benjaminkott/bootstrap_package
|
||||
|
||||
[extlinks]
|
||||
issue = https://github.com/benjaminkott/bootstrap_package/issues/%s | Issue #
|
||||
Reference in new issue
Block a user