From 7db008b8d502c6fd6dbfc938cd7882b205881b3d Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Wed, 15 May 2024 20:45:14 +0200 Subject: [PATCH] [FEATURE] Introduce site sets in the configuration chapter (#158) * Regenerate code snippets * Other places still need to be changed but trying to keep PRs as small as initially possible releases: main --- .ddev/config.yaml | 2 +- .../ComposerJson.rst.txt | 10 +- .../SitePackage-config.rst.txt | 13 ++ .../SitePackage-constants.rst.txt | 14 +++ .../SitePackage-page-tsconfig.rst.txt | 8 ++ .../SitePackage-settings.rst.txt | 20 +++ .../SitePackage-setup.rst.txt | 8 ++ .../TcaOverridePages.rst.txt | 25 ---- .../TcaOverrideSysTemplate.rst.txt | 26 ---- .../CodeSnippets/Fluid/Layout.rst.txt | 5 +- .../Fluid/PartialJumbotron.rst.txt | 4 +- .../CodeSnippets/Fluid/Step1Default.rst.txt | 7 +- .../CodeSnippets/Fluid/Step2Default.rst.txt | 7 +- .../CodeSnippets/Fluid/Step3Default.rst.txt | 7 +- .../Fluid/TemplateDefault.rst.txt | 14 +-- .../Fluid/TemplateTwoColumns.rst.txt | 12 +- .../CodeSnippets/TypoScript/Constants.rst.txt | 8 +- .../CodeSnippets/TypoScript/Page.rst.txt | 4 +- .../Part1FluidTemplateSection.rst.txt | 12 +- .../TypoScript/Part2CssFileInclusion.rst.txt | 7 +- .../Part4GlobalConfiguration.rst.txt | 6 +- .../TypoScript/Part5MenuProcessor.rst.txt | 6 +- .../TypoScript/Part6ProcessedContent.rst.txt | 5 +- .../CodeSnippets/TypoScript/Setup.rst.txt | 9 +- Documentation/CodeSnippets/codesnippets.php | 69 +++++++---- Documentation/ContentMapping/Index.rst | 14 ++- Documentation/CreatePages/Index.rst | 5 - .../ExtensionConfiguration/Index.rst | 116 ++++++++++++------ composer.json | 69 ++++++----- 29 files changed, 287 insertions(+), 225 deletions(-) create mode 100644 Documentation/CodeSnippets/ExtensionConfiguration/SitePackage-config.rst.txt create mode 100644 Documentation/CodeSnippets/ExtensionConfiguration/SitePackage-constants.rst.txt create mode 100644 Documentation/CodeSnippets/ExtensionConfiguration/SitePackage-page-tsconfig.rst.txt create mode 100644 Documentation/CodeSnippets/ExtensionConfiguration/SitePackage-settings.rst.txt create mode 100644 Documentation/CodeSnippets/ExtensionConfiguration/SitePackage-setup.rst.txt delete mode 100644 Documentation/CodeSnippets/ExtensionConfiguration/TcaOverridePages.rst.txt delete mode 100644 Documentation/CodeSnippets/ExtensionConfiguration/TcaOverrideSysTemplate.rst.txt diff --git a/.ddev/config.yaml b/.ddev/config.yaml index bb387ad..f59e14e 100644 --- a/.ddev/config.yaml +++ b/.ddev/config.yaml @@ -1,7 +1,7 @@ name: tutorial-sitepackage type: php docroot: "" -php_version: "8.1" +php_version: "8.2" webserver_type: nginx-fpm router_http_port: "8081" router_https_port: "4434" diff --git a/Documentation/CodeSnippets/ExtensionConfiguration/ComposerJson.rst.txt b/Documentation/CodeSnippets/ExtensionConfiguration/ComposerJson.rst.txt index e41bd31..a5a7606 100644 --- a/Documentation/CodeSnippets/ExtensionConfiguration/ComposerJson.rst.txt +++ b/Documentation/CodeSnippets/ExtensionConfiguration/ComposerJson.rst.txt @@ -1,5 +1,5 @@ -.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets -.. Extracted from typo3conf/ext/site_package/composer.json +.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets +.. Extracted from EXT:site_package/composer.json .. code-block:: json :caption: EXT:site_package/composer.json @@ -22,8 +22,8 @@ } ], "require": { - "typo3/cms-core": "^12.0.0|dev-main", - "typo3/cms-fluid-styled-content": "^12.0.0|dev-main" + "typo3/cms-core": "^13.1.0|dev-main", + "typo3/cms-fluid-styled-content": "^13.1.0|dev-main" }, "homepage": "https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-SitePackage-Code", "license": "MIT", @@ -45,7 +45,7 @@ "extension-key": "site_package" }, "branch-alias": { - "dev-master": "12.0.x-dev" + "dev-master": "13.0.x-dev" } } } diff --git a/Documentation/CodeSnippets/ExtensionConfiguration/SitePackage-config.rst.txt b/Documentation/CodeSnippets/ExtensionConfiguration/SitePackage-config.rst.txt new file mode 100644 index 0000000..8f50806 --- /dev/null +++ b/Documentation/CodeSnippets/ExtensionConfiguration/SitePackage-config.rst.txt @@ -0,0 +1,13 @@ +.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets +.. Extracted from EXT:site_package/Configuration/Sets/SitePackage/config.yaml + +.. code-block:: yaml + :caption: EXT:site_package/Configuration/Sets/SitePackage/config.yaml + :linenos: + + name: t3docs/site-package + label: Example site package set + dependencies: + - typo3/fluid-styled-content + - typo3/fluid-styled-content-css + \ No newline at end of file diff --git a/Documentation/CodeSnippets/ExtensionConfiguration/SitePackage-constants.rst.txt b/Documentation/CodeSnippets/ExtensionConfiguration/SitePackage-constants.rst.txt new file mode 100644 index 0000000..6d9ee47 --- /dev/null +++ b/Documentation/CodeSnippets/ExtensionConfiguration/SitePackage-constants.rst.txt @@ -0,0 +1,14 @@ +.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets +.. Extracted from EXT:site_package/Configuration/Sets/SitePackage/constants.typoscript + +.. code-block:: typoscript + :caption: EXT:site_package/Configuration/Sets/SitePackage/constants.typoscript + + page { + fluidtemplate { + layoutRootPath = EXT:site_package/Resources/Private/Layouts/Page/ + partialRootPath = EXT:site_package/Resources/Private/Partials/Page/ + templateRootPath = EXT:site_package/Resources/Private/Templates/Page/ + } + } + \ No newline at end of file diff --git a/Documentation/CodeSnippets/ExtensionConfiguration/SitePackage-page-tsconfig.rst.txt b/Documentation/CodeSnippets/ExtensionConfiguration/SitePackage-page-tsconfig.rst.txt new file mode 100644 index 0000000..ea28469 --- /dev/null +++ b/Documentation/CodeSnippets/ExtensionConfiguration/SitePackage-page-tsconfig.rst.txt @@ -0,0 +1,8 @@ +.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets +.. Extracted from EXT:site_package/Configuration/Sets/SitePackage/page.tsconfig + +.. code-block:: typoscript + :caption: EXT:site_package/Configuration/Sets/SitePackage/page.tsconfig + + @import 'EXT:site_package/Configuration/TsConfig/Page/PageLayout/*.tsconfig' + \ No newline at end of file diff --git a/Documentation/CodeSnippets/ExtensionConfiguration/SitePackage-settings.rst.txt b/Documentation/CodeSnippets/ExtensionConfiguration/SitePackage-settings.rst.txt new file mode 100644 index 0000000..6f967e5 --- /dev/null +++ b/Documentation/CodeSnippets/ExtensionConfiguration/SitePackage-settings.rst.txt @@ -0,0 +1,20 @@ +.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets +.. Extracted from EXT:site_package/Configuration/Sets/SitePackage/settings.yaml + +.. code-block:: yaml + :caption: EXT:site_package/Configuration/Sets/SitePackage/settings.yaml + :linenos: + + styles: + templates: + layoutRootPath: EXT:site_package/Resources/Private/Layouts/ContentElements + partialRootPath: EXT:site_package/Resources/Private/Partials/ContentElements + templateRootPath: EXT:site_package/Resources/Private/Templates/ContentElements + content: + textmedia: + maxW: 1200 + maxWInText: 600 + linkWrap: + lightboxEnabled: true + lightboxCssClass: lightbox + \ No newline at end of file diff --git a/Documentation/CodeSnippets/ExtensionConfiguration/SitePackage-setup.rst.txt b/Documentation/CodeSnippets/ExtensionConfiguration/SitePackage-setup.rst.txt new file mode 100644 index 0000000..9d90aae --- /dev/null +++ b/Documentation/CodeSnippets/ExtensionConfiguration/SitePackage-setup.rst.txt @@ -0,0 +1,8 @@ +.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets +.. Extracted from EXT:site_package/Configuration/Sets/SitePackage/setup.typoscript + +.. code-block:: typoscript + :caption: EXT:site_package/Configuration/Sets/SitePackage/setup.typoscript + + @import 'EXT:site_package/Configuration/TypoScript/Setup/*.typoscript' + \ No newline at end of file diff --git a/Documentation/CodeSnippets/ExtensionConfiguration/TcaOverridePages.rst.txt b/Documentation/CodeSnippets/ExtensionConfiguration/TcaOverridePages.rst.txt deleted file mode 100644 index 94a5902..0000000 --- a/Documentation/CodeSnippets/ExtensionConfiguration/TcaOverridePages.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets -.. Extracted from typo3conf/ext/site_package/Configuration/TCA/Overrides/pages.php - -.. code-block:: php - :caption: EXT:site_package/Configuration/TCA/Overrides/pages.php - :linenos: - - \ No newline at end of file diff --git a/Documentation/CodeSnippets/Fluid/PartialJumbotron.rst.txt b/Documentation/CodeSnippets/Fluid/PartialJumbotron.rst.txt index 2e92909..fabeb67 100644 --- a/Documentation/CodeSnippets/Fluid/PartialJumbotron.rst.txt +++ b/Documentation/CodeSnippets/Fluid/PartialJumbotron.rst.txt @@ -1,5 +1,5 @@ -.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets -.. Extracted from typo3conf/ext/site_package/Resources/Private/Partials/Page/Jumbotron.html +.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets +.. Extracted from EXT:site_package/Resources/Private/Partials/Page/Jumbotron.html .. code-block:: html :caption: EXT:site_package/Resources/Private/Partials/Page/Jumbotron.html diff --git a/Documentation/CodeSnippets/Fluid/Step1Default.rst.txt b/Documentation/CodeSnippets/Fluid/Step1Default.rst.txt index f095f9e..d4034d4 100644 --- a/Documentation/CodeSnippets/Fluid/Step1Default.rst.txt +++ b/Documentation/CodeSnippets/Fluid/Step1Default.rst.txt @@ -1,11 +1,10 @@ -.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets -.. Extracted from typo3conf/ext/site_package/Resources/Public/StaticTemplate/Step1Default.html +.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets +.. Extracted from EXT:site_package/Resources/Public/StaticTemplate/Step1Default.html .. code-block:: html :caption: EXT:site_package/Resources/Public/StaticTemplate/Step1Default.html :linenos: - - +
diff --git a/Documentation/CodeSnippets/Fluid/Step2Default.rst.txt b/Documentation/CodeSnippets/Fluid/Step2Default.rst.txt index d7f9da6..3962b76 100644 --- a/Documentation/CodeSnippets/Fluid/Step2Default.rst.txt +++ b/Documentation/CodeSnippets/Fluid/Step2Default.rst.txt @@ -1,13 +1,12 @@ -.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets -.. Extracted from typo3conf/ext/site_package/Resources/Public/StaticTemplate/Step2Default.html +.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets +.. Extracted from EXT:site_package/Resources/Public/StaticTemplate/Step2Default.html .. code-block:: html :caption: EXT:site_package/Resources/Public/StaticTemplate/Step2Default.html :linenos: - - +
diff --git a/Documentation/CodeSnippets/Fluid/Step3Default.rst.txt b/Documentation/CodeSnippets/Fluid/Step3Default.rst.txt index c8f4bb2..aa6d22d 100644 --- a/Documentation/CodeSnippets/Fluid/Step3Default.rst.txt +++ b/Documentation/CodeSnippets/Fluid/Step3Default.rst.txt @@ -1,15 +1,14 @@ -.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets -.. Extracted from typo3conf/ext/site_package/Resources/Public/StaticTemplate/Step3Default.html +.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets +.. Extracted from EXT:site_package/Resources/Public/StaticTemplate/Step3Default.html .. code-block:: html :caption: EXT:site_package/Resources/Public/StaticTemplate/Step3Default.html :linenos: - - +
diff --git a/Documentation/CodeSnippets/Fluid/TemplateDefault.rst.txt b/Documentation/CodeSnippets/Fluid/TemplateDefault.rst.txt index ff1194f..ff7ff64 100644 --- a/Documentation/CodeSnippets/Fluid/TemplateDefault.rst.txt +++ b/Documentation/CodeSnippets/Fluid/TemplateDefault.rst.txt @@ -1,5 +1,5 @@ -.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets -.. Extracted from typo3conf/ext/site_package/Resources/Private/Templates/Page/Default.html +.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets +.. Extracted from EXT:site_package/Resources/Private/Templates/Page/Default.html .. code-block:: html :caption: EXT:site_package/Resources/Private/Templates/Page/Default.html @@ -7,11 +7,11 @@ - +
- + - +
@@ -25,8 +25,8 @@
- +
- + \ No newline at end of file diff --git a/Documentation/CodeSnippets/Fluid/TemplateTwoColumns.rst.txt b/Documentation/CodeSnippets/Fluid/TemplateTwoColumns.rst.txt index 952ccb3..14e1cc8 100644 --- a/Documentation/CodeSnippets/Fluid/TemplateTwoColumns.rst.txt +++ b/Documentation/CodeSnippets/Fluid/TemplateTwoColumns.rst.txt @@ -1,5 +1,5 @@ -.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets -.. Extracted from typo3conf/ext/site_package/Resources/Private/Templates/Page/TwoColumns.html +.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets +.. Extracted from EXT:site_package/Resources/Private/Templates/Page/TwoColumns.html .. code-block:: html :caption: EXT:site_package/Resources/Private/Templates/Page/TwoColumns.html @@ -7,10 +7,10 @@ - +
- +
@@ -33,8 +33,8 @@
- +
- + \ No newline at end of file diff --git a/Documentation/CodeSnippets/TypoScript/Constants.rst.txt b/Documentation/CodeSnippets/TypoScript/Constants.rst.txt index 59035a7..45a79e7 100644 --- a/Documentation/CodeSnippets/TypoScript/Constants.rst.txt +++ b/Documentation/CodeSnippets/TypoScript/Constants.rst.txt @@ -1,12 +1,10 @@ -.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets -.. Extracted from typo3conf/ext/site_package/Configuration/TypoScript/constants.typoscript +.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets +.. Extracted from EXT:site_package/Configuration/Sets/SitePackage/constants.typoscript .. code-block:: typoscript - :caption: EXT:site_package/Configuration/TypoScript/constants.typoscript + :caption: EXT:site_package/Configuration/Sets/SitePackage/constants.typoscript :linenos: - @import 'EXT:fluid_styled_content/Configuration/TypoScript/constants.typoscript' - page { fluidtemplate { layoutRootPath = EXT:site_package/Resources/Private/Layouts/Page/ diff --git a/Documentation/CodeSnippets/TypoScript/Page.rst.txt b/Documentation/CodeSnippets/TypoScript/Page.rst.txt index 8941380..d3049a5 100644 --- a/Documentation/CodeSnippets/TypoScript/Page.rst.txt +++ b/Documentation/CodeSnippets/TypoScript/Page.rst.txt @@ -1,5 +1,5 @@ -.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets -.. Extracted from typo3conf/ext/site_package/Configuration/TypoScript/Setup/Page.typoscript +.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets +.. Extracted from EXT:site_package/Configuration/TypoScript/Setup/Page.typoscript .. code-block:: typoscript :caption: EXT:site_package/Configuration/TypoScript/Setup/Page.typoscript diff --git a/Documentation/CodeSnippets/TypoScript/Part1FluidTemplateSection.rst.txt b/Documentation/CodeSnippets/TypoScript/Part1FluidTemplateSection.rst.txt index a2f73f9..b89763f 100644 --- a/Documentation/CodeSnippets/TypoScript/Part1FluidTemplateSection.rst.txt +++ b/Documentation/CodeSnippets/TypoScript/Part1FluidTemplateSection.rst.txt @@ -1,5 +1,5 @@ -.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets -.. Extracted from typo3conf/ext/site_package/Configuration/TypoScript/Setup/Part1FluidTemplateSection.typoscript +.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets +.. Extracted from EXT:site_package/Configuration/TypoScript/Setup/Part1FluidTemplateSection.typoscript .. code-block:: typoscript :caption: EXT:site_package/Configuration/TypoScript/Setup/Part1FluidTemplateSection.typoscript @@ -21,20 +21,20 @@ 1.current = 1 } } - + ifEmpty = Default } - + templateRootPaths { 0 = EXT:site_package/Resources/Private/Templates/Page/ 1 = {$page.fluidtemplate.templateRootPath} } - + partialRootPaths { 0 = EXT:site_package/Resources/Private/Partials/Page/ 1 = {$page.fluidtemplate.partialRootPath} } - + layoutRootPaths { 0 = EXT:site_package/Resources/Private/Layouts/Page/ 1 = {$page.fluidtemplate.layoutRootPath} diff --git a/Documentation/CodeSnippets/TypoScript/Part2CssFileInclusion.rst.txt b/Documentation/CodeSnippets/TypoScript/Part2CssFileInclusion.rst.txt index aa10117..220a11b 100644 --- a/Documentation/CodeSnippets/TypoScript/Part2CssFileInclusion.rst.txt +++ b/Documentation/CodeSnippets/TypoScript/Part2CssFileInclusion.rst.txt @@ -1,11 +1,10 @@ -.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets -.. Extracted from typo3conf/ext/site_package/Configuration/TypoScript/Setup/Part2CssFileInclusion.typoscript +.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets +.. Extracted from EXT:site_package/Configuration/TypoScript/Setup/Part2CssFileInclusion.typoscript .. code-block:: typoscript :caption: EXT:site_package/Configuration/TypoScript/Setup/Part2CssFileInclusion.typoscript :linenos: - page { // Part 2: CSS file inclusion includeCSS { @@ -13,7 +12,7 @@ bootstrap.external = 1 website = EXT:site_package/Resources/Public/Css/website.css } - + // Part 3: JavaScript file inclusion includeJSFooter { jquery = https://code.jquery.com/jquery-3.2.1.slim.min.js diff --git a/Documentation/CodeSnippets/TypoScript/Part4GlobalConfiguration.rst.txt b/Documentation/CodeSnippets/TypoScript/Part4GlobalConfiguration.rst.txt index cf17f10..27f0099 100644 --- a/Documentation/CodeSnippets/TypoScript/Part4GlobalConfiguration.rst.txt +++ b/Documentation/CodeSnippets/TypoScript/Part4GlobalConfiguration.rst.txt @@ -1,5 +1,5 @@ -.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets -.. Extracted from typo3conf/ext/site_package/Configuration/TypoScript/Setup/Part4GlobalConfiguration.typoscript +.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets +.. Extracted from EXT:site_package/Configuration/TypoScript/Setup/Part4GlobalConfiguration.typoscript .. code-block:: typoscript :caption: EXT:site_package/Configuration/TypoScript/Setup/Part4GlobalConfiguration.typoscript @@ -10,7 +10,7 @@ # Adjust the title tag to be displayed as “website - page title” pageTitleSeparator = - pageTitleSeparator.noTrimWrap = | | | - + # Display the Admin Panel at the bottom of pages to logged in backend users admPanel = 1 } diff --git a/Documentation/CodeSnippets/TypoScript/Part5MenuProcessor.rst.txt b/Documentation/CodeSnippets/TypoScript/Part5MenuProcessor.rst.txt index ff06309..cbcbf5c 100644 --- a/Documentation/CodeSnippets/TypoScript/Part5MenuProcessor.rst.txt +++ b/Documentation/CodeSnippets/TypoScript/Part5MenuProcessor.rst.txt @@ -1,5 +1,5 @@ -.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets -.. Extracted from typo3conf/ext/site_package/Configuration/TypoScript/Setup/Part5MenuProcessor.typoscript +.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets +.. Extracted from EXT:site_package/Configuration/TypoScript/Setup/Part5MenuProcessor.typoscript .. code-block:: typoscript :caption: EXT:site_package/Configuration/TypoScript/Setup/Part5MenuProcessor.typoscript @@ -17,7 +17,7 @@ layoutRootPaths { // ... } - + dataProcessing { 10 = TYPO3\CMS\Frontend\DataProcessing\MenuProcessor 10 { diff --git a/Documentation/CodeSnippets/TypoScript/Part6ProcessedContent.rst.txt b/Documentation/CodeSnippets/TypoScript/Part6ProcessedContent.rst.txt index 626cbc0..4318aed 100644 --- a/Documentation/CodeSnippets/TypoScript/Part6ProcessedContent.rst.txt +++ b/Documentation/CodeSnippets/TypoScript/Part6ProcessedContent.rst.txt @@ -1,11 +1,10 @@ -.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets -.. Extracted from typo3conf/ext/site_package/Configuration/TypoScript/Setup/Part6ProcessedContent.typoscript +.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets +.. Extracted from EXT:site_package/Configuration/TypoScript/Setup/Part6ProcessedContent.typoscript .. code-block:: typoscript :caption: EXT:site_package/Configuration/TypoScript/Setup/Part6ProcessedContent.typoscript :linenos: - page { 10 { dataProcessing { diff --git a/Documentation/CodeSnippets/TypoScript/Setup.rst.txt b/Documentation/CodeSnippets/TypoScript/Setup.rst.txt index 5c04e8f..3f1ab3c 100644 --- a/Documentation/CodeSnippets/TypoScript/Setup.rst.txt +++ b/Documentation/CodeSnippets/TypoScript/Setup.rst.txt @@ -1,12 +1,9 @@ -.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets -.. Extracted from typo3conf/ext/site_package/Configuration/TypoScript/setup.typoscript +.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets +.. Extracted from EXT:site_package/Configuration/Sets/SitePackage/setup.typoscript .. code-block:: typoscript - :caption: EXT:site_package/Configuration/TypoScript/setup.typoscript + :caption: EXT:site_package/Configuration/Sets/SitePackage/setup.typoscript :linenos: - @import 'EXT:fluid_styled_content/Configuration/TypoScript/setup.typoscript' @import 'EXT:site_package/Configuration/TypoScript/Setup/*.typoscript' - - \ No newline at end of file diff --git a/Documentation/CodeSnippets/codesnippets.php b/Documentation/CodeSnippets/codesnippets.php index 5f56036..649dbbb 100644 --- a/Documentation/CodeSnippets/codesnippets.php +++ b/Documentation/CodeSnippets/codesnippets.php @@ -6,56 +6,56 @@ # code Snippets Setup [ 'action' => 'createCodeSnippet', - 'sourceFile' => 'typo3conf/ext/site_package/Configuration/TypoScript/constants.typoscript', + 'sourceFile' => 'EXT:site_package/Configuration/Sets/SitePackage/constants.typoscript', 'targetFileName' => 'TypoScript/Constants.rst.txt', - 'caption' => 'EXT:site_package/Configuration/TypoScript/constants.typoscript', + 'caption' => 'EXT:site_package/Configuration/Sets/SitePackage/constants.typoscript', 'showLineNumbers' => true ], [ 'action' => 'createCodeSnippet', - 'sourceFile' => 'typo3conf/ext/site_package/Configuration/TypoScript/setup.typoscript', + 'sourceFile' => 'EXT:site_package/Configuration/Sets/SitePackage/setup.typoscript', 'targetFileName' => 'TypoScript/Setup.rst.txt', - 'caption' => 'EXT:site_package/Configuration/TypoScript/setup.typoscript', + 'caption' => 'EXT:site_package/Configuration/Sets/SitePackage/setup.typoscript', 'showLineNumbers' => true ], [ 'action' => 'createCodeSnippet', - 'sourceFile' => 'typo3conf/ext/site_package/Configuration/TypoScript/Setup/Page.typoscript', + 'sourceFile' => 'EXT:site_package/Configuration/TypoScript/Setup/Page.typoscript', 'targetFileName' => 'TypoScript/Page.rst.txt', 'caption' => 'EXT:site_package/Configuration/TypoScript/Setup/Page.typoscript', 'showLineNumbers' => true ], [ 'action' => 'createCodeSnippet', - 'sourceFile' => 'typo3conf/ext/site_package/Configuration/TypoScript/Setup/Part1FluidTemplateSection.typoscript', + 'sourceFile' => 'EXT:site_package/Configuration/TypoScript/Setup/Part1FluidTemplateSection.typoscript', 'targetFileName' => 'TypoScript/Part1FluidTemplateSection.rst.txt', 'caption' => 'EXT:site_package/Configuration/TypoScript/Setup/Part1FluidTemplateSection.typoscript', 'showLineNumbers' => true ], [ 'action' => 'createCodeSnippet', - 'sourceFile' => 'typo3conf/ext/site_package/Configuration/TypoScript/Setup/Part2CssFileInclusion.typoscript', + 'sourceFile' => 'EXT:site_package/Configuration/TypoScript/Setup/Part2CssFileInclusion.typoscript', 'targetFileName' => 'TypoScript/Part2CssFileInclusion.rst.txt', 'caption' => 'EXT:site_package/Configuration/TypoScript/Setup/Part2CssFileInclusion.typoscript', 'showLineNumbers' => true ], [ 'action' => 'createCodeSnippet', - 'sourceFile' => 'typo3conf/ext/site_package/Configuration/TypoScript/Setup/Part4GlobalConfiguration.typoscript', + 'sourceFile' => 'EXT:site_package/Configuration/TypoScript/Setup/Part4GlobalConfiguration.typoscript', 'targetFileName' => 'TypoScript/Part4GlobalConfiguration.rst.txt', 'caption' => 'EXT:site_package/Configuration/TypoScript/Setup/Part4GlobalConfiguration.typoscript', 'showLineNumbers' => true ], [ 'action' => 'createCodeSnippet', - 'sourceFile' => 'typo3conf/ext/site_package/Configuration/TypoScript/Setup/Part5MenuProcessor.typoscript', + 'sourceFile' => 'EXT:site_package/Configuration/TypoScript/Setup/Part5MenuProcessor.typoscript', 'targetFileName' => 'TypoScript/Part5MenuProcessor.rst.txt', 'caption' => 'EXT:site_package/Configuration/TypoScript/Setup/Part5MenuProcessor.typoscript', 'showLineNumbers' => true ], [ 'action' => 'createCodeSnippet', - 'sourceFile' => 'typo3conf/ext/site_package/Configuration/TypoScript/Setup/Part6ProcessedContent.typoscript', + 'sourceFile' => 'EXT:site_package/Configuration/TypoScript/Setup/Part6ProcessedContent.typoscript', 'targetFileName' => 'TypoScript/Part6ProcessedContent.rst.txt', 'caption' => 'EXT:site_package/Configuration/TypoScript/Setup/Part6ProcessedContent.typoscript', 'showLineNumbers' => true @@ -64,74 +64,91 @@ #code Snippets Extension Configuration [ 'action' => 'createCodeSnippet', - 'sourceFile' => 'typo3conf/ext/site_package/composer.json', + 'sourceFile' => 'EXT:site_package/composer.json', 'targetFileName' => 'ExtensionConfiguration/ComposerJson.rst.txt', 'caption' => 'EXT:site_package/composer.json', 'showLineNumbers' => true ], [ 'action' => 'createCodeSnippet', - 'sourceFile' => 'typo3conf/ext/site_package/Configuration/TCA/Overrides/pages.php', - 'targetFileName' => 'ExtensionConfiguration/TcaOverridePages.rst.txt', - 'caption' => 'EXT:site_package/Configuration/TCA/Overrides/pages.php', + 'sourceFile' => 'EXT:site_package/Configuration/Sets/SitePackage/config.yaml', + 'targetFileName' => 'ExtensionConfiguration/SitePackage-config.rst.txt', + 'caption' => 'EXT:site_package/Configuration/Sets/SitePackage/config.yaml', 'showLineNumbers' => true ], [ 'action' => 'createCodeSnippet', - 'sourceFile' => 'typo3conf/ext/site_package/Configuration/TCA/Overrides/sys_template.php', - 'targetFileName' => 'ExtensionConfiguration/TcaOverrideSysTemplate.rst.txt', - 'caption' => 'EXT:site_package/Configuration/TCA/Overrides/sys_template.php', + 'sourceFile' => 'EXT:site_package/Configuration/Sets/SitePackage/settings.yaml', + 'targetFileName' => 'ExtensionConfiguration/SitePackage-settings.rst.txt', + 'caption' => 'EXT:site_package/Configuration/Sets/SitePackage/settings.yaml', 'showLineNumbers' => true ], + [ + 'action' => 'createCodeSnippet', + 'sourceFile' => 'EXT:site_package/Configuration/Sets/SitePackage/setup.typoscript', + 'targetFileName' => 'ExtensionConfiguration/SitePackage-setup.rst.txt', + 'caption' => 'EXT:site_package/Configuration/Sets/SitePackage/setup.typoscript', + ], + [ + 'action' => 'createCodeSnippet', + 'sourceFile' => 'EXT:site_package/Configuration/Sets/SitePackage/constants.typoscript', + 'targetFileName' => 'ExtensionConfiguration/SitePackage-constants.rst.txt', + 'caption' => 'EXT:site_package/Configuration/Sets/SitePackage/constants.typoscript', + ], + [ + 'action' => 'createCodeSnippet', + 'sourceFile' => 'EXT:site_package/Configuration/Sets/SitePackage/page.tsconfig', + 'targetFileName' => 'ExtensionConfiguration/SitePackage-page-tsconfig.rst.txt', + 'caption' => 'EXT:site_package/Configuration/Sets/SitePackage/page.tsconfig', + 'language' => 'typoscript', + ], # code Snippets Fluid - - [ 'action' => 'createCodeSnippet', - 'sourceFile' => 'typo3conf/ext/site_package/Resources/Public/StaticTemplate/Step1Default.html', + 'sourceFile' => 'EXT:site_package/Resources/Public/StaticTemplate/Step1Default.html', 'targetFileName' => 'Fluid/Step1Default.rst.txt', 'caption' => 'EXT:site_package/Resources/Public/StaticTemplate/Step1Default.html', 'showLineNumbers' => true ], [ 'action' => 'createCodeSnippet', - 'sourceFile' => 'typo3conf/ext/site_package/Resources/Public/StaticTemplate/Step2Default.html', + 'sourceFile' => 'EXT:site_package/Resources/Public/StaticTemplate/Step2Default.html', 'targetFileName' => 'Fluid/Step2Default.rst.txt', 'caption' => 'EXT:site_package/Resources/Public/StaticTemplate/Step2Default.html', 'showLineNumbers' => true ], [ 'action' => 'createCodeSnippet', - 'sourceFile' => 'typo3conf/ext/site_package/Resources/Public/StaticTemplate/Step3Default.html', + 'sourceFile' => 'EXT:site_package/Resources/Public/StaticTemplate/Step3Default.html', 'targetFileName' => 'Fluid/Step3Default.rst.txt', 'caption' => 'EXT:site_package/Resources/Public/StaticTemplate/Step3Default.html', 'showLineNumbers' => true ], [ 'action' => 'createCodeSnippet', - 'sourceFile' => 'typo3conf/ext/site_package/Resources/Private/Templates/Page/Default.html', + 'sourceFile' => 'EXT:site_package/Resources/Private/Templates/Page/Default.html', 'targetFileName' => 'Fluid/TemplateDefault.rst.txt', 'caption' => 'EXT:site_package/Resources/Private/Templates/Page/Default.html', 'showLineNumbers' => true ], [ 'action' => 'createCodeSnippet', - 'sourceFile' => 'typo3conf/ext/site_package/Resources/Private/Templates/Page/TwoColumns.html', + 'sourceFile' => 'EXT:site_package/Resources/Private/Templates/Page/TwoColumns.html', 'targetFileName' => 'Fluid/TemplateTwoColumns.rst.txt', 'caption' => 'EXT:site_package/Resources/Private/Templates/Page/TwoColumns.html', 'showLineNumbers' => true ], [ 'action' => 'createCodeSnippet', - 'sourceFile' => 'typo3conf/ext/site_package/Resources/Private/Partials/Page/Jumbotron.html', + 'sourceFile' => 'EXT:site_package/Resources/Private/Partials/Page/Jumbotron.html', 'targetFileName' => 'Fluid/PartialJumbotron.rst.txt', 'caption' => 'EXT:site_package/Resources/Private/Partials/Page/Jumbotron.html', 'showLineNumbers' => true ], [ 'action' => 'createCodeSnippet', - 'sourceFile' => 'typo3conf/ext/site_package/Resources/Private/Layouts/Page/Default.html', + 'sourceFile' => 'EXT:site_package/Resources/Private/Layouts/Page/Default.html', 'targetFileName' => 'Fluid/Layout.rst.txt', 'caption' => 'EXT:site_package/Resources/Private/Layouts/Page/Default.html', 'showLineNumbers' => true diff --git a/Documentation/ContentMapping/Index.rst b/Documentation/ContentMapping/Index.rst index c20dffd..a080c7b 100644 --- a/Documentation/ContentMapping/Index.rst +++ b/Documentation/ContentMapping/Index.rst @@ -55,12 +55,18 @@ This syntax imports all files ending on `.tsconfig` from the specified folder. automatically loaded during build time. See :ref:`t3tsconfig:setting-page-tsconfig` on how to load the file in older TYPO3 versions. - -When there is only one site in your installation or all sites share the same -configurations we suggest to include this file globally as decribed here. -See :ref:`t3tsconfig:setting-page-tsconfig` on how to load the page TSconfig + +When there is only one site in your installation or all sites share the same +configurations we suggest to include this file globally as decribed here. +See :ref:`t3tsconfig:setting-page-tsconfig` on how to load the page TSconfig for a certain page tree. + +.. _backend-page-layouts: + +Create the backend page layouts +------------------------------- + Then create a file :file:`Configuration/TsConfig/Page/PageLayout/Default.tsconfig` with the following content: diff --git a/Documentation/CreatePages/Index.rst b/Documentation/CreatePages/Index.rst index 4db922e..14f7089 100644 --- a/Documentation/CreatePages/Index.rst +++ b/Documentation/CreatePages/Index.rst @@ -98,11 +98,6 @@ You should find the item "Site Package (site_package)" in the list Now save your changes by clicking the :guilabel:`Save` button at the top. -.. hint:: - The item "Site Package" was created by the file - :file:`Configuration/TCA/Overrides/sys_template.php` in the step - :ref:`Make TypoScript available `. - Preview the page ================ diff --git a/Documentation/ExtensionConfiguration/Index.rst b/Documentation/ExtensionConfiguration/Index.rst index c681ea0..49dec13 100644 --- a/Documentation/ExtensionConfiguration/Index.rst +++ b/Documentation/ExtensionConfiguration/Index.rst @@ -7,6 +7,9 @@ Extension Configuration ======================= + +.. _extension-configuration-composer: + Composer configuration :file:`composer.json` ============================================ @@ -42,19 +45,61 @@ Every extension can feature an icon using an SVG, PNG or GIF file. The image should be stored in :file:`Resources/Public/Icons/`. It is recommended that you use an SVG file called :file:`Extension.svg`. - .. _make-typoscript-available: -Make TypoScript available -========================= +Set for providing TypoScript +============================ + +.. versionchanged:: 13.1 + In TYPO3 v13.1 and above the TypoScript files are made available as + sets and included in the site. For TYPO3 v12 read the section in + the tutorial for TYPO3 v12.4: + :ref:`Make TypoScript available (TYPO3 v12.4) `. + +In order to make the TypoScript files available, we have created in section +:ref:`TypoScript configuration ` we +create a site set that can be included by the site configuration later-on. + +Create a folder: :path:`Configuration/Sets/MySitePackage/` and put a file +called :file:`config.yaml` into it: + +.. include:: /CodeSnippets/ExtensionConfiguration/SitePackage-config.rst.txt + +Line 1 defines the name of the set. As the example site-package extension only +provides one set, the name of the set should be the same as the +:ref:`composer name `. -In order to automatically load the TypoScript files we have created in the -previous step, a new PHP file :file:`sys_template.php` needs to be created and -stored in directory :file:`Configuration/TCA/Overrides/`. The content of this file -should look like the following code: +In line 4 and 5 dependencies are defined. In this example the site package +depends on :t3src:`fluid_styled_content`, therefore the sets provided by this +system extension are included as dependency. By doing so all settings +and TypoScript definitions provided by the extension are automatically included. -.. include:: /CodeSnippets/ExtensionConfiguration/TcaOverrideSysTemplate.rst.txt +In the same folder we can place a file called :file:`settings.yaml` that we use +to override some default settings of :t3src:`fluid_styled_content`: +.. include:: /CodeSnippets/ExtensionConfiguration/SitePackage-settings.rst.txt + +Here we override some values for maximal image width in text-media content +elements, we enable a lightbox for images and set paths for overriding the +templates of that extension. + +Then we put a file called :file:`setup.typoscript` into this folder. We use +this file to include all TypoScript needed from the folder +:path:`Configuration/TypoScript`. It would also be possible to place the +TypoScript directly into this file. But we want to split our TypoScript into +different files. + +.. include:: /CodeSnippets/ExtensionConfiguration/SitePackage-setup.rst.txt + +As we only have a few lines of TypoScript constants we define them directly in +a file called :file:`constants.typoscript` in this folder: + +.. include:: /CodeSnippets/ExtensionConfiguration/SitePackage-constants.rst.txt + +Last we add a file called :file:`page.tsconfig` which includes the backend page +layouts we create in :ref:`backend-page-layouts`: + +.. include:: /CodeSnippets/ExtensionConfiguration/SitePackage-page-tsconfig.rst.txt .. _ec-directory-structure: @@ -70,60 +115,57 @@ it stands now. * site_package/ - * Configuration/ + * Configuration - * TCA/ + * Sets - * Overrides/ + * MySitePackage - * sys_template.php + config.yaml + constants.typoscript + setup.typoscript - * TypoScript/ + * TypoScript - * constants.typoscript - * setup.typoscript + * Resources - * Resources/ + * Private - * Private/ + * Layouts - * Layouts/ + * Page - * Page/ + * Default.html - * Default.html + * Partials - * Partials/ + * Page - * Page/ + * Jumbotron.html - * Jumbotron.html + * Templates - * Templates/ + * Page - * Page/ + * Default.html - * Default.html - * Public/ + * Public - * Css/ + * Css - * website.css + * website.css - * Icons + * Icons/Extension.svg - * Extension.svg + * Images/ - * Images/ + * logo.png - * logo.png + * JavaScript - * JavaScript/ - - * website.js + * website.js * composer.json - At this point we can install the sitepackage extension in an TYPO3 instance, which we will do in the next step. diff --git a/composer.json b/composer.json index a8e59d1..6ec057c 100644 --- a/composer.json +++ b/composer.json @@ -4,7 +4,8 @@ "description": "The official tutorial how to create a sitepackage in TYPO3 from scratch.", "license": "CC-BY-NC-SA-4.0", "require": { - "typo3/cms-core": "^12.0" + "php": "^8.2", + "typo3/cms-core": "dev-main as 13.1.0" }, "minimum-stability": "dev", "prefer-stable": true, @@ -23,39 +24,39 @@ }, "require-dev": { "t3docs/codesnippet": "dev-main", - "typo3/cms-adminpanel": "^12.0", - "typo3/cms-backend": "^12.0", - "typo3/cms-belog": "^12.0", - "typo3/cms-beuser": "^12.0", - "typo3/cms-dashboard": "^12.0", - "typo3/cms-extbase": "^12.0", - "typo3/cms-extensionmanager": "^12.0", - "typo3/cms-felogin": "^12.0", - "typo3/cms-filelist": "^12.0", - "typo3/cms-filemetadata": "^12.0", - "typo3/cms-fluid": "^12.0", - "typo3/cms-fluid-styled-content": "^12.0", - "typo3/cms-form": "^12.0", - "typo3/cms-frontend": "^12.0", - "typo3/cms-impexp": "^12.0", - "typo3/cms-indexed-search": "^12.0", - "typo3/cms-info": "^12.0", - "typo3/cms-install": "^12.0", - "typo3/cms-linkvalidator": "^12.0", - "typo3/cms-lowlevel": "^12.0", - "typo3/cms-opendocs": "^12.0", - "typo3/cms-recycler": "^12.0", - "typo3/cms-redirects": "^12.0", - "typo3/cms-reports": "^12.0", - "typo3/cms-rte-ckeditor": "^12.0", - "typo3/cms-scheduler": "^12.0", - "typo3/cms-seo": "^12.0", - "typo3/cms-setup": "^12.0", - "typo3/cms-sys-note": "^12.0", - "typo3/cms-t3editor": "^12.0", - "typo3/cms-tstemplate": "^12.0", - "typo3/cms-viewpage": "^12.0", - "typo3/cms-workspaces": "^12.0", + "typo3/cms-adminpanel": "dev-main as 13.1.0", + "typo3/cms-backend": "dev-main as 13.1.0", + "typo3/cms-belog": "dev-main as 13.1.0", + "typo3/cms-beuser": "dev-main as 13.1.0", + "typo3/cms-dashboard": "dev-main as 13.1.0", + "typo3/cms-extbase": "dev-main as 13.1.0", + "typo3/cms-extensionmanager": "dev-main as 13.1.0", + "typo3/cms-felogin": "dev-main as 13.1.0", + "typo3/cms-filelist": "dev-main as 13.1.0", + "typo3/cms-filemetadata": "dev-main as 13.1.0", + "typo3/cms-fluid": "dev-main as 13.1.0", + "typo3/cms-fluid-styled-content": "dev-main as 13.1.0", + "typo3/cms-form": "dev-main as 13.1.0", + "typo3/cms-frontend": "dev-main as 13.1.0", + "typo3/cms-impexp": "dev-main as 13.1.0", + "typo3/cms-indexed-search": "dev-main as 13.1.0", + "typo3/cms-info": "dev-main as 13.1.0", + "typo3/cms-install": "dev-main as 13.1.0", + "typo3/cms-linkvalidator": "dev-main as 13.1.0", + "typo3/cms-lowlevel": "dev-main as 13.1.0", + "typo3/cms-opendocs": "dev-main as 13.1.0", + "typo3/cms-recycler": "dev-main as 13.1.0", + "typo3/cms-redirects": "dev-main as 13.1.0", + "typo3/cms-reports": "dev-main as 13.1.0", + "typo3/cms-rte-ckeditor": "dev-main as 13.1.0", + "typo3/cms-scheduler": "dev-main as 13.1.0", + "typo3/cms-seo": "dev-main as 13.1.0", + "typo3/cms-setup": "dev-main as 13.1.0", + "typo3/cms-sys-note": "dev-main as 13.1.0", + "typo3/cms-t3editor": "dev-main as 13.1.0", + "typo3/cms-tstemplate": "dev-main as 13.1.0", + "typo3/cms-viewpage": "dev-main as 13.1.0", + "typo3/cms-workspaces": "dev-main as 13.1.0", "t3docs/examples": "dev-main", "t3docs/site-package": "dev-main" },