TYPO3 v15 dev-main snapshot ()
This commit is contained in:
@@ -0,0 +1,46 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _constant-editor:
|
||||
|
||||
===============
|
||||
Constant Editor
|
||||
===============
|
||||
|
||||
.. versionchanged:: 13.1
|
||||
:ref:`Site sets <site-sets>` have been introduced. The
|
||||
:ref:`settings of the site set <site-set-fluid-styled-content-settings>`
|
||||
superseded using TypoScript constants. Using TypoScript constants is
|
||||
still possible for compatibility reasons.
|
||||
|
||||
.. tip::
|
||||
If :ref:`Site sets <t3coreapi:site-sets>` are used, the constant editor might be disabled. You can then edit
|
||||
the settings in the :ref:`settings-editor`.
|
||||
|
||||
.. include:: /Images/AutomaticScreenshots/TypoScript/ConstantEditor.rst.txt
|
||||
|
||||
.. rst-class:: bignums-xxl
|
||||
|
||||
1. The :guilabel:`Constant Editor` can be found in the
|
||||
:guilabel:`Sites > TypoScript` module.
|
||||
|
||||
2. Select the page in the page tree which contains the root Typoscript record
|
||||
of your website.
|
||||
|
||||
3. Select :guilabel:`Constant Editor` in the dropdown at the top of the
|
||||
:guilabel:`Sites > TypoScript` module.
|
||||
|
||||
4. In the dropdown list select the category :guilabel:`CONTENT`.
|
||||
|
||||
5. This will give you a list with all the constants of this extension.
|
||||
All constants are described and can be edited by clicking the pencil in
|
||||
front of the current value or by editing the available field.
|
||||
|
||||
6. Do not forget to save the new values. The new values will be stored in the
|
||||
"Constants" field of the root template of your website.
|
||||
|
||||
.. note::
|
||||
If you use the :guilabel:`Constant Editor` the configuration gets written
|
||||
to the database and cannot be kept under version control. You can cut all
|
||||
values from the constants field of the root TypoScript record and move them
|
||||
to a file in your site package extension. This way you can keep the values
|
||||
under version control.
|
||||
@@ -0,0 +1,30 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _configuration:
|
||||
|
||||
=============
|
||||
Configuration
|
||||
=============
|
||||
|
||||
Configuring content elements can be done for the frontend and the backend.
|
||||
|
||||
The appearance of the content elements can be changed by overriding the
|
||||
:ref:`default settings <site-set-fluid-styled-content-settings>` provided
|
||||
by the site set :ref:`"Fluid Styled Content" <site-set-fluid-styled-content>`.
|
||||
|
||||
You can also :ref:`override the Fluid
|
||||
templates <overriding-fluid-templates>` provided by this extension.
|
||||
|
||||
For the backend, fields can be shown or hidden, depending on the fields you are using or
|
||||
the fields an editor is allowed to use. Configuration like this is done using
|
||||
*Page TSconfig* or *User TSconfig*.
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
:glob:
|
||||
|
||||
Sets/Index
|
||||
SettingsEditor/Index
|
||||
ConstantEditor/Index
|
||||
TypoScript/Index
|
||||
OverridingFluidTemplates/Index
|
||||
@@ -0,0 +1,75 @@
|
||||
:navigation-title: Overriding templates
|
||||
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _overriding-fluid-templates:
|
||||
|
||||
==============================
|
||||
Overriding the Fluid templates
|
||||
==============================
|
||||
|
||||
At :ref:`typoscript` we have described the way content elements are rendered.
|
||||
|
||||
By default these settings are done in the :file:`setup.typoscript` file which can be found in the
|
||||
:file:`EXT:fluid_styled_content/Configuration/TypoScript/` folder.
|
||||
|
||||
.. _overriding-fluid-templates-using-site-sets:
|
||||
|
||||
Using the site settings
|
||||
=======================
|
||||
|
||||
.. versionadded:: 13.1
|
||||
You can now use :ref:`site settings <t3coreapi:sitehandling-settings>` to
|
||||
override the template paths.
|
||||
|
||||
In order to override the templates used in `fluid_styled_content` you need a
|
||||
custom :ref:`site package <t3sitepackage:start>`.
|
||||
|
||||
You can override the default template paths from the
|
||||
:ref:`site-set-fluid-styled-content` in your site configuration:
|
||||
|
||||
.. literalinclude:: _site-settings.yaml
|
||||
:caption: EXT:site_package/Configuration/Sets/SitePackage/settings.yaml
|
||||
|
||||
Now copy the Fluid templates that you want to override into your site package at
|
||||
the path configured in the site settings.
|
||||
|
||||
.. _overriding-fluid-templates-using-lib-fluidcontent:
|
||||
|
||||
Using lib.contentElement
|
||||
========================
|
||||
|
||||
.. versionchanged:: 13.1
|
||||
It is recommended to use
|
||||
:ref:`site settings <overriding-fluid-templates-using-site-sets>` instead of
|
||||
:typoscript:`lib.contentElement` to override the template paths.
|
||||
|
||||
This option gives you the ability to add another `templateRootPath` and can be defined
|
||||
the same as `partialRootPaths` and `layoutRootPaths`:
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
lib.contentElement {
|
||||
templateRootPaths {
|
||||
200 = EXT:your_extension_key/Resources/Private/Templates/
|
||||
}
|
||||
partialRootPaths {
|
||||
200 = EXT:your_extension_key/Resources/Private/Partials/
|
||||
}
|
||||
layoutRootPaths {
|
||||
200 = EXT:your_extension_key/Resources/Private/Layouts/
|
||||
}
|
||||
}
|
||||
|
||||
A content element is using a `templateName`, which is defined in :file:`setup.typoscript`. You
|
||||
can override this value, but the template from the extension *fluid_styled_content* will
|
||||
not be loaded as its name is still the default value.
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
tt_content {
|
||||
bullets {
|
||||
templateName = ChangedName
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
styles:
|
||||
templates:
|
||||
templateRootPath: EXT:my_site_package/Resources/Private/Extensions/FluidStyledContent/Templates/
|
||||
partialRootPath: EXT:my_site_package/Resources/Private/Extensions/FluidStyledContent/Partials/
|
||||
layoutRootPath: EXT:my_site_package/Resources/Private/Extensions/FluidStyledContent/Layouts/
|
||||
@@ -0,0 +1,38 @@
|
||||
:navigation-title: Fluid Styled Content
|
||||
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _site-set-fluid-styled-content:
|
||||
|
||||
===============================
|
||||
Site set "Fluid Styled Content"
|
||||
===============================
|
||||
|
||||
.. versionadded:: 13.1
|
||||
:ref:`Site sets <t3coreapi:site-sets>` have been added to the extension :composer:`typo3/cms-fluid-styled-content`.
|
||||
See :ref:`include-site-set` on how to use them.
|
||||
|
||||
The site set "Fluid Styled Content" includes all TypoScript required to
|
||||
display the :ref:`content elements <content-elements>` provided by
|
||||
:composer:`typo3/cms-fluid-styled-content`.
|
||||
|
||||
Some settings in these content elements like image positions or space settings
|
||||
require certain CSS styles. If you want to use the default CSS styles provided
|
||||
by TYPO3, include :ref:`site-set-fluid-styled-content-css` in addition to this
|
||||
site set.
|
||||
|
||||
If you depend on this site set directly instead of :ref:`site-set-fluid-styled-content-css`
|
||||
you should provide the missing CSS yourself or disable all `tt_content` fields
|
||||
via page TSconfig that lose their function due to missing CSS.
|
||||
|
||||
.. _site-set-fluid-styled-content-settings:
|
||||
|
||||
Settings provided by site set "Fluid Styled Content"
|
||||
====================================================
|
||||
|
||||
These settings can be adjusted in the :ref:`settings-editor`.
|
||||
|
||||
.. typo3:site-set-settings:: PROJECT:/Configuration/Sets/FluidStyledContent/settings.definitions.yaml
|
||||
:name: fluid-styled-content
|
||||
:type:
|
||||
:Label: Settings of "Fluid Styled Content"
|
||||
@@ -0,0 +1,25 @@
|
||||
:navigation-title: Fluid Styled Content CSS
|
||||
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _site-set-fluid-styled-content-css:
|
||||
|
||||
===================================
|
||||
Site set "Fluid Styled Content CSS"
|
||||
===================================
|
||||
|
||||
.. versionadded:: 13.1
|
||||
:ref:`Site sets <t3coreapi:site-sets>` have been added to the extension :composer:`typo3/cms-fluid-styled-content`.
|
||||
See :ref:`include-site-set` on how to use them.
|
||||
|
||||
This site set depends on the :ref:`site-set-fluid-styled-content`. Additionally it
|
||||
includes the :confval:`_CSS_DEFAULT_STYLE <t3tsref:plugin-css-default-style>`.
|
||||
|
||||
The styles provided by this site set enable the display of settings in content
|
||||
elements, including frame styles like `.frame-space-before-large`, styles
|
||||
for headlines like `.ce-headline-center` and styles for images like
|
||||
`.ce-intext.ce-left`.
|
||||
|
||||
If you do not depend on this site set you should provide the according CSS yourself
|
||||
or disable all fields in the TCA table that lose their function due to missing
|
||||
CSS styles.
|
||||
@@ -0,0 +1,41 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _site-sets:
|
||||
|
||||
=========
|
||||
Site sets
|
||||
=========
|
||||
|
||||
.. versionadded:: 13.1
|
||||
:ref:`Site sets <t3coreapi:site-sets>` have been added to the extension
|
||||
:composer:`typo3/cms-fluid-styled-content`.
|
||||
See :ref:`include-site-set` on how to use them.
|
||||
|
||||
The extension :composer:`typo3/cms-fluid-styled-content` offers two site sets
|
||||
that can be included via the Site module or required by your
|
||||
:ref:`site package's site set <t3sitepackage:site_set>`.
|
||||
|
||||
The settings provided by these sets can be adjusted in the :ref:`settings-editor`.
|
||||
|
||||
.. card-grid::
|
||||
:columns: 1
|
||||
:columns-md: 2
|
||||
:gap: 4
|
||||
:class: pb-4
|
||||
:card-height: 100
|
||||
|
||||
.. card:: :ref:`"Fluid Styled Content" <site-set-fluid-styled-content>`
|
||||
|
||||
The site set "Fluid Styled Content" includes all TypoScript required to
|
||||
display the content elements provided by `fluid_styled_content`.
|
||||
|
||||
.. card:: :ref:`"Fluid Styled Content CSS" <site-set-fluid-styled-content-css>`
|
||||
|
||||
This site set extends the :ref:`"Fluid Styled Content" <site-set-fluid-styled-content>`
|
||||
site set with default CSS.
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:hidden:
|
||||
|
||||
*
|
||||
@@ -0,0 +1,23 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _settings-editor:
|
||||
|
||||
===============
|
||||
Settings editor
|
||||
===============
|
||||
|
||||
When the :ref:`site sets of fluid_styled_content <include-site-set>` are included,
|
||||
the settings provided by those sets become available in the editor.
|
||||
|
||||
You can find the available site settings in module
|
||||
:guilabel:`Sites > Setup > Settings`
|
||||
|
||||
You can change individual settings here. If the site settings are writable
|
||||
you can hit the :guilabel:`Save` button and the settings will be written
|
||||
directly to the site settings.
|
||||
|
||||
If the settings are not writable you can click the :guilabel:`YAML export`
|
||||
button to export the settings. These can then be added by a developer with
|
||||
sufficient rights.
|
||||
|
||||
The available settings are also described in detail in :ref:`site-sets`.
|
||||
@@ -0,0 +1,96 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _typoscript:
|
||||
|
||||
==========
|
||||
TypoScript
|
||||
==========
|
||||
|
||||
At the section :ref:`include-site-set` you have already added the TypoScript by
|
||||
depending on the site set.
|
||||
|
||||
The TypoScript of the site set includes files located
|
||||
in the directory :file:`EXT:fluid_styled_content/Configuration/TypoScript/`.
|
||||
|
||||
.. figure:: /Images/ExternalScreenshots/TypoScriptFileStructure.png
|
||||
:alt: Structure of the TypoScript files
|
||||
|
||||
Structure of the TypoScript files
|
||||
|
||||
In this folder there are two files:
|
||||
|
||||
* :file:`constants.typoscript` - This file is only used when for compatibility
|
||||
reasons the TypoScript is included via import or `TypoScript` module in the
|
||||
outdated fashion.
|
||||
* :file:`setup.typoscript` - This file will first include some other files
|
||||
which are located in the :file:`Setup/` folder in the same directory. More
|
||||
about these files later.
|
||||
|
||||
In the folder :file:`ContentElement/` there are files which are included by the file
|
||||
:file:`setup.typoscript` as mentioned above. These files contain the rendering definitions of all
|
||||
content elements that are provided by the TYPO3 Core. These are:
|
||||
|
||||
- :file:`Bullets.typoscript` - Configuration for content element "Bullet List"
|
||||
|
||||
- :file:`Div.typoscript` - Configuration for content element "Divider"
|
||||
|
||||
- :file:`Header.typoscript` - Configuration for content element "Header Only"
|
||||
|
||||
- :file:`Html.typoscript` - Configuration for content element "Plain HTML"
|
||||
|
||||
- :file:`Image.typoscript` - Configuration for content element "Image"
|
||||
|
||||
- :file:`List.typoscript` - Configuration for content element "General Plugin"
|
||||
|
||||
- :file:`MenuAbstract.typoscript` - Configuration for content element "Menu of subpages of selected pages including abstracts"
|
||||
|
||||
- :file:`MenuCategorizedContent.typoscript` - Configuration for content element "Content elements for selected categories"
|
||||
|
||||
- :file:`MenuCategorizedPages.typoscript` - Configuration for content element "Pages for selected categories"
|
||||
|
||||
- :file:`MenuPages.typoscript` - Configuration for content element "Menu of selected pages"
|
||||
|
||||
- :file:`MenuRecentlyUpdated.typoscript` - Configuration for content element "Recently updated pages"
|
||||
|
||||
- :file:`MenuRelatedPages.typoscript` - Configuration for content element "Related pages (based on keywords)"
|
||||
|
||||
- :file:`MenuSection.typoscript` - Configuration for content element "Section index (page content marked for section menus)"
|
||||
|
||||
- :file:`MenuSectionPages.typoscript` - Configuration for content element "Menu of subpages of selected pages including sections"
|
||||
|
||||
- :file:`MenuSitemap.typoscript` - Configuration for content element "Sitemap"
|
||||
|
||||
- :file:`MenuSitemapPages.typoscript` - Configuration for content element "Sitemaps of selected pages"
|
||||
|
||||
- :file:`MenuSubpages.typoscript` - Configuration for content element "Menu of subpages of selected pages"
|
||||
|
||||
- :file:`Shortcut.typoscript` - Configuration for content element "Insert records"
|
||||
|
||||
- :file:`Table.typoscript` - Configuration for content element "Table"
|
||||
|
||||
- :file:`Text.typoscript` - Configuration for content element "Regular Text Element"
|
||||
|
||||
- :file:`Textmedia.typoscript` - Configuration for content element "Text and Media"
|
||||
|
||||
- :file:`Textpic.typoscript` - Configuration for content element "Text and Images"
|
||||
|
||||
- :file:`Uploads.typoscript` - Configuration for content element "File Links"
|
||||
|
||||
Since we move away from TypoScript as much as possible, these rendering
|
||||
definitions only declare the following:
|
||||
|
||||
- Can :ref:`FLUIDTEMPLATE <t3tsref:cobj-fluidtemplate>` be used immediately or
|
||||
do we need data processing first?
|
||||
|
||||
A processor is sometimes used to do some data manipulation before all the data is sent
|
||||
to the Fluid template.
|
||||
|
||||
- Assigning the Fluid template file for each type of content element separately.
|
||||
|
||||
In the folder :file:`Helper/` there are files which are included by the file
|
||||
:file:`setup.typoscript` as mentioned above. These are:
|
||||
|
||||
- :file:`ContentElement.typoscript` - Default configuration for content
|
||||
elements using :ref:`FLUIDTEMPLATE <t3tsref:cobj-fluidtemplate>`
|
||||
|
||||
- :file:`ParseFunc.typoscript` - Creates persistent ParseFunc setup for non-HTML content
|
||||
Reference in New Issue
Block a user