[TASK] Update Fluid Styled Content documentation 76/52276/2
authorBenjamin Kott <benjamin.kott@wfp2.com>
Thu, 30 Mar 2017 22:49:06 +0000 (00:49 +0200)
committerBenni Mack <benni@typo3.org>
Thu, 30 Mar 2017 23:56:48 +0000 (01:56 +0200)
Resolves: #80051
Releases: master
Change-Id: I00c992e8e44759c14f27b91ace19290f3b57294d
Reviewed-on: https://review.typo3.org/52276
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
Reviewed-by: Benni Mack <benni@typo3.org>
Tested-by: Benni Mack <benni@typo3.org>
12 files changed:
typo3/sysext/fluid_styled_content/Documentation/AddingYourOwnContentElements/Index.rst
typo3/sysext/fluid_styled_content/Documentation/Configuration/Index.rst
typo3/sysext/fluid_styled_content/Documentation/Configuration/OverridingFluidTemplates/Index.rst
typo3/sysext/fluid_styled_content/Documentation/Configuration/PageTs/Index.rst [deleted file]
typo3/sysext/fluid_styled_content/Documentation/Configuration/TypoScript/Images/FileStructure.png
typo3/sysext/fluid_styled_content/Documentation/Configuration/TypoScript/Index.rst
typo3/sysext/fluid_styled_content/Documentation/ContentElements/Menu/Images/BackendFieldsMenuAndSitemap.png
typo3/sysext/fluid_styled_content/Documentation/ContentElements/Menu/Index.rst
typo3/sysext/fluid_styled_content/Documentation/FrequentlyAskedQuestions/Index.rst [deleted file]
typo3/sysext/fluid_styled_content/Documentation/Index.rst
typo3/sysext/fluid_styled_content/Documentation/Installation/InsertingContentPageTemplate/Index.rst
typo3/sysext/fluid_styled_content/Documentation/Installation/Upgrading/Index.rst

index 0d63264..c6cadc3 100644 (file)
@@ -89,21 +89,31 @@ Then we configure the backend fields for our new content element:
       'showitem' => '
          --div--;LLL:EXT:core/Resources/Private/Language/Form/locallang_tabs.xlf:general,
             --palette--;LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:palette.general;general,
-            --palette--;LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:palette.header;header,
-        --div--;LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:tabs.appearance,
+            --palette--;LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:palette.headers;headers,
+            bodytext;LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:bodytext_formlabel,
+         --div--;LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:tabs.appearance,
             --palette--;LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:palette.frames;frames,
             --palette--;LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:palette.appearanceLinks;appearanceLinks,
-        --div--;LLL:EXT:core/Resources/Private/Language/Form/locallang_tabs.xlf:language,
+         --div--;LLL:EXT:core/Resources/Private/Language/Form/locallang_tabs.xlf:language,
             --palette--;;language,
-        --div--;LLL:EXT:core/Resources/Private/Language/Form/locallang_tabs.xlf:access,
+         --div--;LLL:EXT:core/Resources/Private/Language/Form/locallang_tabs.xlf:access,
             --palette--;;hidden,
             --palette--;LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:palette.access;access,
-        --div--;LLL:EXT:core/Resources/Private/Language/Form/locallang_tabs.xlf:categories,
+         --div--;LLL:EXT:core/Resources/Private/Language/Form/locallang_tabs.xlf:categories,
             categories,
-        --div--;LLL:EXT:core/Resources/Private/Language/Form/locallang_tabs.xlf:notes,
+         --div--;LLL:EXT:core/Resources/Private/Language/Form/locallang_tabs.xlf:notes,
             rowDescription,
-        --div--;LLL:EXT:core/Resources/Private/Language/Form/locallang_tabs.xlf:extended,
-   ');
+         --div--;LLL:EXT:core/Resources/Private/Language/Form/locallang_tabs.xlf:extended,
+      ',
+      'columnsOverrides' => [
+         'bodytext' => [
+            'config' => [
+               'enableRichtext' => true,
+               'richtextConfiguration' => 'default'
+            ]
+         ]
+      ]
+   );
 
 .. _AddingCE-TCA-Overrides-sys_template:
 
index 032d0a1..a6b39a4 100644 (file)
@@ -27,6 +27,5 @@ the fields an editor is allowed to use. Configuration like this is done using
 
    ConstantEditor/Index
    TypoScript/Index
-   PageTs/Index
    OverridingFluidTemplates/Index
 
index e11a6b6..bcba0df 100644 (file)
@@ -9,7 +9,7 @@ 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 :file:`setup.txt` which can be found in the
-folder :file:`EXT:fluid_styled_content/Configuration/TypoScript/Static/`.
+folder :file:`EXT:fluid_styled_content/Configuration/TypoScript/`.
 
 
 .. _overriding-fluid-templates-using-lib-fluidcontent:
@@ -42,7 +42,7 @@ not be loaded then, since its name is still the default value.
 
    tt_content {
       bullets {
-         templateName = ChangedName.html
+         templateName = ChangedName
       }
    }
 
diff --git a/typo3/sysext/fluid_styled_content/Documentation/Configuration/PageTs/Index.rst b/typo3/sysext/fluid_styled_content/Documentation/Configuration/PageTs/Index.rst
deleted file mode 100644 (file)
index 20c0224..0000000
+++ /dev/null
@@ -1,11 +0,0 @@
-.. include:: ../../Includes.txt
-
-.. _page-ts-config:
-
-=============
-Page TSconfig
-=============
-
-Page TSconfig can be found in the directory
-:file:`EXT:fluid_styled_content/Configuration/PageTS/Mod/Wizards/`. The file :file:`NewContentElement.txt`
-is included. It contains the configuration of the "New Content Element Wizard".
index 39d43b3..beb79eb 100644 (file)
Binary files a/typo3/sysext/fluid_styled_content/Documentation/Configuration/TypoScript/Images/FileStructure.png and b/typo3/sysext/fluid_styled_content/Documentation/Configuration/TypoScript/Images/FileStructure.png differ
index 8b9e83e..3a692d6 100644 (file)
@@ -8,7 +8,7 @@ TypoScript
 
 At the section :ref:`using-the-rendering-definitions` you've already added the static
 templates. Static templates are a collection of TypoScript files. These files are located
-in the directory :file:`EXT:fluid_styled_content/Configuration/TypoScript/Static/`.
+in the directory :file:`EXT:fluid_styled_content/Configuration/TypoScript/`.
 
 .. figure:: Images/FileStructure.png
    :alt: Structure of the TypoScript files
@@ -21,29 +21,75 @@ In this folder there are two files:
   described above, is using this file for its default settings.
 
 - :file:`setup.txt` - This file will first include some other files which are located in
-  the "Setup" folder in the same directory. More about these files later. Secondly the
-  rendering definitions of all the content elements, which belong to this extension, are
-  declared. Since we move away from TypoScript as much as possible, these rendering
-  definitions only declare the following:
+  the "Setup" folder in the same directory. More about these files later.
 
-  - Can 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.
+In the folder :file:`ContentElement` there are files which are included by the file
+:file:`setup.txt` as mentioned above. These files contain the rendering definitions of all
+content elements, that are provided by the TYPO3 core. These are:
 
-  - Assigning the Fluid template file for each type of content element separately.
+- :file:`Bullets.txt` - Configuration for Content Element "Bullet List"
 
-  - The configuration of the edit panel and the edit buttons for frontend editing. You
-    need to activate the extension "Frontend Editing (feedit)" in the Extension Manager to
-    see this in action.
+- :file:`Div.txt` - Configuration for Content Element "Divider"
 
-In the folder :file:`Helper` there are files which are included by the file
-:file:`setup.txt` as mentioned above. These are:
+- :file:`Header.txt` - Configuration for Content Element "Header Only"
 
-- :file:`ParseFunc.txt` - Creates persistent ParseFunc setup for non-HTML content
+- :file:`Html.txt` - Configuration for Content Element "Plain HTML"
+
+- :file:`Image.txt` - Configuration for Content Element "Image"
+
+- :file:`List.txt` - Configuration for Content Element "General Plugin"
+
+- :file:`MenuAbstract.txt` - Configuration for Content Element "Menu of subpages of selected pages including abstracts"
+
+- :file:`MenuCategorizedContent.txt` - Configuration for Content Element "Content elements for selected categories"
+
+- :file:`MenuCategorizedPages.txt` - Configuration for Content Element "Pages for selected categories"
+
+- :file:`MenuPages.txt` - Configuration for Content Element "Menu of selected pages"
+
+- :file:`MenuRecentlyUpdated.txt` - Configuration for Content Element "Recently updated pages"
+
+- :file:`MenuRelatedPages.txt` - Configuration for Content Element "Related pages (based on keywords)"
+
+- :file:`MenuSection.txt` - Configuration for Content Element "Section index (page content marked for section menus)"
+
+- :file:`MenuSectionPages.txt` - Configuration for Content Element "Menu of subpages of selected pages including sections"
+
+- :file:`MenuSitemap.txt` - Configuration for Content Element "Sitemap"
+
+- :file:`MenuSitemapPages.txt` - Configuration for Content Element "Sitemaps of selected pages"
 
-- :file:`StandardHeader.txt` - Copies the "Header only" content element into the `lib.stdheader`.
+- :file:`MenuSubpages.txt` - Configuration for Content Element "Menu of subpages of selected pages"
 
-- :file:`StylesContentGet.txt` - Defines `styles.content.get` as a `CONTENT` object for `colPos = 0`.
+- :file:`Shortcut.txt` - Configuration for Content Element "Insert records"
 
-- :file:`FluidContent.txt` - Default configuration for content elements using
+- :file:`Table.txt` - Configuration for Content Element "Table"
+
+- :file:`Text.txt` - Configuration for Content Element "Regular Text Element"
+
+- :file:`Textmedia.txt` - Configuration for Content Element "Text and Media"
+
+- :file:`Textpic.txt` - Configuration for Content Element "Text and Images"
+
+- :file:`Uploads.txt` - Configuration for Content Element "File Links"
+
+Since we move away from TypoScript as much as possible, these rendering
+definitions only declare the following:
+
+- Can 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.
+
+- The configuration of the edit panel and the edit buttons for frontend editing. You
+  need to activate the extension "Frontend Editing (feedit)" in the Extension Manager to
+  see this in action.
+
+In the folder :file:`Helper` there are files which are included by the file
+:file:`setup.txt` as mentioned above. These are:
+
+- :file:`ContentElement.txt` - Default configuration for content elements using
   FLUIDTEMPLATE
+
+- :file:`ParseFunc.txt` - Creates persistent ParseFunc setup for non-HTML content
index 72ca07b..22eb7a0 100644 (file)
Binary files a/typo3/sysext/fluid_styled_content/Documentation/ContentElements/Menu/Images/BackendFieldsMenuAndSitemap.png and b/typo3/sysext/fluid_styled_content/Documentation/ContentElements/Menu/Images/BackendFieldsMenuAndSitemap.png differ
index 0635824..712ae67 100644 (file)
@@ -2,15 +2,15 @@
 
 .. _content-element-menu:
 
-=============
-Special menus
-=============
+=====
+Menus
+=====
 
 In websites menus are often created outside the content element scope, because they have
 to reappear within every page. These could be the main menu, a sub menu, a bread crumb or
 a language menu. However, there are situations where you would like to create a menu
-specifically on one page. This content element will give you some options to render a
-menu. These options are:
+specifically on one page. The following content elements will give you some options to render
+a menu. These available content elements are:
 
 Menu of selected pages
    The menu consists of links to the selected pages in the TYPO3 CMS backend.
diff --git a/typo3/sysext/fluid_styled_content/Documentation/FrequentlyAskedQuestions/Index.rst b/typo3/sysext/fluid_styled_content/Documentation/FrequentlyAskedQuestions/Index.rst
deleted file mode 100644 (file)
index 20e6763..0000000
+++ /dev/null
@@ -1,26 +0,0 @@
-.. include:: ../Includes.txt
-
-.. _frequently-asked-questions:
-
-==========================
-Frequently Asked Questions
-==========================
-
-- **Q**: I don't see all the backend fields I can use for the configuration of a content
-  element.
-
-  **A**: Compared to *css_styled_content*, there is a difference
-  in the availability of fields, but also in the ordering and placement in tabs. We have
-  removed some fields which are not suitable for an editor or should be handled by by CSS.
-
-- **Q**: The "New Content Element" Wizards does not show the general content elements.
-
-  **A**: The PageTsconfig of "fluid_styled_config" needs to be loaded on the page to make
-  the content elements appear in the wizard. You can include it globally by checking
-  the designated checkbox in the extension configuration. See :ref:`extension-manager` for
-  more information.
-
-  If you want to include it only in a specific page tree open the page properties of the
-  topmost page in the tree and head to the "Resources" tab. Here you find the field
-  **Include Page TSConfig (from extensions):** where you can add the prepared PageTSconfig
-  "Fluid-based Content Elements (fluid_styled_content)"
index d522c3c..399806a 100644 (file)
@@ -55,5 +55,4 @@ a GNU/GPL CMS/Framework available from http://typo3.org
    Configuration/Index
    ContentElements/Index
    AddingYourOwnContentElements/Index
-   FrequentlyAskedQuestions/Index
    Targets
index 5cfdcf4..1f346ef 100644 (file)
@@ -45,25 +45,57 @@ 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 {
-         file = your/html/template.html
-         variables {
-            content = CONTENT
-            content {
-               table = tt_content
-               select {
-                  orderBy = sorting
-                  where = {#colPos}=0
-                  languageField = sys_language_uid
-               }
-            }
+         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>
+
+
 .. seealso::
 
    See the note about the removal of the predefined CONTENT objects like
index a6f9af4..6f3fade 100644 (file)
@@ -7,18 +7,13 @@ Upgrading
 =========
 
 If you upgrade your TYPO3 CMS installation from one major version to another (for example
-6.2 to 7.6), it is advised to run the Upgrade Wizards. They guide you through the
+7.6 to 8.7), it is advised to run the Upgrade Wizards. They guide you through the
 necessary steps to upgrade your database records or explicitly install extensions that
 ship with the latest TYPO3 CMS version.
 
-Coming from an older version it might be that the basic content elements, provided by
-the core of TYPO3 CMS were rendered by the extension "CSS Styled Content
-(css_styled_content)". Some changes have been made since moving the rendering to the
-extension "fluid_styled_content". Some database fields of the table tt_content are no longer
-used, the fields of FlexForms have been moved to proper database fields and the content
-elements "Text" and "Text & Images" have been merged into a new content element "textmedia".
-To make sure you do not lose any information or the content elements look differently on
-your upgraded website run these Upgrade Wizards.
+Some database fields of the table tt_content are no longer used, the fields of FlexForms
+have been moved to proper database fields. To make sure you do not lose any information
+or the content elements look differently on your upgraded website run these Upgrade Wizards.
 
 The upgrade wizards can be found in the Install tool.