TYPO3 v15 dev-main snapshot ()
This commit is contained in:
@@ -0,0 +1,83 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _include-default-typoscript:
|
||||
.. _using-the-rendering-definitions:
|
||||
|
||||
=======================
|
||||
Use TypoScript includes
|
||||
=======================
|
||||
|
||||
.. versionchanged:: 13.1
|
||||
If you included the :ref:`site sets <include-site-set>`, skip this step.
|
||||
|
||||
To use the default rendering definitions provided by *fluid_styled_content*, you
|
||||
have to add the extension's TypoScript set to your root TypoScript record.
|
||||
|
||||
When you are using a site package you can add the following lines to your site
|
||||
packages constants.typoscript and setup.typoscript:
|
||||
|
||||
.. code-block:: typoscript
|
||||
:caption: my_sitepackage/Configuration/TypoScript/constants.typoscript
|
||||
|
||||
# Import the default constants of EXT:fluid_styled_content
|
||||
@import 'EXT:fluid_styled_content/Configuration/TypoScript/constants.typoscript'
|
||||
|
||||
.. code-block:: typoscript
|
||||
:caption: my_sitepackage/Configuration/TypoScript/setup.typoscript
|
||||
|
||||
# Import the default setup of EXT:fluid_styled_content
|
||||
@import 'EXT:fluid_styled_content/Configuration/TypoScript/setup.typoscript'
|
||||
|
||||
# Import the default CSS of EXT:fluid_styled_content
|
||||
@import 'EXT:fluid_styled_content/Configuration/TypoScript/Styling/setup.typoscript'
|
||||
|
||||
This is the recommended way as the import of TypoScript can be kept under
|
||||
version control this way.
|
||||
|
||||
Alternative: Include the TypoScript set in the root TypoScript record
|
||||
=====================================================================
|
||||
|
||||
It is also still possible to include the TypoScript set directly into
|
||||
a TypoScript record. However there are draw backs:
|
||||
The import is then stored in the database and not the file system and cannot be
|
||||
kept under version control.
|
||||
|
||||
.. include:: /Images/AutomaticScreenshots/TypoScript/EditTemplateRecord.rst.txt
|
||||
|
||||
.. rst-class:: bignums-xxl
|
||||
|
||||
1. Go to the module :guilabel:`Sites > TypoScript`.
|
||||
|
||||
2. In the page tree, select the page which contains the root TypoScript
|
||||
record of your website.
|
||||
|
||||
3. Select :guilabel:`Edit TypoScript Record` in the dropdown at the top of the
|
||||
:guilabel:`Sites > TypoScript` module.
|
||||
|
||||
4. Click the :guilabel:`Edit the whole TypoScript record`. This will
|
||||
open all the settings of the root TypoScript record:
|
||||
|
||||
.. include:: /Images/AutomaticScreenshots/TypoScript/IncludeTypoScriptTemplate.rst.txt
|
||||
|
||||
Go to the tab :guilabel:`Includes` and select
|
||||
:guilabel:`Fluid Content Elements` in the
|
||||
:guilabel:`Available items` under :guilabel:`Include TypoScript sets`.
|
||||
The selection will move to the :guilabel:`Selected items`.
|
||||
|
||||
TYPO3 is now using the rendering definitions of *fluid_styled_content* for
|
||||
the default set of content elements. This is essentially unstyled HTML5 markup.
|
||||
|
||||
You can additionally select :guilabel:`Fluid Content Elements CSS (optional)`.
|
||||
This TypoScript set adds some CSS styling to make sure all
|
||||
the parts of a content elements have some styling, this will include alignment and positioning.
|
||||
This set of styles will not add any colors, make any changes to typography or anything else related to
|
||||
your website's visual style. This TypoScript set is optional, as it is common for integrators to
|
||||
override the basic styling.
|
||||
|
||||
Save the TypoScript record by using the save button at the top of the module.
|
||||
|
||||
Next step
|
||||
=========
|
||||
|
||||
:ref:`Display the content elements <inserting-content-page-template>` in your
|
||||
site package template.
|
||||
@@ -0,0 +1,75 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _inserting-content-page-template:
|
||||
|
||||
=======================================
|
||||
Inserting content in your page template
|
||||
=======================================
|
||||
|
||||
To get the different columns from the backend displayed in the frontend
|
||||
you can use predefined :ref:`CONTENT <t3tsref:cobj-content>` objects or
|
||||
the :ref:`DatabaseQueryProcessor <t3tsref:DatabaseQueryProcessor>`.
|
||||
|
||||
It is advised to make all your changes in a custom extension, visit the
|
||||
:doc:`site package documentation <t3sitepackage:Index>` to find out more.
|
||||
|
||||
.. _inserting-content-page-template-fluidtemplate:
|
||||
|
||||
Based on the FLUIDTEMPLATE content object (cObj)
|
||||
================================================
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
lib.dynamicContent = COA
|
||||
lib.dynamicContent {
|
||||
10 = LOAD_REGISTER
|
||||
10.colPos.cObject = TEXT
|
||||
10.colPos.cObject {
|
||||
field = colPos
|
||||
ifEmpty.cObject = TEXT
|
||||
ifEmpty.cObject {
|
||||
value.current = 1
|
||||
ifEmpty = 0
|
||||
}
|
||||
}
|
||||
20 = CONTENT
|
||||
20 {
|
||||
table = tt_content
|
||||
select {
|
||||
orderBy = sorting
|
||||
where = {#colPos}={register:colPos}
|
||||
where.insertData = 1
|
||||
}
|
||||
}
|
||||
90 = RESTORE_REGISTER
|
||||
}
|
||||
|
||||
page = PAGE
|
||||
page {
|
||||
10 = FLUIDTEMPLATE
|
||||
10 {
|
||||
templateName = Default
|
||||
templateRootPaths {
|
||||
0 = EXT:example_package/Resources/Private/Templates/Page/
|
||||
}
|
||||
partialRootPaths {
|
||||
0 = EXT:example_package/Resources/Private/Partials/Page/
|
||||
}
|
||||
layoutRootPaths {
|
||||
0 = EXT:example_package/Resources/Private/Layouts/Page/
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
.. code-block:: html
|
||||
|
||||
<f:layout name="Default" />
|
||||
<f:section name="Main">
|
||||
<f:cObject typoscriptObjectPath="lib.dynamicContent" data="{colPos: '0'}" />
|
||||
</f:section>
|
||||
|
||||
Next step
|
||||
=========
|
||||
|
||||
You can start :ref:`adding content elements <content-elements>` or make further
|
||||
:ref:`configurations <configuration>`.
|
||||
@@ -0,0 +1,18 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _first_steps:
|
||||
|
||||
===========
|
||||
First steps
|
||||
===========
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 5
|
||||
:titlesonly:
|
||||
:glob:
|
||||
|
||||
SiteSets
|
||||
DefaultTemplate
|
||||
DisplayContent
|
||||
|
||||
@@ -0,0 +1,65 @@
|
||||
:navigation-title: Site set inclusion
|
||||
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _include-site-set:
|
||||
|
||||
======================================
|
||||
Include one of the available site sets
|
||||
======================================
|
||||
|
||||
.. versionadded:: 13.1
|
||||
:ref:`Site sets <t3coreapi:site-sets>` have been introduced and are the recommended method to include
|
||||
TypoScript. If you do not want to use site sets, you can still use
|
||||
:ref:`TypoScript includes <include-default-typoscript>` to include the
|
||||
default TypoScript.
|
||||
|
||||
To use the default rendering definitions provided by *fluid_styled_content*, you
|
||||
should add one of the two :ref:`site sets <site-sets>` provided by this extension
|
||||
to your :ref:`site configuration <include-site-set-site>`
|
||||
or depend on it in your :ref:`site package's site set <include-site-set-sitepackage>`.
|
||||
|
||||
.. _include-site-set-site:
|
||||
|
||||
Add the site set to your site configuration
|
||||
===========================================
|
||||
|
||||
This is the recommended way to include the "Fluid Styled Content" site set into
|
||||
basic TYPO3 sites without a custom site package. See also
|
||||
:ref:`site sets <t3coreapi:site-sets>`.
|
||||
|
||||
.. figure:: /Images/ManualScreenshots/SiteSet.png
|
||||
|
||||
Add the site set of Fluid Styled Content
|
||||
|
||||
When saving, the GUI then automatically updates your site configuration:
|
||||
|
||||
.. literalinclude:: _site_config.diff
|
||||
:caption: config/sites/my-site/config.yaml (diff)
|
||||
|
||||
.. _include-site-set-sitepackage:
|
||||
|
||||
Add the site set to your custom site package
|
||||
============================================
|
||||
|
||||
If your installation has a custom :ref:`site package <t3sitepackage:start>`,
|
||||
it is recommended to depend on the "Fluid Styled Content CSS" site set with your
|
||||
site package's site set:
|
||||
|
||||
.. literalinclude:: _site_package_config.yaml
|
||||
:caption: EXT:my_site_package/Configuration/Sets/MySet/config.yaml
|
||||
|
||||
Edit the settings
|
||||
=================
|
||||
|
||||
.. _include-site-set-editor:
|
||||
|
||||
All settings of this extension are now available in the :ref:`settings-editor`.
|
||||
|
||||
.. _include-default-site-set-next:
|
||||
|
||||
Next step
|
||||
=========
|
||||
|
||||
:ref:`Display the content elements <inserting-content-page-template>` in your
|
||||
site package template.
|
||||
@@ -0,0 +1,6 @@
|
||||
base: https://example.ddev.site
|
||||
+ dependencies:
|
||||
+ - typo3/fluid-styled-content-css
|
||||
languages:
|
||||
-
|
||||
title: English
|
||||
@@ -0,0 +1,4 @@
|
||||
name: myvendor/my-site-package
|
||||
label: My sitepackage set
|
||||
dependencies:
|
||||
- typo3/fluid-styled-content-css
|
||||
Reference in New Issue
Block a user