.. include:: /Includes.rst.txt

.. index:: ! TypoScript
.. _typoscript:

==========
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 :ref:`Constant Editor <t3tsref:constant-editor>`
in the backend to modify the values.

**Table of Contents:**

.. contents::
   :backlinks: top
   :class: compact-list
   :depth: 2
   :local:


Bootstrap Package: Basic Constants
==================================

The basic settings will provide easy to use and understandable options for that are used mainly for styling and appearance.


.. index:: TypoScript; page.logo

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 =
        }
    }


.. TODO: This property seems to be outdated. There is a second "page.meta"
   further down.

page.meta
---------

+-----------------------------------+---------------+-----------------------------------------------------------------------+
| Property                          | Data Type     |                                                                       |
+===================================+===============+=======================================================================+
| description                       | string        |                                                                       |
+-----------------------------------+---------------+-----------------------------------------------------------------------+
| author                            | string        |                                                                       |
+-----------------------------------+---------------+-----------------------------------------------------------------------+
| keywords                          | string        |                                                                       |
+-----------------------------------+---------------+-----------------------------------------------------------------------+


.. index:: TypoScript; page.theme

page.theme
----------

+-----------------------------------+---------------+-----------------------------------------------------------------------+
| Property                          | Data Type     |                                                                       |
+===================================+===============+=======================================================================+
| navigation.style                  | options       | **default** | inverse                                                 |
+-----------------------------------+---------------+-----------------------------------------------------------------------+
| navigation.type                   | options       | **0** | top | bottom                                                  |
+-----------------------------------+---------------+-----------------------------------------------------------------------+
| breadcrumb                        | boolean       | **1** | 0                                                             |
+-----------------------------------+---------------+-----------------------------------------------------------------------+
| breadcrumbEnableLevel             | integer+      | **2**                                                                 |
+-----------------------------------+---------------+-----------------------------------------------------------------------+


.. index:: TypoScript; page.theme.copyright

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                                         |
+-----------------------------------+---------------+-----------------------------------------------------------------------+


.. index:: TypoScript; page.theme.news

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                                                                     |
+-----------------------------------+---------------+-----------------------------------------------------------------------+


.. index:: TypoScript; page.theme.language

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.


.. index:: TypoScript; page.fluidtemplate

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/               |
+-----------------------------------+---------------+-----------------------------------------------------------------------+


.. index:: TypoScript; page.includePath

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/                    |
+-----------------------------------+---------------+-----------------------------------------------------------------------+


.. index:: TypoScript; page.meta

page.meta
---------

+-----------------------------------+---------------+-----------------------------------------------------------------------+
| Property                          | Data Type     |                                                                       |
+===================================+===============+=======================================================================+
| viewport                          | string        | width=device-width, initial-scale=1                                   |
+-----------------------------------+---------------+-----------------------------------------------------------------------+
| robots                            | string        | index,follow                                                          |
+-----------------------------------+---------------+-----------------------------------------------------------------------+
| mobile-web-app-capable            | string        | no                                                                    |
+-----------------------------------+---------------+-----------------------------------------------------------------------+
| compatible                        | string        | IE=edge,chrome=1                                                      |
+-----------------------------------+---------------+-----------------------------------------------------------------------+
| google                            | string        | notranslate                                                           |
+-----------------------------------+---------------+-----------------------------------------------------------------------+


.. index:: TypoScript; page.tracking.google

page.tracking.google
--------------------

+-----------------------------------+---------------+-----------------------------------------------------------------------+
| Property                          | Data Type     |                                                                       |
+===================================+===============+=======================================================================+
| trackingID                        | string        |                                                                       |
+-----------------------------------+---------------+-----------------------------------------------------------------------+
| anonymizeIp                       | boolean       | **1** | 0                                                             |
+-----------------------------------+---------------+-----------------------------------------------------------------------+


.. index:: TypoScript; config

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                                                             |
+-----------------------------------+---------------+-----------------------------------------------------------------------+
| headerComment                     | string        | Based on the TYPO3 Bootstrap Package                                  |
|                                   |               | by Benjamin Kott - http://www.bk2k.info                               |
+-----------------------------------+---------------+-----------------------------------------------------------------------+


.. index:: TypoScript; plugin.bootstrap_package.settings

plugin.bootstrap_package.settings
---------------------------------

+-----------------------------------+---------------+-----------------------------------------------------------------------+
| Property                          | Data Type     |                                                                       |
+===================================+===============+=======================================================================+
| overrideParserVariables           | boolean       | **1** | 0                                                             |
+-----------------------------------+---------------+-----------------------------------------------------------------------+
| cssSourceMapping                  | boolean       | 1 | **0**                                                             |
+-----------------------------------+---------------+-----------------------------------------------------------------------+


.. index:: TypoScript; plugin.bootstrap_package_contentelements.view

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/    |
+-----------------------------------+---------------+-----------------------------------------------------------------------+