+
+
+
+
+
+
+
+ 11
+ 3
+ 1728110148
+ 1728108635
+ 0
+ 0
+ 0
+ 0
+
+ 256
+
+ 0
+ 0
+ 0
+ 0
+
+ {"CType":"","colPos":"","header":"","header_layout":"","header_position":"","date":"","header_link":"","subheader":"","bodytext":"","image":"","imagewidth":"","imageheight":"","imageborder":"","imageorient":"","imagecols":"","image_zoom":"","layout":"","frame_class":"","space_before_class":"","space_after_class":"","sectionIndex":"","linkToTop":"","categories":"","sys_language_uid":"","hidden":"","starttime":"","endtime":"","fe_group":"","editlock":"","rowDescription":""}
+ 0
+ 0
+ 0
+ 0
+ default
+ 0
+
+ 0
+ textpic
+ 0
+ 0
+
+
+ 0
+ Pluto
+ 0
+ center
+
+
+ <p><strong>Pluto </strong>is a dwarf planet in the Kuiper belt, a ring of bodies beyond the orbit of Neptune. It is the ninth-largest and tenth-most-massive known object to directly orbit the Sun. It is the largest known trans-Neptunian object by volume, by a small margin, but is slightly less massive than Eris. Like other Kuiper belt objects, Pluto is made primarily of ice and rock and is much smaller than the inner planets. Pluto has roughly one-sixth the mass of the Moon, and one-third its volume.</p>
+ 1
+ 0
+ 250
+ 0
+ 0
+ 0
+ 0
+ 2
+
+ 0
+
+ 0
+
+ 1
+ 0
+
+
+
+ 0
+ 0
+
+ 124
+ 0
+ 0
+ 0
+
+ 0
+
+
+
+ 0
+ 0
+
+
+
+ db
+
+
+ 1
+
+
+
+
+
+
+
+
+
+ 1024px-Mercury_clipart.svg.png
+ 1714803857
+ 10cc025d8583bfd3272bf8ee4b309edb79bad55f
+
+
+ 1024px-Venus_clipart.svg.png
+ 1714803857
+ b8a8591926c3640aa1dba9c9a4b0b16691ec71ea
+
+
+ Pluto.jpg
+ 1714803857
+ 2525cdd6f325f3fe72e671eacaccf6a56a496bc3
+
+
+
diff --git a/Documentation/CodeSnippets/my_site_package/Initialisation/data.xml.files/10cc025d8583bfd3272bf8ee4b309edb79bad55f b/Documentation/CodeSnippets/my_site_package/Initialisation/data.xml.files/10cc025d8583bfd3272bf8ee4b309edb79bad55f
new file mode 100644
index 00000000..0d9da127
Binary files /dev/null and b/Documentation/CodeSnippets/my_site_package/Initialisation/data.xml.files/10cc025d8583bfd3272bf8ee4b309edb79bad55f differ
diff --git a/Documentation/CodeSnippets/my_site_package/Initialisation/data.xml.files/2525cdd6f325f3fe72e671eacaccf6a56a496bc3 b/Documentation/CodeSnippets/my_site_package/Initialisation/data.xml.files/2525cdd6f325f3fe72e671eacaccf6a56a496bc3
new file mode 100644
index 00000000..52cb79c0
Binary files /dev/null and b/Documentation/CodeSnippets/my_site_package/Initialisation/data.xml.files/2525cdd6f325f3fe72e671eacaccf6a56a496bc3 differ
diff --git a/Documentation/CodeSnippets/my_site_package/Initialisation/data.xml.files/b8a8591926c3640aa1dba9c9a4b0b16691ec71ea b/Documentation/CodeSnippets/my_site_package/Initialisation/data.xml.files/b8a8591926c3640aa1dba9c9a4b0b16691ec71ea
new file mode 100644
index 00000000..50fb4b8e
Binary files /dev/null and b/Documentation/CodeSnippets/my_site_package/Initialisation/data.xml.files/b8a8591926c3640aa1dba9c9a4b0b16691ec71ea differ
diff --git a/Documentation/CodeSnippets/my_site_package/README.md b/Documentation/CodeSnippets/my_site_package/README.md
new file mode 100644
index 00000000..38cc81a3
--- /dev/null
+++ b/Documentation/CodeSnippets/my_site_package/README.md
@@ -0,0 +1,74 @@
+# TYPO3 Site Package Tutorial Example
+
+This Site Package can be used to follow the [TYPO3 Site
+Package Tutorial](https://docs.typo3.org/permalink/t3sitepackage:start@13.4).
+Team.
+
+The tutorial describes the steps required to turn a basic design
+template (HTML, CSS, JavaScript files, etc.) into a fully working,
+mobile-responsive website. By following the steps of the Site Package
+Tutorial, the reader builds a modern extension with all relevant files
+stored at a central point and changes can easily be tracked in version
+control. Despite the fact that TYPO3 supports several methods of
+implementing websites, this approach is a very flexible and
+professional way.
+
+## Installation with Composer
+
+Download the Site Package and save it into folder [packages/](https://docs.typo3.org/permalink/t3coreapi:directory-packages)
+in the root of your TYPO3 installation.
+
+Require the Site Package using Composer and DDEV:
+
+```
+ddev composer req my-vendor/my-site-package:"@dev"
+```
+
+Or just Composer:
+
+```
+composer req my-vendor/my-site-package:"@dev"
+```
+
+## Classic TYPO3 installations
+
+When you intend to follow the Site Package Tutorial we recommend that you use a Composer-based installation
+all paths and commands in the Tutorial are based on that type of installation.
+
+Download the Site Package and save it into folder `typo3conf/ext/` in the root of your TYPO3 installation.
+
+Activate extension "My Site Package" with key my_site_package in the Extension Manager.
+
+## Load Example data
+
+With DDEV call:
+
+```
+ddev typo3 extension:setup
+```
+
+Without DDEV:
+
+```
+vendor/bin/typo3 extension:setup
+```
+
+If automatic loading fails you can also try to use the import command:
+
+```
+ddev typo3 impexp:import EXT:my_site_package/Initialisation/data.xml
+```
+
+## Include the Set manually
+
+If you decide not to load the Example data, the Set of this Site Package needs to be included manually:
+
+Include the Set "My Site Package" in your site configuration.
+See also: [Create a basic site set](https://docs.typo3.org/permalink/t3sitepackage:minimal-extension-siteset).
+
+You can also edit the file `config/sites/mysite/config.yaml` and include the following lines:
+
+```
+dependencies:
+ - my-vendor/my-site-package
+```
diff --git a/Documentation/CodeSnippets/my_site_package/Resources/Private/.htaccess b/Documentation/CodeSnippets/my_site_package/Resources/Private/.htaccess
new file mode 100644
index 00000000..93169e4e
--- /dev/null
+++ b/Documentation/CodeSnippets/my_site_package/Resources/Private/.htaccess
@@ -0,0 +1,2 @@
+Order deny,allow
+Deny from all
diff --git a/Documentation/CodeSnippets/my_site_package/Resources/Private/ContentElements/Layouts/.gitkeep b/Documentation/CodeSnippets/my_site_package/Resources/Private/ContentElements/Layouts/.gitkeep
new file mode 100644
index 00000000..8b137891
--- /dev/null
+++ b/Documentation/CodeSnippets/my_site_package/Resources/Private/ContentElements/Layouts/.gitkeep
@@ -0,0 +1 @@
+
diff --git a/Documentation/CodeSnippets/my_site_package/Resources/Private/ContentElements/Partials/Media/Rendering/Image.html b/Documentation/CodeSnippets/my_site_package/Resources/Private/ContentElements/Partials/Media/Rendering/Image.html
new file mode 100644
index 00000000..d0a7d922
--- /dev/null
+++ b/Documentation/CodeSnippets/my_site_package/Resources/Private/ContentElements/Partials/Media/Rendering/Image.html
@@ -0,0 +1,3 @@
+
+
+
diff --git a/Documentation/CodeSnippets/my_site_package/Resources/Private/ContentElements/Templates/MenuSitemap.html b/Documentation/CodeSnippets/my_site_package/Resources/Private/ContentElements/Templates/MenuSitemap.html
new file mode 100644
index 00000000..66c50484
--- /dev/null
+++ b/Documentation/CodeSnippets/my_site_package/Resources/Private/ContentElements/Templates/MenuSitemap.html
@@ -0,0 +1,24 @@
+
+
+
+
+
+
+
+
+
+
+
diff --git a/Documentation/CodeSnippets/my_site_package/Resources/Private/PageView/Partials/Stage.html b/Documentation/CodeSnippets/my_site_package/Resources/Private/PageView/Partials/Stage.html
new file mode 100644
index 00000000..f4c88252
--- /dev/null
+++ b/Documentation/CodeSnippets/my_site_package/Resources/Private/PageView/Partials/Stage.html
@@ -0,0 +1,9 @@
+
+
+
+
+
diff --git a/Documentation/CodeSnippets/my_site_package/Resources/Public/Css/main.css b/Documentation/CodeSnippets/my_site_package/Resources/Public/Css/main.css
new file mode 100644
index 00000000..37ee76e5
--- /dev/null
+++ b/Documentation/CodeSnippets/my_site_package/Resources/Public/Css/main.css
@@ -0,0 +1,21 @@
+:root {
+ --bs-border-radius: 0;
+ --bs-border-radius-sm: 0;
+ --bs-border-radius-lg: 0;
+ --bs-primary: #ff8700;
+ --bs-primary-bg-subtle: #ffcc99;
+}
+
+.nav {
+ --bs-nav-link-color: var(--bs-body-color);
+ --bs-nav-link-hover-color: var(--bs-dark);
+}
+
+.navbar-expand-lg .navbar-nav .nav-link.active {
+ border-bottom: 2px solid var(--bs-primary);
+}
+
+.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
new file mode 100644
index 00000000..8b137891
--- /dev/null
+++ b/Documentation/CodeSnippets/my_site_package/Resources/Public/Fonts/.gitkeep
@@ -0,0 +1 @@
+
diff --git a/Documentation/CodeSnippets/my_site_package/Resources/Public/Icons/BackendLayouts/default.svg b/Documentation/CodeSnippets/my_site_package/Resources/Public/Icons/BackendLayouts/default.svg
new file mode 100644
index 00000000..98309168
--- /dev/null
+++ b/Documentation/CodeSnippets/my_site_package/Resources/Public/Icons/BackendLayouts/default.svg
@@ -0,0 +1,13 @@
+
diff --git a/Documentation/CodeSnippets/my_site_package/Resources/Public/Icons/BackendLayouts/subpage.svg b/Documentation/CodeSnippets/my_site_package/Resources/Public/Icons/BackendLayouts/subpage.svg
new file mode 100644
index 00000000..fdae6fd5
--- /dev/null
+++ b/Documentation/CodeSnippets/my_site_package/Resources/Public/Icons/BackendLayouts/subpage.svg
@@ -0,0 +1,16 @@
+
diff --git a/Documentation/CodeSnippets/my_site_package/Resources/Public/Icons/Extension.svg b/Documentation/CodeSnippets/my_site_package/Resources/Public/Icons/Extension.svg
new file mode 100644
index 00000000..eab6182d
--- /dev/null
+++ b/Documentation/CodeSnippets/my_site_package/Resources/Public/Icons/Extension.svg
@@ -0,0 +1 @@
+
diff --git a/Documentation/CodeSnippets/my_site_package/Resources/Public/Icons/favicon.ico b/Documentation/CodeSnippets/my_site_package/Resources/Public/Icons/favicon.ico
new file mode 100644
index 00000000..90fdfe18
Binary files /dev/null and b/Documentation/CodeSnippets/my_site_package/Resources/Public/Icons/favicon.ico differ
diff --git a/Documentation/CodeSnippets/my_site_package/Resources/Public/Images/logo.svg b/Documentation/CodeSnippets/my_site_package/Resources/Public/Images/logo.svg
new file mode 100644
index 00000000..eab6182d
--- /dev/null
+++ b/Documentation/CodeSnippets/my_site_package/Resources/Public/Images/logo.svg
@@ -0,0 +1 @@
+
diff --git a/Documentation/CodeSnippets/my_site_package/Resources/Public/JavaScript/main.js b/Documentation/CodeSnippets/my_site_package/Resources/Public/JavaScript/main.js
new file mode 100644
index 00000000..a5e49024
--- /dev/null
+++ b/Documentation/CodeSnippets/my_site_package/Resources/Public/JavaScript/main.js
@@ -0,0 +1 @@
+console.log('WE LOVE TYPO3');
diff --git a/Documentation/CodeSnippets/my_site_package/composer.json b/Documentation/CodeSnippets/my_site_package/composer.json
new file mode 100644
index 00000000..e427bd21
--- /dev/null
+++ b/Documentation/CodeSnippets/my_site_package/composer.json
@@ -0,0 +1,26 @@
+{
+ "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",
+ "license": ["GPL-2.0-or-later"],
+ "keywords": ["TYPO3 CMS"],
+ "require": {
+ "typo3/cms-core": "^13.4",
+ "typo3/cms-rte-ckeditor": "^13.4",
+ "typo3/cms-fluid-styled-content": "^13.4"
+ },
+ "suggest": {
+ "friendsoftypo3/content-blocks": "Allows to create custom content elements. "
+ },
+ "autoload": {
+ "psr-4": {
+ "MyVendor\\MySitePackage\\": "Classes/"
+ }
+ },
+ "extra": {
+ "typo3/cms": {
+ "extension-key": "my_site_package"
+ }
+ }
+}
diff --git a/Documentation/CodeSnippets/my_site_package/ext_emconf.php b/Documentation/CodeSnippets/my_site_package/ext_emconf.php
new file mode 100644
index 00000000..6e50bad5
--- /dev/null
+++ b/Documentation/CodeSnippets/my_site_package/ext_emconf.php
@@ -0,0 +1,29 @@
+ 'My Site Package',
+ 'description' => 'Site package to follow the tutorial.',
+ 'category' => 'templates',
+ 'constraints' => [
+ 'depends' => [
+ 'typo3' => '13.4.0-13.4.99',
+ 'fluid_styled_content' => '13.4.0-13.4.99',
+ 'rte_ckeditor' => '13.4.0-13.4.99',
+ ],
+ 'conflicts' => [
+ ],
+ ],
+ 'autoload' => [
+ 'psr-4' => [
+ 'MyVendor\\MySitePackage\\' => 'Classes',
+ ],
+ ],
+ 'state' => 'stable',
+ 'uploadfolder' => 0,
+ 'createDirs' => '',
+ 'clearCacheOnLoad' => 1,
+ 'author' => 'J. Doe',
+ 'author_email' => 'j.doe@example.org',
+ 'author_company' => 'My Vendor',
+ 'version' => '1.0.0',
+];
diff --git a/Documentation/ContentElementRendering/Index.rst b/Documentation/ContentElementRendering/Index.rst
index 2db55c52..501ecd99 100644
--- a/Documentation/ContentElementRendering/Index.rst
+++ b/Documentation/ContentElementRendering/Index.rst
@@ -48,9 +48,9 @@ Clipboard instead, then save it to the following file:
styles:
templates:
- templateRootPath: 'EXT:site_package/Resources/Private/ContentElements/Templates'
- partialRootPath: 'EXT:site_package/Resources/Private/ContentElements/Partials'
- layoutRootPath: 'EXT:site_package/Resources/Private/ContentElements/Layouts'
+ templateRootPath: 'EXT:my_site_package/Resources/Private/ContentElements/Templates'
+ partialRootPath: 'EXT:my_site_package/Resources/Private/ContentElements/Partials'
+ layoutRootPath: 'EXT:my_site_package/Resources/Private/ContentElements/Layouts'
Then close the settings editor without saving. You can now start overriding the
templates:
@@ -85,7 +85,9 @@ into folder :path:`packages/my_site_package/Resources/Private/ContentElements/Te
Edit the file to add some classes as used in menus in Bootstrap, for example
like this:
-.. include:: /CodeSnippets/Fluid/MenuSubpages.rst.txt
+.. literalinclude:: /CodeSnippets/my_site_package/Resources/Private/ContentElements/Templates/MenuSubpages.html
+ :caption: packages/my_site_package/Resources/Private/ContentElements/Templates/MenuSubpages.html
+ :linenos:
In most parts the changes we made are pretty straight forward. In line 9
we use the `Fluid inline notation `_
@@ -102,7 +104,9 @@ In a similar fashion we now copy and adjust the template for the sitemap from
into folder :path:`packages/site_package/Resources/Private/ContentElements/Templates/MenuSitemap.html`
and then adjust it:
-.. include:: /CodeSnippets/Fluid/MenuSitemap.rst.txt
+.. literalinclude:: /CodeSnippets/my_site_package/Resources/Private/ContentElements/Templates/MenuSitemap.html
+ :caption: packages/my_site_package/Resources/Private/ContentElements/Templates/MenuSitemap.html
+ :linenos:
We want to adjust the HTML output of the sitemap for different levels. The
original template however gives us no means to output the level.
@@ -154,4 +158,6 @@ By overriding this one partial we can add a class to all images that are
displayed with the "Image" or "Text with Media" content elements. For example
we could display all images as circles by adding the class `rounded-circle`:
-.. include:: /CodeSnippets/Fluid/Image.rst.txt
+.. literalinclude:: /CodeSnippets/my_site_package/Resources/Private/ContentElements/Partials/Media/Rendering/Image.html
+ :caption: packages/my_site_package/Resources/Private/ContentElements/Partials/Media/Rendering/Image.html
+ :linenos:
diff --git a/Documentation/ContentMapping/AddContent.rst b/Documentation/ContentMapping/AddContent.rst
index 14fe293a..b23a4cff 100644
--- a/Documentation/ContentMapping/AddContent.rst
+++ b/Documentation/ContentMapping/AddContent.rst
@@ -17,29 +17,57 @@ You can add additonal content in the backend. Go to
in the column labelled "*Main*" and choose the "Regular Text
Element" content element.
-.. include:: /ContentMapping/_images/AddNewContentElement.rst.txt
+.. figure:: /Images/ContentMapping/AddNewContentElement.png
+ :class: with-shadow
+ :alt: Create new content element
-.. include:: /ContentMapping/_images/ChooseRegularTextElement.rst.txt
+ Create new content element
+
+.. figure:: /Images/ContentMapping/ChooseRegularTextElement.png
+ :class: with-shadow
+ :alt: Choose "Regular Text Element"
+
+ Choose "Regular Text Element"
Enter a headline and some arbitrary text in the Rich Text Editor (RTE).
-.. include:: /ContentMapping/_images/EditRegularTextElement1.rst.txt
+.. figure:: /Images/ContentMapping/EditRegularTextElement1.png
+ :class: with-shadow
+ :alt: Enter a headline
+
+ Enter a headline
+
+.. figure:: /Images/ContentMapping/EditRegularTextElement2.png
+ :class: with-shadow
+ :alt: Enter some arbitrary text in the Rich Text Editor (RTE)
-.. include:: /ContentMapping/_images/EditRegularTextElement2.rst.txt
+ Enter some arbitrary text in the Rich Text Editor (RTE)
Save your changes by clicking button :guilabel:`Save` at the top.
You can return to the previous view by clicking :guilabel:`Close`.
-.. include:: /ContentMapping/_images/SaveAndCloseRegularTextElement.rst.txt
+.. figure:: /Images/ContentMapping/SaveAndCloseRegularTextElement.png
+ :class: with-shadow
+ :alt: Save and close the new content element
+
+ Save and close the new content element
:ref:`Preview the page ` by clicking button
:guilabel:`View webpage`.
-.. include:: /ContentMapping/_images/PreviewPageButton.rst.txt
+.. figure:: /Images/ContentMapping/PreviewPageButton.png
+ :class: with-shadow
+ :alt: View webpage button
+
+ View webpage button
Check that the content is displayed as expected.
-.. include:: /ContentMapping/_images/VerifyPageContent.rst.txt
+.. figure:: /Images/ContentMapping/VerifyPageContent.png
+ :class: with-shadow
+ :alt: Verify if your new content is displayed on the page
+
+ Verify if your new content is displayed on the page
Whenever you edit the content elements on
a page the cache of the current page is automatically deleted. If the content
diff --git a/Documentation/ContentMapping/Index.rst b/Documentation/ContentMapping/Index.rst
index c8aa7dfe..b8c85b3c 100644
--- a/Documentation/ContentMapping/Index.rst
+++ b/Documentation/ContentMapping/Index.rst
@@ -31,8 +31,8 @@ display the content in the next steps.
Your site set configuration should now look like this:
-.. literalinclude:: /CodeSnippets/ExtensionConfiguration/SitePackage-config.yaml
- :caption: EXT:my_site_package/Configuration/Sets/SitePackage/config.yaml
+.. literalinclude:: /CodeSnippets/my_site_package/Configuration/Sets/SitePackage/config.yaml
+ :caption: packages/my_site_package/Configuration/Sets/SitePackage/config.yaml
:language: yaml
:linenos:
@@ -52,7 +52,9 @@ By placing the file within the site set, you created in step
:ref:`Create a basic site set `, the
newly created file is loaded within the page tree of your site automatically:
-.. include:: /CodeSnippets/PageLayout/page.rst.txt
+.. literalinclude:: /CodeSnippets/my_site_package/Configuration/Sets/SitePackage/page.tsconfig
+ :caption: packages/my_site_package/Configuration/Sets/SitePackage/page.tsconfig
+ :linenos:
This file automatically includes all `.tsconfig` files from the designated folder
in which we will store the page layouts.
@@ -62,7 +64,7 @@ one for the stage.
.. literalinclude:: _codesnippets/_Default.tsconfig
:language: typoscript
- :caption: EXT:my_site_package/Configuration/TsConfig/Page/PageLayout/Default.tsconfig
+ :caption: packages/my_site_package/Configuration/TsConfig/Page/PageLayout/Default.tsconfig
:linenos:
.. versionchanged:: TYPO3 13
@@ -77,12 +79,18 @@ one for the stage.
When you make changes to the files of an extension it is usually necessary
to flush all caches by hitting the button.
-.. include:: /Images/AutomaticScreenshots/FlushAllCaches.rst.txt
+.. figure:: /Images/AutomaticScreenshots/FlushAllCaches.png
+ :class: with-shadow
+
+ Flush all caches
After flushing the all caches the new backend layout is available in the page
properties at :guilabel:` Appearance > Page Layout > Backend Layout`.
-.. include:: /Images/AutomaticScreenshots/ChooseBackendLayout.rst.txt
+.. figure:: /Images/AutomaticScreenshots/ChooseBackendLayout.png
+ :class: with-shadow
+
+ Choose the backend layout
.. _choose_page_layout:
@@ -97,7 +105,10 @@ If you followed step
:ref:`Load the example data automatically `
the areas "Stage" and "Main" should already contain some example content.
-.. include:: /Images/AutomaticScreenshots/CreateNewContentElement.rst.txt
+.. figure:: /Images/AutomaticScreenshots/CreateNewContentElement.png
+ :class: with-shadow
+
+ Create new content element
In the database each content element record is stored in the table
:sql:`tt_content`. This table has a column called `colPos`. If the value stored
@@ -202,7 +213,9 @@ the partial:
The partial then looks like this:
-.. include:: /CodeSnippets/Fluid/PartialContent.rst.txt
+.. literalinclude:: /CodeSnippets/my_site_package/Resources/Private/PageView/Partials/Content.html
+ :caption: packages/my_site_package/Resources/Private/PageView/Partials/Content.html
+ :linenos:
.. _content-element-typoscript:
diff --git a/Documentation/ContentMapping/Stage.rst b/Documentation/ContentMapping/Stage.rst
index 6772be54..f5295e96 100644
--- a/Documentation/ContentMapping/Stage.rst
+++ b/Documentation/ContentMapping/Stage.rst
@@ -50,4 +50,6 @@ The content elements will be automatically found and provided to your template.
Therefore the template for the area "Stage" looks no different from the one
for the main area except that is uses the corresponding variable of course:
-.. include:: /CodeSnippets/Fluid/Stage.rst.txt
+.. literalinclude:: /CodeSnippets/my_site_package/Resources/Private/PageView/Partials/Stage.html
+ :caption: packages/my_site_package/Resources/Private/PageView/Partials/Stage.html
+ :linenos:
diff --git a/Documentation/ContentMapping/SubpageLayout.rst b/Documentation/ContentMapping/SubpageLayout.rst
index bd10eaec..6c8698d3 100644
--- a/Documentation/ContentMapping/SubpageLayout.rst
+++ b/Documentation/ContentMapping/SubpageLayout.rst
@@ -29,9 +29,9 @@ We now create a subpage layout with two columns and a row for the stage in a
new file :file:`packages/my-site-package/Configuration/TsConfig/Page/PageLayout/Subpage.tsconfig`
containing :ref:`page TSconfig `. :
-.. literalinclude:: /CodeSnippets/PageLayout/_Subpage.tsconfig
+.. literalinclude:: /CodeSnippets/my_site_package/Configuration/Sets/SitePackage/PageTsConfig/BackendLayouts/subpage.tsconfig
:language: typoscript
- :caption: packages/my-site-package/Configuration/TsConfig/Page/PageLayout/Subpage.tsconfig
+ :caption: packages/my_site_package/Configuration/Sets/SitePackage/PageTsConfig/BackendLayouts/subpage.tsconfig
:linenos:
.. _cm-switch_backend_layout:
@@ -44,7 +44,11 @@ at :guilabel:` Appearance > Page Layout > Backend Layout`.
Edit the page properties of `Start page` to use the backend layout
"Two Columns" for subpages.
-.. include:: _images/SwitchBackendLayoutForSubpages.rst.txt
+.. figure:: /Images/ContentMapping/SwitchBackendLayoutForSubpages.png
+ :class: with-shadow
+ :alt: Switch to the Backend Layout "Two Columns" for subpages
+
+ Switch to the Backend Layout "Two Columns" for subpages
After saving you will be able to see on "Page 1" that the content of the columns "main" and
"stage" remains unchanged while there is a third column "sidebar".
@@ -54,8 +58,18 @@ use the same colPos number for these columns.
The pages generated in step Create initial pages already contain
"Menu of subpages" an example content in "sidebar" column.
-.. include:: _images/BackendLayoutTwoColumns.rst.txt
+.. figure:: /Images/ContentMapping/BackendLayoutTwoColumns.png
+ :class: with-shadow
+ :alt: A new column "Sidebar" appears
+
+ A new column "Sidebar" appears
+
Preview the page once more. A sidebar will appear in the frontend:
-.. include:: _images/TwoColumnsPreviewPage.rst.txt
+.. figure:: /Images/ContentMapping/TwoColumnsPreviewPage.png
+ :class: with-shadow
+ :alt: The sidebar appears in the frontend
+
+ The sidebar appears in the frontend
+
diff --git a/Documentation/ContentMapping/TypoScript.rst b/Documentation/ContentMapping/TypoScript.rst
index 9af31d73..4a3d5c0d 100644
--- a/Documentation/ContentMapping/TypoScript.rst
+++ b/Documentation/ContentMapping/TypoScript.rst
@@ -29,7 +29,7 @@ Familiarize yourself with the TypoScript `@import` syntax first:
Import the TypoScript from a different location
===============================================
-Create a new folder called :path:`Configuration/Sets/MySet/TypoScript`. In this
+Create a new folder called :path:`Configuration/Sets/SitePackage/TypoScript`. In this
create a file called :file:`page.typoscript` and copy the content from
file :file:`Configuration/Sets/SitePackage/setup.typoscript`
into it.
@@ -52,7 +52,9 @@ We will create more TypoScript files in the next steps. We could import them
file by file. But as the order will not matter we can import all of them via
wildcard:
-.. include:: /CodeSnippets/TypoScript/Setup.rst.txt
+.. literalinclude:: /CodeSnippets/my_site_package/Configuration/Sets/SitePackage/setup.typoscript
+ :caption: packages/my_site_package/Configuration/Sets/SitePackage/setup.typoscript
+ :linenos:
Only files from the folder directly will be imported. If you create subfolders
later on you have to import them separately.
@@ -68,7 +70,7 @@ Your :path:`Configuration` directory should now have the following structure:
:level: 4
:show-file-icons: true
- * EXT:my_sitepackage/Configuration
+ * packages/my_site_package/Configuration
* Sets
diff --git a/Documentation/ContentMapping/_images/AddNewContentElement.rst.txt b/Documentation/ContentMapping/_images/AddNewContentElement.rst.txt
deleted file mode 100644
index babbd2ee..00000000
--- a/Documentation/ContentMapping/_images/AddNewContentElement.rst.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-.. figure:: /ContentMapping/_images/AddNewContentElement.png
- :class: with-shadow
- :caption: Create new content element
-
- Create new content element
diff --git a/Documentation/ContentMapping/_images/BackendLayoutTwoColumns.rst.txt b/Documentation/ContentMapping/_images/BackendLayoutTwoColumns.rst.txt
deleted file mode 100644
index 9b5ed71c..00000000
--- a/Documentation/ContentMapping/_images/BackendLayoutTwoColumns.rst.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-.. figure:: /ContentMapping/_images/BackendLayoutTwoColumns.png
- :class: with-shadow
- :caption: A new column "Sidebar" appears
-
- A new column "Sidebar" appears
diff --git a/Documentation/ContentMapping/_images/ChooseRegularTextElement.rst.txt b/Documentation/ContentMapping/_images/ChooseRegularTextElement.rst.txt
deleted file mode 100644
index a0f9849c..00000000
--- a/Documentation/ContentMapping/_images/ChooseRegularTextElement.rst.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-.. figure:: /ContentMapping/_images/ChooseRegularTextElement.png
- :class: with-shadow
- :caption: Choose "Regular Text Element"
-
- Choose "Regular Text Element"
diff --git a/Documentation/ContentMapping/_images/EditRegularTextElement1.rst.txt b/Documentation/ContentMapping/_images/EditRegularTextElement1.rst.txt
deleted file mode 100644
index 931a4adb..00000000
--- a/Documentation/ContentMapping/_images/EditRegularTextElement1.rst.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-.. figure:: /ContentMapping/_images/EditRegularTextElement1.png
- :class: with-shadow
- :caption: Enter a headline
-
- Enter a headline
diff --git a/Documentation/ContentMapping/_images/EditRegularTextElement2.rst.txt b/Documentation/ContentMapping/_images/EditRegularTextElement2.rst.txt
deleted file mode 100644
index 4d452d80..00000000
--- a/Documentation/ContentMapping/_images/EditRegularTextElement2.rst.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-.. figure:: /ContentMapping/_images/EditRegularTextElement2.png
- :class: with-shadow
- :caption: Enter some arbitrary text in the Rich Text Editor (RTE)
-
- Enter some arbitrary text in the Rich Text Editor (RTE)
diff --git a/Documentation/ContentMapping/_images/PreviewPageButton.rst.txt b/Documentation/ContentMapping/_images/PreviewPageButton.rst.txt
deleted file mode 100644
index 50c5c7d7..00000000
--- a/Documentation/ContentMapping/_images/PreviewPageButton.rst.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-.. figure:: /ContentMapping/_images/PreviewPageButton.png
- :class: with-shadow
- :caption: View webpage button
-
- View webpage button
diff --git a/Documentation/ContentMapping/_images/SaveAndCloseRegularTextElement.rst.txt b/Documentation/ContentMapping/_images/SaveAndCloseRegularTextElement.rst.txt
deleted file mode 100644
index 880750e1..00000000
--- a/Documentation/ContentMapping/_images/SaveAndCloseRegularTextElement.rst.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-.. figure:: /ContentMapping/_images/SaveAndCloseRegularTextElement.png
- :class: with-shadow
- :caption: Save and close the new content element
-
- Save and close the new content element
diff --git a/Documentation/ContentMapping/_images/SwitchBackendLayoutForSubpages.rst.txt b/Documentation/ContentMapping/_images/SwitchBackendLayoutForSubpages.rst.txt
deleted file mode 100644
index 27d4e25f..00000000
--- a/Documentation/ContentMapping/_images/SwitchBackendLayoutForSubpages.rst.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-.. figure:: /ContentMapping/_images/SwitchBackendLayoutForSubpages.png
- :class: with-shadow
- :caption: Switch to the Backend Layout "Two Columns" for subpages
-
- Switch to the Backend Layout "Two Columns" for subpages
diff --git a/Documentation/ContentMapping/_images/TwoColumnsPreviewPage.rst.txt b/Documentation/ContentMapping/_images/TwoColumnsPreviewPage.rst.txt
deleted file mode 100644
index 63f11ef7..00000000
--- a/Documentation/ContentMapping/_images/TwoColumnsPreviewPage.rst.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-.. figure:: /ContentMapping/_images/TwoColumnsPreviewPage.png
- :class: with-shadow
- :caption: The sidebar appears in the frontend
-
- The sidebar appears in the frontend
diff --git a/Documentation/ContentMapping/_images/VerifyPageContent.rst.txt b/Documentation/ContentMapping/_images/VerifyPageContent.rst.txt
deleted file mode 100644
index 8996fc35..00000000
--- a/Documentation/ContentMapping/_images/VerifyPageContent.rst.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-.. figure:: /ContentMapping/_images/VerifyPageContent.png
- :class: with-shadow
- :caption: Verify if your new content is displayed on the page
-
- Verify if your new content is displayed on the page
diff --git a/Documentation/FluidTemplates/Index.rst b/Documentation/FluidTemplates/Index.rst
index 5090d9e8..64b4709f 100644
--- a/Documentation/FluidTemplates/Index.rst
+++ b/Documentation/FluidTemplates/Index.rst
@@ -151,7 +151,7 @@ You should now have the following files:
:level: 3
:show-file-icons: true
- * EXT:my_site_package/Resources/Private/PageView
+ * packages/my_site_package/Resources/Private/PageView
* Pages
@@ -182,7 +182,7 @@ the partial :file:`Resources/Private/PageView/Partials/Header.html` to its
own partial, :file:`Resources/Private/PageView/Partials/Navigation/Menu.html`:
.. literalinclude:: _codesnippets/_remove_menu_from_header.diff
- :caption: EXT:my_site_package/Resources/Private/PageView/Partials/Header.html (Difference)
+ :caption: packages/my_site_package/Resources/Private/PageView/Partials/Header.html (Difference)
The :ref:`Render ViewHelper ` is used
the same like from within the template.
@@ -200,7 +200,7 @@ the partial :file:`Resources/Private/PageView/Partials/Footer.html` to its
own partial, :file:`Resources/Private/PageView/Partials/Navigation/FooterMenu.html`:
.. literalinclude:: _codesnippets/_remove_menu_from_footer.diff
- :caption: EXT:my_site_package/Resources/Private/PageView/Partials/Footer.html (Difference)
+ :caption: packages/my_site_package/Resources/Private/PageView/Partials/Footer.html (Difference)
The footer menu partial looks like this:
@@ -272,7 +272,9 @@ Save the extracted layout to a file called
:file:`Resources/Private/PageView/Layouts/Layout.html`. This file now contains
the following:
-.. include:: /CodeSnippets/Fluid/Layout.rst.txt
+.. literalinclude:: /CodeSnippets/my_site_package/Resources/Private/PageView/Layouts/PageLayout.html
+ :caption: packages/my_site_package/Resources/Private/PageView/Layouts/PageLayout.html
+ :linenos:
Repeat the same for file :file:`Resources/Private/PageView/Pages/Default.html`.
@@ -280,7 +282,7 @@ Repeat the same for file :file:`Resources/Private/PageView/Pages/Default.html`.
:level: 3
:show-file-icons: true
- * EXT:my_sitepackage/Resources/Private/PageView
+ * packages/my_site_package/Resources/Private/PageView
* Layouts
diff --git a/Documentation/Images/AutomaticScreenshots/BackendLayoutTwoColumns.png b/Documentation/Images/AutomaticScreenshots/BackendLayoutTwoColumns.png
deleted file mode 100644
index 65f7938c..00000000
Binary files a/Documentation/Images/AutomaticScreenshots/BackendLayoutTwoColumns.png and /dev/null differ
diff --git a/Documentation/Images/AutomaticScreenshots/BackendLayoutTwoColumns.rst.txt b/Documentation/Images/AutomaticScreenshots/BackendLayoutTwoColumns.rst.txt
deleted file mode 100644
index f63f93eb..00000000
--- a/Documentation/Images/AutomaticScreenshots/BackendLayoutTwoColumns.rst.txt
+++ /dev/null
@@ -1,6 +0,0 @@
-.. Automatic screenshot: Remove this line if you want to manually change this file
-
-.. figure:: /Images/AutomaticScreenshots/BackendLayoutTwoColumns.png
- :class: with-shadow
-
- A new column "Sidebar" appears
diff --git a/Documentation/Images/AutomaticScreenshots/ChooseBackendLayout.rst.txt b/Documentation/Images/AutomaticScreenshots/ChooseBackendLayout.rst.txt
deleted file mode 100644
index 96a5d56f..00000000
--- a/Documentation/Images/AutomaticScreenshots/ChooseBackendLayout.rst.txt
+++ /dev/null
@@ -1,4 +0,0 @@
-.. figure:: /Images/AutomaticScreenshots/ChooseBackendLayout.png
- :class: with-shadow
-
- Choose the backend layout
diff --git a/Documentation/Images/AutomaticScreenshots/CreateNewContentElement.rst.txt b/Documentation/Images/AutomaticScreenshots/CreateNewContentElement.rst.txt
deleted file mode 100644
index f9e385c7..00000000
--- a/Documentation/Images/AutomaticScreenshots/CreateNewContentElement.rst.txt
+++ /dev/null
@@ -1,4 +0,0 @@
-.. figure:: /Images/AutomaticScreenshots/CreateNewContentElement.png
- :class: with-shadow
-
- Create new content element
diff --git a/Documentation/Images/AutomaticScreenshots/CreateSiteConfig1.png b/Documentation/Images/AutomaticScreenshots/CreateSiteConfig1.png
deleted file mode 100644
index 73721738..00000000
Binary files a/Documentation/Images/AutomaticScreenshots/CreateSiteConfig1.png and /dev/null differ
diff --git a/Documentation/Images/AutomaticScreenshots/CreateSiteConfig1.rst.txt b/Documentation/Images/AutomaticScreenshots/CreateSiteConfig1.rst.txt
deleted file mode 100644
index 593b6434..00000000
--- a/Documentation/Images/AutomaticScreenshots/CreateSiteConfig1.rst.txt
+++ /dev/null
@@ -1,6 +0,0 @@
-.. Automatic screenshot: Remove this line if you want to manually change this file
-
-.. figure:: /Images/AutomaticScreenshots/CreateSiteConfig1.png
- :class: with-shadow
-
- Create the site configuration
\ No newline at end of file
diff --git a/Documentation/Images/AutomaticScreenshots/CreateSiteConfig2.png b/Documentation/Images/AutomaticScreenshots/CreateSiteConfig2.png
deleted file mode 100644
index 3394b5cd..00000000
Binary files a/Documentation/Images/AutomaticScreenshots/CreateSiteConfig2.png and /dev/null differ
diff --git a/Documentation/Images/AutomaticScreenshots/CreateSiteConfig2.rst.txt b/Documentation/Images/AutomaticScreenshots/CreateSiteConfig2.rst.txt
deleted file mode 100644
index 63161560..00000000
--- a/Documentation/Images/AutomaticScreenshots/CreateSiteConfig2.rst.txt
+++ /dev/null
@@ -1,6 +0,0 @@
-.. Automatic screenshot: Remove this line if you want to manually change this file
-
-.. figure:: /Images/AutomaticScreenshots/CreateSiteConfig2.png
- :class: with-shadow
-
- Create the site configuration
\ No newline at end of file
diff --git a/Documentation/Images/AutomaticScreenshots/EditTemplateRecord.png b/Documentation/Images/AutomaticScreenshots/EditTemplateRecord.png
deleted file mode 100644
index 4a98fe79..00000000
Binary files a/Documentation/Images/AutomaticScreenshots/EditTemplateRecord.png and /dev/null differ
diff --git a/Documentation/Images/AutomaticScreenshots/EditTemplateRecord.rst.txt b/Documentation/Images/AutomaticScreenshots/EditTemplateRecord.rst.txt
deleted file mode 100644
index 88276efc..00000000
--- a/Documentation/Images/AutomaticScreenshots/EditTemplateRecord.rst.txt
+++ /dev/null
@@ -1,6 +0,0 @@
-.. Automatic screenshot: Remove this line if you want to manually change this file
-
-.. figure:: /Images/AutomaticScreenshots/EditTemplateRecord.png
- :class: with-shadow
-
- Edit the whole template record
\ No newline at end of file
diff --git a/Documentation/Images/AutomaticScreenshots/FillNewContentElement.png b/Documentation/Images/AutomaticScreenshots/FillNewContentElement.png
deleted file mode 100644
index f72cb284..00000000
Binary files a/Documentation/Images/AutomaticScreenshots/FillNewContentElement.png and /dev/null differ
diff --git a/Documentation/Images/AutomaticScreenshots/FillNewContentElement.rst.txt b/Documentation/Images/AutomaticScreenshots/FillNewContentElement.rst.txt
deleted file mode 100644
index df91ef2b..00000000
--- a/Documentation/Images/AutomaticScreenshots/FillNewContentElement.rst.txt
+++ /dev/null
@@ -1,6 +0,0 @@
-.. Automatic screenshot: Remove this line if you want to manually change this file
-
-.. figure:: /Images/AutomaticScreenshots/FillNewContentElement.png
- :class: with-shadow
-
- Fill some content in the new content element
\ No newline at end of file
diff --git a/Documentation/Images/AutomaticScreenshots/FilledColumns.png b/Documentation/Images/AutomaticScreenshots/FilledColumns.png
deleted file mode 100644
index 31f1019a..00000000
Binary files a/Documentation/Images/AutomaticScreenshots/FilledColumns.png and /dev/null differ
diff --git a/Documentation/Images/AutomaticScreenshots/FilledColumns.rst.txt b/Documentation/Images/AutomaticScreenshots/FilledColumns.rst.txt
deleted file mode 100644
index f63bab68..00000000
--- a/Documentation/Images/AutomaticScreenshots/FilledColumns.rst.txt
+++ /dev/null
@@ -1,6 +0,0 @@
-.. Automatic screenshot: Remove this line if you want to manually change this file
-
-.. figure:: /Images/AutomaticScreenshots/FilledColumns.png
- :class: with-shadow
-
- The columns with their Content
\ No newline at end of file
diff --git a/Documentation/Images/AutomaticScreenshots/FlushAllCaches.rst.txt b/Documentation/Images/AutomaticScreenshots/FlushAllCaches.rst.txt
deleted file mode 100644
index d2e6dd49..00000000
--- a/Documentation/Images/AutomaticScreenshots/FlushAllCaches.rst.txt
+++ /dev/null
@@ -1,4 +0,0 @@
-.. figure:: /Images/AutomaticScreenshots/FlushAllCaches.png
- :class: with-shadow
-
- Flush all caches
diff --git a/Documentation/Images/AutomaticScreenshots/FlushFrontendCaches.rst.txt b/Documentation/Images/AutomaticScreenshots/FlushFrontendCaches.rst.txt
deleted file mode 100644
index a56ffe7e..00000000
--- a/Documentation/Images/AutomaticScreenshots/FlushFrontendCaches.rst.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-
-.. figure:: /Images/AutomaticScreenshots/FlushFrontendCaches.png
- :class: with-shadow
-
- Flush the frontend cache after changing template files
diff --git a/Documentation/Images/AutomaticScreenshots/IncludeTsConfig.png b/Documentation/Images/AutomaticScreenshots/IncludeTsConfig.png
deleted file mode 100644
index 1a2e3dad..00000000
Binary files a/Documentation/Images/AutomaticScreenshots/IncludeTsConfig.png and /dev/null differ
diff --git a/Documentation/Images/AutomaticScreenshots/IncludeTsConfig.rst.txt b/Documentation/Images/AutomaticScreenshots/IncludeTsConfig.rst.txt
deleted file mode 100644
index f796f264..00000000
--- a/Documentation/Images/AutomaticScreenshots/IncludeTsConfig.rst.txt
+++ /dev/null
@@ -1,6 +0,0 @@
-.. Automatic screenshot: Remove this line if you want to manually change this file
-
-.. figure:: /Images/AutomaticScreenshots/IncludeTsConfig.png
- :class: with-shadow
-
- Include the site package page TsConfig
\ No newline at end of file
diff --git a/Documentation/Images/AutomaticScreenshots/IncludeTypoScriptTemplate.png b/Documentation/Images/AutomaticScreenshots/IncludeTypoScriptTemplate.png
deleted file mode 100644
index b7ef889d..00000000
Binary files a/Documentation/Images/AutomaticScreenshots/IncludeTypoScriptTemplate.png and /dev/null differ
diff --git a/Documentation/Images/AutomaticScreenshots/IncludeTypoScriptTemplate.rst.txt b/Documentation/Images/AutomaticScreenshots/IncludeTypoScriptTemplate.rst.txt
deleted file mode 100644
index 28fa5886..00000000
--- a/Documentation/Images/AutomaticScreenshots/IncludeTypoScriptTemplate.rst.txt
+++ /dev/null
@@ -1,6 +0,0 @@
-.. Automatic screenshot: Remove this line if you want to manually change this file
-
-.. figure:: /Images/AutomaticScreenshots/IncludeTypoScriptTemplate.png
- :class: with-shadow
-
- Include the site package TypoScript template
\ No newline at end of file
diff --git a/Documentation/Images/AutomaticScreenshots/SwitchBackendLayout.png b/Documentation/Images/AutomaticScreenshots/SwitchBackendLayout.png
deleted file mode 100644
index 509feea9..00000000
Binary files a/Documentation/Images/AutomaticScreenshots/SwitchBackendLayout.png and /dev/null differ
diff --git a/Documentation/Images/AutomaticScreenshots/SwitchBackendLayout.rst.txt b/Documentation/Images/AutomaticScreenshots/SwitchBackendLayout.rst.txt
deleted file mode 100644
index 9f62d7f6..00000000
--- a/Documentation/Images/AutomaticScreenshots/SwitchBackendLayout.rst.txt
+++ /dev/null
@@ -1,6 +0,0 @@
-.. Automatic screenshot: Remove this line if you want to manually change this file
-
-.. figure:: /Images/AutomaticScreenshots/SwitchBackendLayout.png
- :class: with-shadow
-
- Switch to the Backend Layout "Two Columns"
\ No newline at end of file
diff --git a/Documentation/Images/AutomaticScreenshots/TwoColumnsPreviewPage.png b/Documentation/Images/AutomaticScreenshots/TwoColumnsPreviewPage.png
deleted file mode 100644
index c50b47d2..00000000
Binary files a/Documentation/Images/AutomaticScreenshots/TwoColumnsPreviewPage.png and /dev/null differ
diff --git a/Documentation/Images/AutomaticScreenshots/TwoColumnsPreviewPage.rst.txt b/Documentation/Images/AutomaticScreenshots/TwoColumnsPreviewPage.rst.txt
deleted file mode 100644
index 009b46ac..00000000
--- a/Documentation/Images/AutomaticScreenshots/TwoColumnsPreviewPage.rst.txt
+++ /dev/null
@@ -1,6 +0,0 @@
-.. Automatic screenshot: Remove this line if you want to manually change this file
-
-.. figure:: /Images/AutomaticScreenshots/TwoColumnsPreviewPage.png
- :class: with-shadow
-
- The sidebar appears in the frontend
\ No newline at end of file
diff --git a/Documentation/ContentMapping/_images/AddNewContentElement.png b/Documentation/Images/ContentMapping/AddNewContentElement.png
similarity index 100%
rename from Documentation/ContentMapping/_images/AddNewContentElement.png
rename to Documentation/Images/ContentMapping/AddNewContentElement.png
diff --git a/Documentation/ContentMapping/_images/BackendLayoutTwoColumns.png b/Documentation/Images/ContentMapping/BackendLayoutTwoColumns.png
similarity index 100%
rename from Documentation/ContentMapping/_images/BackendLayoutTwoColumns.png
rename to Documentation/Images/ContentMapping/BackendLayoutTwoColumns.png
diff --git a/Documentation/ContentMapping/_images/ChooseRegularTextElement.png b/Documentation/Images/ContentMapping/ChooseRegularTextElement.png
similarity index 100%
rename from Documentation/ContentMapping/_images/ChooseRegularTextElement.png
rename to Documentation/Images/ContentMapping/ChooseRegularTextElement.png
diff --git a/Documentation/ContentMapping/_images/EditRegularTextElement1.png b/Documentation/Images/ContentMapping/EditRegularTextElement1.png
similarity index 100%
rename from Documentation/ContentMapping/_images/EditRegularTextElement1.png
rename to Documentation/Images/ContentMapping/EditRegularTextElement1.png
diff --git a/Documentation/ContentMapping/_images/EditRegularTextElement2.png b/Documentation/Images/ContentMapping/EditRegularTextElement2.png
similarity index 100%
rename from Documentation/ContentMapping/_images/EditRegularTextElement2.png
rename to Documentation/Images/ContentMapping/EditRegularTextElement2.png
diff --git a/Documentation/ContentMapping/_images/PreviewPageButton.png b/Documentation/Images/ContentMapping/PreviewPageButton.png
similarity index 100%
rename from Documentation/ContentMapping/_images/PreviewPageButton.png
rename to Documentation/Images/ContentMapping/PreviewPageButton.png
diff --git a/Documentation/ContentMapping/_images/SaveAndCloseRegularTextElement.png b/Documentation/Images/ContentMapping/SaveAndCloseRegularTextElement.png
similarity index 100%
rename from Documentation/ContentMapping/_images/SaveAndCloseRegularTextElement.png
rename to Documentation/Images/ContentMapping/SaveAndCloseRegularTextElement.png
diff --git a/Documentation/ContentMapping/_images/SwitchBackendLayoutForSubpages.png b/Documentation/Images/ContentMapping/SwitchBackendLayoutForSubpages.png
similarity index 100%
rename from Documentation/ContentMapping/_images/SwitchBackendLayoutForSubpages.png
rename to Documentation/Images/ContentMapping/SwitchBackendLayoutForSubpages.png
diff --git a/Documentation/ContentMapping/_images/TwoColumnsPreviewPage.png b/Documentation/Images/ContentMapping/TwoColumnsPreviewPage.png
similarity index 100%
rename from Documentation/ContentMapping/_images/TwoColumnsPreviewPage.png
rename to Documentation/Images/ContentMapping/TwoColumnsPreviewPage.png
diff --git a/Documentation/ContentMapping/_images/VerifyPageContent.png b/Documentation/Images/ContentMapping/VerifyPageContent.png
similarity index 100%
rename from Documentation/ContentMapping/_images/VerifyPageContent.png
rename to Documentation/Images/ContentMapping/VerifyPageContent.png
diff --git a/Documentation/ContentMapping/_images/contents_debug.png b/Documentation/Images/ContentMapping/contents_debug.png
similarity index 100%
rename from Documentation/ContentMapping/_images/contents_debug.png
rename to Documentation/Images/ContentMapping/contents_debug.png
diff --git a/Documentation/MainMenuCreation/_images/CheckMainMenu.png b/Documentation/Images/MainMenuCreation/CheckMainMenu.png
similarity index 100%
rename from Documentation/MainMenuCreation/_images/CheckMainMenu.png
rename to Documentation/Images/MainMenuCreation/CheckMainMenu.png
diff --git a/Documentation/MainMenuCreation/Index.rst b/Documentation/MainMenuCreation/Index.rst
index e9ca5ab8..95762266 100644
--- a/Documentation/MainMenuCreation/Index.rst
+++ b/Documentation/MainMenuCreation/Index.rst
@@ -25,7 +25,8 @@ provide the data of all pages in your current site to your page template.
We save the TypoScript configuration for the menu into file
:file:`Configuration/Set/SitePackage/TypoScript/Navigation/menu.typoscript`:
-.. include:: /CodeSnippets/TypoScript/menu.rst.txt
+.. literalinclude:: /CodeSnippets/my_site_package/Configuration/Sets/SitePackage/TypoScript/Navigation/menu.typoscript
+ :caption: packages/my_site_package/Configuration/Sets/SitePackage/TypoScript/Navigation/menu.typoscript
.. _fluid-implement-main-menu:
@@ -43,7 +44,9 @@ A menu usually contains several menu entries. We use the
:ref:`t3viewhelper:typo3fluid-fluid-for` to iterate over all menu entries
and render them in turn:
-.. include:: /CodeSnippets/Fluid/Menu.rst.txt
+.. literalinclude:: /CodeSnippets/my_site_package/Resources/Private/PageView/Partials/Navigation/Menu.html
+ :caption: packages/my_site_package/Resources/Private/PageView/Partials/Navigation/Menu.html
+ :linenos:
In each loop the current menu item is stored in variable `{menuItem}`.
@@ -51,7 +54,7 @@ You can use the :ref:`t3viewhelper:typo3-fluid-debug` to debug what kind of
data the variable contains like this:
.. code-block:: diff
- :caption: EXT:site_package/Resources/Private/PageView/Partials/Navigation/Menu.html (changed for debug output)
+ :caption: packages/my_site_package/Resources/Private/PageView/Partials/Navigation/Menu.html (changed for debug output)
@@ -108,12 +111,19 @@ working as expected and if the menu is generated. Go to **WEB → View** and
check, if the menu reflects the pages you created in the backend. Add one or
two additional pages to the page tree and check to see if they appear in the preview.
-.. include:: _images/CheckMainMenu.rst.txt
+.. figure:: /Images/MainMenuCreation/CheckMainMenu.png
+ :alt: Checking from the backend if the menu is generated as expected.
+ :class: with-shadow
+
+ Checking from the backend if the menu is generated as expected.
If the menu does not change, you possibly need to flush the frontend caches,
then reload the preview.
-.. include:: /Images/AutomaticScreenshots/FlushFrontendCaches.rst.txt
+.. figure:: /Images/AutomaticScreenshots/FlushFrontendCaches.png
+ :class: with-shadow
+
+ Flush the frontend cache after changing template files
The preview in the screenshot above shows the menu with three page links: "Page
1", "Page 2" and "Page 3".
diff --git a/Documentation/MainMenuCreation/_images/CheckMainMenu.rst.txt b/Documentation/MainMenuCreation/_images/CheckMainMenu.rst.txt
deleted file mode 100644
index b99ec827..00000000
--- a/Documentation/MainMenuCreation/_images/CheckMainMenu.rst.txt
+++ /dev/null
@@ -1,6 +0,0 @@
-
-.. figure:: /MainMenuCreation/_images/CheckMainMenu.png
- :caption: Checking from the backend if the menu is generated as expected.
- :class: with-shadow
-
- Checking from the backend if the menu is generated as expected.
diff --git a/Documentation/MinimalExample/Index.rst b/Documentation/MinimalExample/Index.rst
index b1b93393..40085473 100644
--- a/Documentation/MinimalExample/Index.rst
+++ b/Documentation/MinimalExample/Index.rst
@@ -57,7 +57,7 @@ needs to be :ref:`installed `:
`my_site_package` is the extension name. For historical reasons all dashes need
to be converted to underscores and the vendor name removed. This name is used
- to reference files, for example `EXT:my_site_package/Resources/Public/Css/my.css`.
+ to reference files, for example `packages/my_site_package/Resources/Public/Css/my.css`.
.. _minimal-b13-make-extension:
@@ -361,7 +361,10 @@ Whenever we have made changes to the Fluid templates or TypoScript files, it is
necessary to :guilabel:`Flush frontend caches` in the menu in the
top bar before you can preview the page properly:
-.. include:: /Images/AutomaticScreenshots/FlushFrontendCaches.rst.txt
+.. figure:: /Images/AutomaticScreenshots/FlushFrontendCaches.png
+ :class: with-shadow
+
+ Flush the frontend cache after changing template files
You can then preview your page by clicking on the button :guilabel:`View webpage`
in the page module.
@@ -374,7 +377,9 @@ Composer configuration :file:`composer.json`
In step :ref:`Create a minimal TYPO3 extension `
a file called :file:`composer.json` was created for you:
-.. include:: /CodeSnippets/ExtensionConfiguration/ComposerJson.rst.txt
+.. literalinclude:: /CodeSnippets/my_site_package/composer.json
+ :caption: packages/my_site_package/composer.json
+ :linenos:
At the top of the :file:`composer.json` file we see the Composer package name
`myvendor/my-site-package` (with a dash) and at the bottom we see the TYPO3
diff --git a/Documentation/SiteSets/Index.rst b/Documentation/SiteSets/Index.rst
index 7c115394..9fabe6ea 100644
--- a/Documentation/SiteSets/Index.rst
+++ b/Documentation/SiteSets/Index.rst
@@ -40,8 +40,8 @@ to the site sets of :composer:`typo3/cms-fluid-styled-content`.
Your site set configuration should now look like this:
-.. literalinclude:: /CodeSnippets/ExtensionConfiguration/SitePackage-config.yaml
- :caption: EXT:my_site_package/Configuration/Sets/SitePackage/config.yaml
+.. literalinclude:: /CodeSnippets/my_site_package/Configuration/Sets/SitePackage/config.yaml
+ :caption: packages/my_site_package/Configuration/Sets/SitePackage/config.yaml
:language: yaml
:linenos:
@@ -78,8 +78,8 @@ We override some default settings of the site set
:ref:`Site set "Fluid Styled
Content" `:
-.. literalinclude:: /CodeSnippets/ExtensionConfiguration/SitePackage-settings.yaml
- :caption: EXT:my_site_package/Configuration/Sets/SitePackage/settings.yaml
+.. literalinclude:: /CodeSnippets/my_site_package/Configuration/Sets/SitePackage/settings.yaml
+ :caption: packages/my_site_package/Configuration/Sets/SitePackage/settings.yaml
:language: yaml
:linenos:
diff --git a/Makefile b/Makefile
index 38c5883c..6063c896 100644
--- a/Makefile
+++ b/Makefile
@@ -5,7 +5,7 @@ help: ## Displays this list of targets with descriptions
.PHONY: codesnippets
codesnippets: ## Regenerate automatic code snippets
- .Build/vendor/bin/typo3 codesnippet:create Documentation/CodeSnippets/
+ ./Build/DownloadSitePackage/generate_sitepackage.sh
.PHONY: docs
docs: ## Generate projects docs (from "Documentation" directory)