[TASK] Document carousel

linawolf · linawolf · commit d34ddba92637 · 2025-01-26T10:26:55.000+01:00
Releases: main, 13.4
diff --git a/Documentation/CodeSnippets/my_site_package/Configuration/Sets/SitePackage/page.tsconfig b/Documentation/CodeSnippets/my_site_package/Configuration/Sets/SitePackage/page.tsconfig
@@ -1,2 +1,3 @@
 @import './PageTsConfig/'
 @import './PageTsConfig/BackendLayouts/'
+
diff --git a/Documentation/CodeSnippets/my_site_package/ContentBlocks/ContentElements/carousel/templates/backend-preview.html b/Documentation/CodeSnippets/my_site_package/ContentBlocks/ContentElements/carousel/templates/backend-preview.html
@@ -9,9 +9,7 @@
     <div class="row">
         <f:for each="{data.carousel_items}" as="item" iteration="iteration">
             <div class="col">
-                <f:for each="{item.image}" as="image" iteration="iteration">
-                    <f:image image="{image}" width="100"/><br/>
-                </f:for>
+                <f:image image="{item.image}" width="100"/><br/>
                 {item.header}
             </div>
         </f:for>
diff --git a/Documentation/CodeSnippets/my_site_package/ContentBlocks/ContentElements/carousel/templates/frontend.html b/Documentation/CodeSnippets/my_site_package/ContentBlocks/ContentElements/carousel/templates/frontend.html
@@ -10,9 +10,7 @@
     <div class="carousel-inner">
         <f:for each="{data.carousel_items}" as="item" iteration="iteration">
             <div class="carousel-item{f:if(condition: '{iteration.isFirst}', then:' active')}">
-                <f:for each="{item.image}" as="image" iteration="iteration">
-                    <f:image image="{image}" class="d-block w-100"/>
-                </f:for>
+                <f:image image="{item.image}" class="d-block w-100"/>
                 <div class="carousel-caption d-none d-md-block">
                     <h5>{item.header}</h5>
                     <f:format.html>{item.description}</f:format.html>
diff --git a/Documentation/CodeSnippets/my_site_package/ContentBlocks/ContentElements/jumbotron/assets/icon.svg b/Documentation/CodeSnippets/my_site_package/ContentBlocks/ContentElements/jumbotron/assets/icon.svg
@@ -1 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" xml:space="preserve" viewBox="0 0 16 16"><path fill="#FFF" d="M1 1h14v14H1V1z"/><path fill="#999" d="M1 1v14h14V1H1zm1 1h12v12H2V2z"/><path fill="#666" d="M3 3h10v1H3V3z"/><path fill="#B9B9B9" d="M3 5h10v1H3V5z"/><path fill="#59F" d="M7 7h6v6H7V7z"/><path fill="#FFF" d="M11 12H8l.75-1 .75-1 .75 1 .75 1z"/><path fill="#FFF" d="M12 12H9.333l.667-.667.667-.666.666.666L12 12z"/><circle cx="11.5" cy="9.5" r=".5" fill="#FFF"/><path fill="#B9B9B9" d="M3 7h3v1H3V7zm0 2h3v1H3V9zm0 2h3v1H3v-1z"/></svg>
+<svg xmlns="http://www.w3.org/2000/svg" xml:space="preserve" viewBox="0 0 16 16"><path fill="#FFF" d="M1 1h14v14H1V1z"/><path fill="#999" d="M1 1v14h14V1H1zm1 1h12v12H2V2z"/><path fill="#666" d="M3 3h10v1H3V3z"/><path fill="#B9B9B9" d="M3 5h10v1H3V5z"/><path fill="#59F" d="M7 7h6v6H7V7z"/><path fill="#FFF" d="M11 12H8l.75-1 .75-1 .75 1 .75 1z"/><path fill="#FFF" d="M12 12H9.333l.667-.667.667-.666.666.666L12 12z"/><circle cx="11.5" cy="9.5" r=".5" fill="#FFF"/><path fill="#B9B9B9" d="M3 7h3v1H3V7zm0 2h3v1H3V9zm0 2h3v1H3v-1z"/></svg>
diff --git a/Documentation/CodeSnippets/my_site_package/Resources/Private/ContentElements/Layouts/.gitkeep b/Documentation/CodeSnippets/my_site_package/Resources/Private/ContentElements/Layouts/.gitkeep
@@ -0,0 +1 @@
+
diff --git a/Documentation/CodeSnippets/my_site_package/Resources/Private/Language/locallang.xlf b/Documentation/CodeSnippets/my_site_package/Resources/Private/Language/locallang.xlf
@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="utf-8" standalone="yes" ?>
 <xliff version="1.0">
-    <file source-language="en" datatype="plaintext" original="messages" date="2025-01-22UTC13:27:370">
+    <file source-language="en" datatype="plaintext" original="messages" date="2025-01-26UTC08:22:400">
         <header>
-            <authorName>J. Doe</authorName>
-            <authorEmail>j.doe@example.org</authorEmail>
+            <authorName>John Doe</authorName>
+            <authorEmail>j.doe@example.com</authorEmail>
         </header>
         <body>
         </body>
diff --git a/Documentation/CodeSnippets/my_site_package/Resources/Private/Language/locallang_be.xlf b/Documentation/CodeSnippets/my_site_package/Resources/Private/Language/locallang_be.xlf
@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="utf-8" standalone="yes" ?>
 <xliff version="1.0">
-    <file source-language="en" datatype="plaintext" original="messages" date="2025-01-22UTC13:27:370">
+    <file source-language="en" datatype="plaintext" original="messages" date="2025-01-26UTC08:22:400">
         <header>
-            <authorName>J. Doe</authorName>
-            <authorEmail>j.doe@example.org</authorEmail>
+            <authorName>John Doe</authorName>
+            <authorEmail>j.doe@example.com</authorEmail>
         </header>
         <body>
             <trans-unit id="backend_layout.default">
diff --git a/Documentation/CodeSnippets/my_site_package/Resources/Private/Language/locallang_db.xlf b/Documentation/CodeSnippets/my_site_package/Resources/Private/Language/locallang_db.xlf
@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="utf-8" standalone="yes" ?>
 <xliff version="1.0">
-    <file source-language="en" datatype="plaintext" original="messages" date="2025-01-22UTC13:27:370">
+    <file source-language="en" datatype="plaintext" original="messages" date="2025-01-26UTC08:22:400">
         <header>
-            <authorName>J. Doe</authorName>
-            <authorEmail>j.doe@example.org</authorEmail>
+            <authorName>John Doe</authorName>
+            <authorEmail>j.doe@example.com</authorEmail>
         </header>
         <body>
         </body>
diff --git a/Documentation/CodeSnippets/my_site_package/Resources/Public/Css/main.css b/Documentation/CodeSnippets/my_site_package/Resources/Public/Css/main.css
@@ -18,3 +18,4 @@
 .navbar-expand-lg .navbar-nav .nav-link:hover {
     border-bottom: 2px solid var(--bs-primary-bg-subtle);
 }
+
diff --git a/Documentation/CodeSnippets/my_site_package/Resources/Public/Fonts/.gitkeep b/Documentation/CodeSnippets/my_site_package/Resources/Public/Fonts/.gitkeep
@@ -0,0 +1 @@
+
diff --git a/Documentation/CodeSnippets/my_site_package/Resources/Public/Icons/Extension.svg b/Documentation/CodeSnippets/my_site_package/Resources/Public/Icons/Extension.svg
@@ -1 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64"><path fill="#FF8700" d="M0 0h64v64H0z"/><path fill="#FFF" d="M42.8 32.8c-3.6 0-8.1-10.1-8.1-15.1 0-2.3.9-2.7 3.2-2.7 5.5 0 11 .9 11 4-.1 6.2-4 13.8-6.1 13.8zM28.5 18.5c0 5 6.4 20.2 10.7 20.2.5 0 .9-.1 1.4-.2-3.8 6.1-8.4 10.6-11.2 10.6-5.9 0-14.3-17.9-14.3-25.7 0-1.2.3-2.2.7-2.8 2-2.5 8.4-4.4 13.7-5-.6.4-1 1-1 2.9z"/></svg>
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64"><path fill="#FF8700" d="M0 0h64v64H0z"/><path fill="#FFF" d="M42.8 32.8c-3.6 0-8.1-10.1-8.1-15.1 0-2.3.9-2.7 3.2-2.7 5.5 0 11 .9 11 4-.1 6.2-4 13.8-6.1 13.8zM28.5 18.5c0 5 6.4 20.2 10.7 20.2.5 0 .9-.1 1.4-.2-3.8 6.1-8.4 10.6-11.2 10.6-5.9 0-14.3-17.9-14.3-25.7 0-1.2.3-2.2.7-2.8 2-2.5 8.4-4.4 13.7-5-.6.4-1 1-1 2.9z"/></svg>
diff --git a/Documentation/CodeSnippets/my_site_package/Resources/Public/Images/logo.svg b/Documentation/CodeSnippets/my_site_package/Resources/Public/Images/logo.svg
@@ -1 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64"><path fill="#FF8700" d="M0 0h64v64H0z"/><path fill="#FFF" d="M42.8 32.8c-3.6 0-8.1-10.1-8.1-15.1 0-2.3.9-2.7 3.2-2.7 5.5 0 11 .9 11 4-.1 6.2-4 13.8-6.1 13.8zM28.5 18.5c0 5 6.4 20.2 10.7 20.2.5 0 .9-.1 1.4-.2-3.8 6.1-8.4 10.6-11.2 10.6-5.9 0-14.3-17.9-14.3-25.7 0-1.2.3-2.2.7-2.8 2-2.5 8.4-4.4 13.7-5-.6.4-1 1-1 2.9z"/></svg>
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64"><path fill="#FF8700" d="M0 0h64v64H0z"/><path fill="#FFF" d="M42.8 32.8c-3.6 0-8.1-10.1-8.1-15.1 0-2.3.9-2.7 3.2-2.7 5.5 0 11 .9 11 4-.1 6.2-4 13.8-6.1 13.8zM28.5 18.5c0 5 6.4 20.2 10.7 20.2.5 0 .9-.1 1.4-.2-3.8 6.1-8.4 10.6-11.2 10.6-5.9 0-14.3-17.9-14.3-25.7 0-1.2.3-2.2.7-2.8 2-2.5 8.4-4.4 13.7-5-.6.4-1 1-1 2.9z"/></svg>
diff --git a/Documentation/CodeSnippets/my_site_package/composer.json b/Documentation/CodeSnippets/my_site_package/composer.json
@@ -1,8 +1,8 @@
 {
     "name": "my-vendor/my-site-package",
     "type": "typo3-cms-extension",
-    "description": "Site package to follow the tutorial.",
-    "homepage": "https://docs.typo3.org/permalink/t3sitepackage:start",
+    "description": "",
+    "homepage": "https://example.com",
     "license": ["GPL-2.0-or-later"],
     "keywords": ["TYPO3 CMS"],
     "require": {
diff --git a/Documentation/CodeSnippets/my_site_package/ext_emconf.php b/Documentation/CodeSnippets/my_site_package/ext_emconf.php
@@ -2,7 +2,7 @@
 
 $EM_CONF[$_EXTKEY] = [
     'title' => 'My Site Package',
-    'description' => 'Site package to follow the tutorial.',
+    'description' => '',
     'category' => 'templates',
     'constraints' => [
         'depends' => [
@@ -22,8 +22,8 @@
     'uploadfolder' => 0,
     'createDirs' => '',
     'clearCacheOnLoad' => 1,
-    'author' => 'J. Doe',
-    'author_email' => 'j.doe@example.org',
+    'author' => 'John Doe',
+    'author_email' => 'j.doe@example.com',
     'author_company' => 'My Vendor',
     'version' => '1.0.0',
 ];
diff --git a/Documentation/ContentBlocks/Carousel.rst b/Documentation/ContentBlocks/Carousel.rst
@@ -12,6 +12,8 @@ This content block demonstrates some additional features of
 familiar with the concepts described in chapter
 `Custom Content Blocks <https://docs.typo3.org/permalink/t3sitepackage:content-blocks>`_.
 
+..  contents:: Table of contents
+
 ..  _carousel-directory:
 
 Directory structure of the carousel content element
@@ -63,16 +65,17 @@ Line 8: We use a field of type
 to contain the items to be displayed in the carousel. This field type expects
 an array of fields (line 10ff).
 
-Line 12: We use the type
+Line 15: We use the type
 `File <https://docs.typo3.org/permalink/friendsoftypo3/content-blocks:field-type-file>`_
-to reference the image for the carousel item.
+to reference the image for the carousel item. We allow images only (line 16)
+and require exactly one image (lines 17 and 18).
 
-Line 14: The title should be one line of text. We use the type
+Line 20: The title should be one line of text. We use the type
 `Text <https://docs.typo3.org/permalink/friendsoftypo3/content-blocks:field-type-text>`_.
 
-Line 16: The description may contain rich text. Therefore, we use the type
+Line 22: The description may contain rich text. Therefore, we use the type
 `Textarea <https://docs.typo3.org/permalink/friendsoftypo3/content-blocks:field-type-textarea>`_
-and enable the Rich-Text Editor (line 17).
+and enable the Rich-Text Editor (line 23).
 
 ..  _carousel-fluid:
 
diff --git a/Documentation/ContentBlocks/Index.rst b/Documentation/ContentBlocks/Index.rst
@@ -14,6 +14,8 @@ HTMl layout.
 This is because the stage does not contain normal content, as provided by
 Fluid-Styled Content, but a Jumbotron element or a slider.
 
+..  contents:: Table of contents
+
 ..  note::
     The extension :composer:`friendsoftypo3/content-blocks` is not an official
     part of the TYPO3 Core yet. It is also possible to
@@ -153,6 +155,17 @@ to format and sanitize the output.
 Line 5: We use the `Link.typolink ViewHelper <f:link.typolink> <https://docs.typo3.org/permalink/t3viewhelper:typo3-fluid-link-typolink>`_
 to render a link to the target that was defined in our custom field `button_link`.
 
+..  _content-blocks-carousel:
+
+The carousel Content Block
+==========================
+
+The carousel Content block is provided in the generated site package as an
+example on how to create a content block that contains on repeated items, here a
+carousel with multiple slides.
+
+It is described in chapter `Carousel Content Block example <https://docs.typo3.org/permalink/t3sitepackage:carousel>`_.
+
 ..  _content-blocks-next:
 
 Next steps

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`@import './PageTsConfig/'`
`2`	`2`	`@import './PageTsConfig/BackendLayouts/'`
	`3`	`+`
Original file line number	Diff line number	Diff line change
`@@ -18,3 +18,4 @@`
`18`	`18`	`.navbar-expand-lg .navbar-nav .nav-link:hover {`
`19`	`19`	`border-bottom: 2px solid var(--bs-primary-bg-subtle);`
`20`	`20`	`}`
	`21`	`+`