From 7e30ec96bd11a822500c5fbdd3f0a3c7fa7a9a3b Mon Sep 17 00:00:00 2001
From: Sandra Erbel <erbel@analog.de>
Date: Wed, 6 Nov 2024 14:29:01 +0100
Subject: [PATCH 1/8] Start glossary
---
Documentation/Glossary/Index.rst | 221 +++++++++++++++++++++++++++++++
Documentation/Index.rst | 8 ++
2 files changed, 229 insertions(+)
create mode 100644 Documentation/Glossary/Index.rst
diff --git a/Documentation/Glossary/Index.rst b/Documentation/Glossary/Index.rst
new file mode 100644
index 00000000..cbfb40c8
--- /dev/null
+++ b/Documentation/Glossary/Index.rst
@@ -0,0 +1,221 @@
+.. include:: /Includes.rst.txt
+
+.. _getting-started-glossary-index:
+
+========
+Glossary
+========
+
+**A**
+
+**Apache**: `Apache httpd <https://en.wikipedia.org/wiki/Apache_HTTP_Server>`__ is one
+of the options you can choose as a web server. Others are Nginx, Microsoft IIS and Caddy Server (`see system requirements <https://get.typo3.org/version/13#system-requirements>`__).
+
+**Admin Tools**:
+
+**Admin User**:
+
+**Assets**:
+
+**Application context**:
+
+**B**
+
+**Backend**:
+
+**Block syntax**: In TypoScript
+
+**Bootstrap**:
+
+**C**
+
+**Class**: In PHP
+
+**Cache**:
+
+**cObject**:
+
+**Character Set**:
+
+**Composer**:
+
+**Compression**: In TypoScript you are able to compress css or js files.
+
+**CMS**:
+
+**Content Security Policy**:
+
+**D**
+
+**Database**:
+
+**Documentation**:
+
+**Docker**:
+
+**DDEV**:
+
+**Deployment**:
+
+**Debug mode**:
+
+**Developer**:
+
+**Dependencies**: In Composer there exist usually dependencies that have to be installed too.
+
+**E**
+
+**Editor**:
+
+**Extension**:
+
+**Extension Configuration**:
+
+**Error page**:
+
+**F**
+
+**Fluid**: Fluid is a PHP template engine and is the de facto standard for any
+HTML-based output in the TYPO3 CMS. See :ref:`Fluid Reference<t3coreapi:fluid>`
+for further details.
+
+**Fileadmin**:
+
+**Filelist**:
+
+**FAL**:
+
+**Frontend**:
+
+**Frontend login**:
+
+**Fluid styled content extension**:
+
+**G**
+
+**Global TYPO3 variables**:
+
+**H**
+
+**I**
+
+**Integrator**:
+
+**Installtool password**:
+
+**J**
+
+**K**
+
+**L**
+
+**Local development**:
+
+**Local extension**:
+
+**LTS**:
+
+**Language file**:
+
+**Layouts**:
+
+**Log Folder**:
+
+**Legacy installation**:
+
+**M**
+
+**N**
+
+**O**
+
+**P**
+
+**Production server**:
+
+**Partial**: A partial is a small or large HTML code snippet that usually can
+be used more often and on multiple spots. Here we
+:ref:`split up the template into partials <t3sitepackage:partials>`.
+
+**Public**:
+
+**Permissions**:
+
+**PHP**:
+
+**Page tree**:
+
+**Q**
+
+**R**
+
+**Resources**:
+
+**Root page**:
+
+**Reference index**:
+
+**S**
+
+**Symlink**:
+
+**Snapshot**:
+
+**Static file**: In the context of templating we say to a html file "static"
+when it does not use Fluid but only plain HTML.
+
+**Site Package**:
+
+**Site Set**:
+
+**Site Configuration**:
+
+**System extension**:
+
+**SEO**:
+
+**System maintainer**:
+
+**T**
+
+**Third-party extension**:
+
+**TCA**:
+
+**Template**: A HTML (Fluid) template is used to output HTML code.
+See also :ref:`Fluid Templates <t3sitepackage:fluid-templates>`. Usually we use
+:ref:`Fluid<t3coreapi:fluid>` and the :ref:`ViewHelpers<t3viewhelper:start>`.
+Get an :ref:`introduction to Fluid templates <t3start:fluid-templates>`.
+
+**Templating**: The templating engine that TYPO3 is using is Fluid.
+
+**TER**:
+
+**TypoScript**: :ref:`TypoScript<t3tsref:start>` is the basic configuration
+language used to configure the frontend output of a page in TYPO3.
+
+**Top-level objects**:
+
+**Testing**:
+
+**TSconfig**:
+
+**U**
+
+**Update**:
+
+**V**
+
+**Vendor folder**:
+
+**Var folder**:
+
+**ViewHelper**:
+
+**W**
+
+**X**
+
+**Y**
+
+**Z**
diff --git a/Documentation/Index.rst b/Documentation/Index.rst
index f6c97342..8c7b0763 100644
--- a/Documentation/Index.rst
+++ b/Documentation/Index.rst
@@ -79,6 +79,13 @@ system and detailed information on how to install TYPO3.
.. card-footer:: :ref:`Learn how to add content and create templates <next-steps>`
:button-style: btn btn-secondary stretched-link
+ .. card:: Glossary
+
+ Here you get an overview of important terms in TYPO3.
+
+ .. card-footer:: :ref:`See the glossary <getting-started-glossary-index>`
+ :button-style: btn btn-secondary stretched-link
+
.. toctree::
:hidden:
:titlesonly:
@@ -90,6 +97,7 @@ system and detailed information on how to install TYPO3.
Troubleshooting/Index
Extensions/Index
NextSteps/Index
+ Glossary/Index
.. toctree::
:hidden:
From e026fc3c06089b13386cd8bd0152ad83219c434c Mon Sep 17 00:00:00 2001
From: Kiebele <mkiebele@w-commerce.de>
Date: Fri, 8 Nov 2024 08:40:43 +0100
Subject: [PATCH 2/8] [FIX] Changed :t3ext: to :composer:
---
Documentation/Glossary/Index.rst | 18 ++++++++++++++----
1 file changed, 14 insertions(+), 4 deletions(-)
diff --git a/Documentation/Glossary/Index.rst b/Documentation/Glossary/Index.rst
index cbfb40c8..5e7c6e6c 100644
--- a/Documentation/Glossary/Index.rst
+++ b/Documentation/Glossary/Index.rst
@@ -11,13 +11,18 @@ Glossary
**Apache**: `Apache httpd <https://en.wikipedia.org/wiki/Apache_HTTP_Server>`__ is one
of the options you can choose as a web server. Others are Nginx, Microsoft IIS and Caddy Server (`see system requirements <https://get.typo3.org/version/13#system-requirements>`__).
-**Admin Tools**:
+**Admin Tools**: Admin tools are a group of backend modules.
+These include maintaining the installation, adjusting settings, executing upgrade wizards,
+checking environment information and setting up extensions.
**Admin User**:
-**Assets**:
+**Assets**: Assets are media resources such as images, videos and documents that are uploaded and managed in the TYPO3 system.
+Also, extensions can include assets which can be referred to in the frontend, like specific icons or JavaScript libraries.
-**Application context**:
+**Application context**: In TYPO3, Application Context specifies the environment
+(e.g., Development, Production) the site is running in, adjusting settings like debugging or
+performance optimization accordingly. This helps tailor TYPO3 behavior for each stage of deployment.
**B**
@@ -31,7 +36,8 @@ of the options you can choose as a web server. Others are Nginx, Microsoft IIS a
**Class**: In PHP
-**Cache**:
+**Cache**: Caches are used to improve website performance by storing frequently
+accessed data. TYPO3 has multiple caches for various performance relevant areas in both for the frontend and backend.
**cObject**:
@@ -45,6 +51,10 @@ of the options you can choose as a web server. Others are Nginx, Microsoft IIS a
**Content Security Policy**:
+**CType**: CType refers to Content Type and is a database column field in a very
+important database table called "tt_content", where all the content elements are stored.
+This column defines the name of the specific content element, and influences how it is displayed in the backend and frontend.
+
**D**
**Database**:
From a947507cd8dd3683dc2172be11fa93ef1cc7dd4a Mon Sep 17 00:00:00 2001
From: Kiebele <mkiebele@w-commerce.de>
Date: Fri, 8 Nov 2024 17:16:39 +0100
Subject: [PATCH 3/8] [TASK] Add descriptions in glossary
---
Documentation/Glossary/Index.rst | 146 +++++++++++++++++++++----------
1 file changed, 98 insertions(+), 48 deletions(-)
diff --git a/Documentation/Glossary/Index.rst b/Documentation/Glossary/Index.rst
index 5e7c6e6c..deaaea80 100644
--- a/Documentation/Glossary/Index.rst
+++ b/Documentation/Glossary/Index.rst
@@ -2,6 +2,10 @@
.. _getting-started-glossary-index:
+
+.. todo: Note for contributing
+.. todo: Links for further information
+
========
Glossary
========
@@ -26,11 +30,12 @@ performance optimization accordingly. This helps tailor TYPO3 behavior for each
**B**
-**Backend**:
+**Backend**: The backend is the administrative interface for editors and administrators.
**Block syntax**: In TypoScript
-**Bootstrap**:
+**Bootstrap**: Bootstrap is a popular, beginner-friendly framework for building responsive, mobile-first
+websites using pre-designed HTML, CSS, and JavaScript components.
**C**
@@ -39,49 +44,64 @@ performance optimization accordingly. This helps tailor TYPO3 behavior for each
**Cache**: Caches are used to improve website performance by storing frequently
accessed data. TYPO3 has multiple caches for various performance relevant areas in both for the frontend and backend.
-**cObject**:
+**cObject**: A cObject (content object) is a core concept used to render different types of content on a website,
+allowing developers to define and control how content elements like text, images, and menus are displayed.
**Character Set**:
-**Composer**:
+**Composer**: Composer is a tool used in TYPO3 to easily install, update, and manage extensions and libraries,
+making it simpler to handle dependencies and keep the system up to date.
**Compression**: In TypoScript you are able to compress css or js files.
-**CMS**:
+**CMS**: A CMS, or Content Management System, is software like TYPO3 that allows users to create, edit,
+and manage website content without needing to code, making it easier to maintain and update websites.
-**Content Security Policy**:
+**Content Security Policy**: Content Security Policy (CSP) is a security feature in TYPO3 that helps protect your
+website from attacks by controlling which resources (like scripts, styles, or images) are allowed to load, reducing
+the risk of malicious content being injected.
**CType**: CType refers to Content Type and is a database column field in a very
-important database table called "tt_content", where all the content elements are stored.
+important database table called 'tt_content', where all the content elements are stored.
This column defines the name of the specific content element, and influences how it is displayed in the backend and frontend.
**D**
-**Database**:
+**Database**: A database is used to store and manage all the website's content, settings, and configurations,
+allowing the system to retrieve and display data dynamically on the site.
-**Documentation**:
+**Documentation**: The documentation provides detailed guides and instructions to help users and developers understand,
+set up, and customize TYPO3, making it easier to work with the system effectively.
-**Docker**:
+**Docker**: Docker is a tool that helps run TYPO3 in a consistent and isolated environment by packaging it with all its
+dependencies, making setup, deployment, and development easier and more reliable.
-**DDEV**:
+**DDEV**: DDEV is a local development tool that simplifies setting up a TYPO3 environment on your computer, making it
+easy to start developing, testing, and managing TYPO3 projects without complex configuration.
-**Deployment**:
+**Deployment**: Deployment refers to the process of transferring your website’s code, content, and settings from a
+development environment to a live server, making it accessible to users online.
-**Debug mode**:
+**Debug mode**: The Debug Mode is a feature that helps developers find and fix errors by showing detailed information
+about the website’s processes and any issues in the code.
-**Developer**:
+**Developer**: A developer is someone who builds, customizes, and maintains the website, creating new features,
+fixing issues, and ensuring everything works smoothly for users and administrators.
**Dependencies**: In Composer there exist usually dependencies that have to be installed too.
**E**
-**Editor**:
+**Editor**: An editor is a user who creates and manages content on the website, such as adding text, images, and links,
+without needing technical or coding knowledge.
-**Extension**:
+**Extension**: An extension is an add-on that provides additional features or functionality to the website,
+allowing you to customize and expand what TYPO3 can do.
**Extension Configuration**:
-**Error page**:
+**Error page**: An error page is a custom page that is displayed to users when something goes wrong,
+such as when a page is not found (404) or there is a server issue (500).
**F**
@@ -89,13 +109,15 @@ This column defines the name of the specific content element, and influences how
HTML-based output in the TYPO3 CMS. See :ref:`Fluid Reference<t3coreapi:fluid>`
for further details.
-**Fileadmin**:
+**Fileadmin**: Fileadmin is a folder structure where you can organize and manage all the files, such as images,
+documents, and media, that are used on your website.
**Filelist**:
-**FAL**:
+**FAL**: :ref:`File abstraction layer (FAL) <t3coreapi:fal_introduction>` is a system that manages and organizes media files, allowing you to
+easily store, access, and use files across the entire website in a standardized way.
-**Frontend**:
+**Frontend**: The frontend is the publicly accessible part of the website.
**Frontend login**:
@@ -109,9 +131,11 @@ for further details.
**I**
-**Integrator**:
+**Integrator**: An integrator is a person who connects and configures external systems, services, or data sources with
+the TYPO3 platform, ensuring smooth integration and functionality across different tools and applications.
-**Installtool password**:
+**Installtool password**: The Install Tool password is a secure password used to access the Install Tool, a feature that
+allows administrators to configure and manage the TYPO3 system, including database connections and system settings.
**J**
@@ -123,13 +147,17 @@ for further details.
**Local extension**:
-**LTS**:
+**LTS**: LTS (Long-Term Support) in TYPO3 refers to a version of the software that receives extended updates and security
+fixes for several years, ensuring stability and reliability for businesses and long-term projects.
-**Language file**:
+**Language file**: A language file is a file that contains translated text for the website, allowing the content to be
+displayed in different languages based on the user’s preferences or settings.
-**Layouts**:
+**Layouts**: Layouts are templates that define the structure and design of content elements on the website, allowing you
+to customize how the content is presented on different pages.
-**Log Folder**:
+**Log Folder**: The log folder is a directory where system logs are stored, helping administrators track errors, events,
+and activities to diagnose and troubleshoot issues with the website.
**Legacy installation**:
@@ -141,7 +169,8 @@ for further details.
**P**
-**Production server**:
+**Production server**: A production server is the live server where the fully developed website is hosted, making it
+accessible to users on the internet, and it typically has optimized settings for performance and security.
**Partial**: A partial is a small or large HTML code snippet that usually can
be used more often and on multiple spots. Here we
@@ -149,46 +178,61 @@ be used more often and on multiple spots. Here we
**Public**:
-**Permissions**:
+**Permissions**: Permissions control what users can see and do within the system, such as editing content, managing
+files, or configuring settings, based on their assigned roles and access levels.
-**PHP**:
+**PHP**: PHP is a programming language used in TYPO3 to create dynamic web pages and handle server-side logic, enabling
+features like content management, user interactions, and database access.
-**Page tree**:
+**Page tree**: The Page Tree is a hierarchical structure that represents the pages and their subpages on the website,
+allowing you to organize and manage the site’s content and navigation easily.
**Q**
**R**
-**Resources**:
+**Resources**: In TYPO3, resources refer to files such as images, documents, and other media that are used on the
+website, which are stored and managed through the File Abstraction Layer (FAL) for easy access and organization.
-**Root page**:
+**Root page**: The Root Page is the top-level page in the Page Tree, serving as the starting point for the website's
+structure and the foundation for the site's overall configuration and settings.
-**Reference index**:
+**Reference index**: The Reference Index is a system that keeps track of all content elements, files, and records that
+are linked or referenced throughout the website, helping maintain data integrity and consistency.
**S**
-**Symlink**:
+**Symlink**: A symlink (symbolic link) is a shortcut or reference to a file or directory located elsewhere on the server,
+allowing you to link content or resources without duplicating them.
-**Snapshot**:
+**Snapshot**: A snapshot is a backup or saved version of the website's content, settings, and configuration at a
+specific point in time, which can be restored if needed.
**Static file**: In the context of templating we say to a html file "static"
when it does not use Fluid but only plain HTML.
-**Site Package**:
+**Site Package**: A :ref:`site package <t3coreapi:site-package>` is a custom extension that includes all the necessary
+templates, configurations and settings to create and manage a specific website, allowing for easy setup and deployment.
-**Site Set**:
+**Site Set**: Site sets refer to configurations that define specific settings for different websites or domains within
+a multi-site setup, allowing you to manage multiple websites from a single TYPO3 installation.
-**Site Configuration**:
+**Site Configuration**: Site configuration is the setup that defines the settings for a specific website or domain,
+such as its language, routing, and templates, enabling TYPO3 to serve the correct content for that site.
-**System extension**:
+**System extension**: A system extension is a built-in extension that provides essential functionality and features for
+the core system, such as user management, backend tools, and caching, which are necessary for the website to operate.
-**SEO**:
+**SEO**: SEO (Search Engine Optimization) refers to the process of optimizing a website's content, structure and
+technical settings to improve its visibility and ranking in search engine results, helping attract more visitors.
-**System maintainer**:
+**System maintainer**: A System Maintainer is a person responsible for managing and maintaining the overall health and
+performance of the TYPO3 installation, ensuring that the system is up to date, secure, and running smoothly.
**T**
-**Third-party extension**:
+**Third-party extension**: A third-party extension is an add-on developed by external developers or companies that
+extends the functionality of TYPO3, providing additional features or integrations not included in the core system.
**TCA**:
@@ -199,14 +243,17 @@ Get an :ref:`introduction to Fluid templates <t3start:fluid-templates>`.
**Templating**: The templating engine that TYPO3 is using is Fluid.
-**TER**:
+**TER**: TER (TYPO3 Extension Repository) is an online platform where developers can share and download extensions,
+allowing users to easily extend the functionality of their TYPO3 installation.
**TypoScript**: :ref:`TypoScript<t3tsref:start>` is the basic configuration
language used to configure the frontend output of a page in TYPO3.
-**Top-level objects**:
+**Top-level objects**: Top-level objects are core components or elements, such as pages or content objects, that serve
+as the starting points for building and organizing the structure and content of a website.
-**Testing**:
+**Testing**: Testing involves checking the functionality, performance, and security of a website or extension to ensure
+everything works as expected before deployment or during updates.
**TSconfig**:
@@ -216,11 +263,14 @@ language used to configure the frontend output of a page in TYPO3.
**V**
-**Vendor folder**:
+**Vendor folder**: The vendor folder is where external libraries and dependencies, such as third-party extensions or
+frameworks, are stored, typically managed by Composer, to be used by the TYPO3 system.
-**Var folder**:
+**Var folder**: The var folder is used to store temporary files, cached data, logs, and other system-related
+information that helps the system function efficiently during runtime.
-**ViewHelper**:
+**ViewHelper**: A view helper is a reusable function or tool used in Fluid templates to manipulate or display data in a
+specific way, helping to keep the templates clean and organized.
**W**
From a1079ffac6f64308ccc042510d6935a33f82e19d Mon Sep 17 00:00:00 2001
From: Sandra Erbel <erbel@analog.de>
Date: Wed, 13 Nov 2024 12:28:22 +0100
Subject: [PATCH 4/8] [TASK] Glossary: Improve and add missing descriptions
---
Documentation/Glossary/Index.rst | 50 ++++++++++++++++++++++++--------
1 file changed, 38 insertions(+), 12 deletions(-)
diff --git a/Documentation/Glossary/Index.rst b/Documentation/Glossary/Index.rst
index deaaea80..9b421ada 100644
--- a/Documentation/Glossary/Index.rst
+++ b/Documentation/Glossary/Index.rst
@@ -5,6 +5,7 @@
.. todo: Note for contributing
.. todo: Links for further information
+.. todo: Add missing descriptions
========
Glossary
@@ -32,14 +33,16 @@ performance optimization accordingly. This helps tailor TYPO3 behavior for each
**Backend**: The backend is the administrative interface for editors and administrators.
-**Block syntax**: In TypoScript
+**Block syntax**: In TypoScript you can use the block syntax to enhance readability of your code.
**Bootstrap**: Bootstrap is a popular, beginner-friendly framework for building responsive, mobile-first
websites using pre-designed HTML, CSS, and JavaScript components.
**C**
-**Class**: In PHP
+**Class**: In PHP we can define classes located in the directory
+EXT:my_extension/Classes. If the namespace is correct they will be loaded
+automatically.
**Cache**: Caches are used to improve website performance by storing frequently
accessed data. TYPO3 has multiple caches for various performance relevant areas in both for the frontend and backend.
@@ -47,7 +50,8 @@ accessed data. TYPO3 has multiple caches for various performance relevant areas
**cObject**: A cObject (content object) is a core concept used to render different types of content on a website,
allowing developers to define and control how content elements like text, images, and menus are displayed.
-**Character Set**:
+**Character Set**: A `character set <https://www.w3.org/International/getting-started/characters.en.html>`__
+is a collection of letters and symbols used in a writing system.
**Composer**: Composer is a tool used in TYPO3 to easily install, update, and manage extensions and libraries,
making it simpler to handle dependencies and keep the system up to date.
@@ -57,9 +61,14 @@ making it simpler to handle dependencies and keep the system up to date.
**CMS**: A CMS, or Content Management System, is software like TYPO3 that allows users to create, edit,
and manage website content without needing to code, making it easier to maintain and update websites.
-**Content Security Policy**: Content Security Policy (CSP) is a security feature in TYPO3 that helps protect your
-website from attacks by controlling which resources (like scripts, styles, or images) are allowed to load, reducing
-the risk of malicious content being injected.
+**Content Security Policy**: The idea of Content Security Policy (CSP) is to
+make the frontend and backend more secure from attacks by restricting the rules
+what a user of the website or the TYPO3 backend can do. CSP is a W3C standard
+valid for everyone. In TYPO3 there exists a backend module that is in charge
+of this additional security feature. CSP helps to protect your website from
+attacks by controlling which resources (like scripts, styles, or images) are
+allowed to load, reducing the risk of malicious content being injected. To
+configure CSP go to :ref:`Content Security Policy <t3coreapi:content-security-policy>`.
**CType**: CType refers to Content Type and is a database column field in a very
important database table called 'tt_content', where all the content elements are stored.
@@ -112,20 +121,28 @@ for further details.
**Fileadmin**: Fileadmin is a folder structure where you can organize and manage all the files, such as images,
documents, and media, that are used on your website.
-**Filelist**:
+**Filelist**: The filelist is a backend module where you can upload files and
+manage your uploaded files.
**FAL**: :ref:`File abstraction layer (FAL) <t3coreapi:fal_introduction>` is a system that manages and organizes media files, allowing you to
easily store, access, and use files across the entire website in a standardized way.
**Frontend**: The frontend is the publicly accessible part of the website.
-**Frontend login**:
+**Frontend login**: You can also implement a frontend login on your website. To
+implement this you can use the system extension felogin provided by TYPO3.
-**Fluid styled content extension**:
+**Fluid styled content extension**: The fluid styled content extension is a
+system extension provided by TYPO3 that gives you default content elements,
+palettes and backend fields. That is the reason why you just can use bodytext,
+image and assets without having to make a database compare.
**G**
-**Global TYPO3 variables**:
+**Global TYPO3 variables**: In TYPO3 exists a global TYPO3 configuration array
+($GLOBALS) where you can declare :ref:`global settings/variables <t3coreapi:typo3ConfVars>`
+for your TYPO3 instance. There are many different options. For example: BE -
+backend configuration, DB - database connections and many more.
**H**
@@ -143,7 +160,10 @@ allows administrators to configure and manage the TYPO3 system, including databa
**L**
-**Local development**:
+**Local development**: It is common practice to develop locally on your local
+machine first. Later when you are sure about your website you can think about
+deployment and setting up a production environment with better performance and
+Content Security Policy settings.
**Local extension**:
@@ -255,7 +275,13 @@ as the starting points for building and organizing the structure and content of
**Testing**: Testing involves checking the functionality, performance, and security of a website or extension to ensure
everything works as expected before deployment or during updates.
-**TSconfig**:
+**TSconfig**: In TYPO3 you can manage the appearance of the TYPO3 backend with
+TSconfig files. You can manage page related appearance, backend user related
+appearances and backend user group appearances. You can use
+:ref:`TSconfig Reference <t3tsconfig:start>` as a overall reference to look up
+all possible settings that you can make using TSconfig. Normally you write all
+your settings in TSconfig files like
+EXT:my_extension/Configuration/Sets/MyExtension/page.tsconfig.
**U**
From 286651db10a2d546055482c4b443b91b2b84bfe0 Mon Sep 17 00:00:00 2001
From: Sarah McCarthy <sarahmccarthy123@yahoo.com>
Date: Thu, 14 Nov 2024 18:28:44 +0100
Subject: [PATCH 5/8] [TASK] Small language corrections
---
Documentation/Glossary/Index.rst | 228 +++++++++++++++++--------------
1 file changed, 128 insertions(+), 100 deletions(-)
diff --git a/Documentation/Glossary/Index.rst b/Documentation/Glossary/Index.rst
index 9b421ada..c4060c1b 100644
--- a/Documentation/Glossary/Index.rst
+++ b/Documentation/Glossary/Index.rst
@@ -13,8 +13,8 @@ Glossary
**A**
-**Apache**: `Apache httpd <https://en.wikipedia.org/wiki/Apache_HTTP_Server>`__ is one
-of the options you can choose as a web server. Others are Nginx, Microsoft IIS and Caddy Server (`see system requirements <https://get.typo3.org/version/13#system-requirements>`__).
+**Apache**: `Apache httpd <https://en.wikipedia.org/wiki/Apache_HTTP_Server>`__
+is a web server. Others are Nginx, Microsoft IIS and Caddy Server (`see system requirements <https://get.typo3.org/version/13#system-requirements>`__).
**Admin Tools**: Admin tools are a group of backend modules.
These include maintaining the installation, adjusting settings, executing upgrade wizards,
@@ -22,18 +22,18 @@ checking environment information and setting up extensions.
**Admin User**:
-**Assets**: Assets are media resources such as images, videos and documents that are uploaded and managed in the TYPO3 system.
-Also, extensions can include assets which can be referred to in the frontend, like specific icons or JavaScript libraries.
+**Assets**: Assets are media resources such as images, videos and documents that are uploaded and managed in TYPO3 system.
+Also, extensions can include assets which used in the frontend, like icons or JavaScript libraries.
-**Application context**: In TYPO3, Application Context specifies the environment
-(e.g., Development, Production) the site is running in, adjusting settings like debugging or
+**Application context**: In TYPO3, the Application Context is the environment
+(e.g., Development, Production) the site is running in, which sets things like debugging or
performance optimization accordingly. This helps tailor TYPO3 behavior for each stage of deployment.
**B**
**Backend**: The backend is the administrative interface for editors and administrators.
-**Block syntax**: In TypoScript you can use the block syntax to enhance readability of your code.
+**Block syntax**: In TypoScript you can use block syntax to enhance the readability of your code.
**Bootstrap**: Bootstrap is a popular, beginner-friendly framework for building responsive, mobile-first
websites using pre-designed HTML, CSS, and JavaScript components.
@@ -45,44 +45,45 @@ EXT:my_extension/Classes. If the namespace is correct they will be loaded
automatically.
**Cache**: Caches are used to improve website performance by storing frequently
-accessed data. TYPO3 has multiple caches for various performance relevant areas in both for the frontend and backend.
+accessed data. TYPO3 has multiple caches for various performance-relevant areas in both the frontend and backend.
-**cObject**: A cObject (content object) is a core concept used to render different types of content on a website,
+**cObject**: A cObject (content object) is a core concept used to render content types on a website,
allowing developers to define and control how content elements like text, images, and menus are displayed.
**Character Set**: A `character set <https://www.w3.org/International/getting-started/characters.en.html>`__
is a collection of letters and symbols used in a writing system.
-**Composer**: Composer is a tool used in TYPO3 to easily install, update, and manage extensions and libraries,
-making it simpler to handle dependencies and keep the system up to date.
+**Composer**: Composer is a tool used in TYPO3 to install, update, and manage extensions and libraries,
+making it simple to handle dependencies and keep the system up to date.
-**Compression**: In TypoScript you are able to compress css or js files.
+**Compression**: In TypoScript you can compress css and js files.
**CMS**: A CMS, or Content Management System, is software like TYPO3 that allows users to create, edit,
and manage website content without needing to code, making it easier to maintain and update websites.
-**Content Security Policy**: The idea of Content Security Policy (CSP) is to
-make the frontend and backend more secure from attacks by restricting the rules
-what a user of the website or the TYPO3 backend can do. CSP is a W3C standard
-valid for everyone. In TYPO3 there exists a backend module that is in charge
-of this additional security feature. CSP helps to protect your website from
+**Content Security Policy**: A Content Security Policy (CSP)
+makes the frontend and backend more secure from attacks by restricting the rules
+governing what a user of a website or TYPO3 backend can do. CSP is a W3C standard
+valid for everyone. TYPO3 provides a backend module that manages
+this security feature. CSP helps to protect your website from
attacks by controlling which resources (like scripts, styles, or images) are
-allowed to load, reducing the risk of malicious content being injected. To
+loaded, reducing the risk of malicious content being injected. To
configure CSP go to :ref:`Content Security Policy <t3coreapi:content-security-policy>`.
**CType**: CType refers to Content Type and is a database column field in a very
-important database table called 'tt_content', where all the content elements are stored.
-This column defines the name of the specific content element, and influences how it is displayed in the backend and frontend.
+important database table called 'tt_content' which stores all the content elements.
+The column defines the name of the content element, and influences how it is
+displayed in the backend and frontend.
**D**
-**Database**: A database is used to store and manage all the website's content, settings, and configurations,
+**Database**: A database stores and manages all a website's content, settings, and configurations,
allowing the system to retrieve and display data dynamically on the site.
-**Documentation**: The documentation provides detailed guides and instructions to help users and developers understand,
+**Documentation**: Documentation consists of detailed guides and instructions to help users and developers understand,
set up, and customize TYPO3, making it easier to work with the system effectively.
-**Docker**: Docker is a tool that helps run TYPO3 in a consistent and isolated environment by packaging it with all its
+**Docker**: Docker is a tool that runs TYPO3 in a consistent and isolated environment by packaging it with all its
dependencies, making setup, deployment, and development easier and more reliable.
**DDEV**: DDEV is a local development tool that simplifies setting up a TYPO3 environment on your computer, making it
@@ -91,20 +92,20 @@ easy to start developing, testing, and managing TYPO3 projects without complex c
**Deployment**: Deployment refers to the process of transferring your website’s code, content, and settings from a
development environment to a live server, making it accessible to users online.
-**Debug mode**: The Debug Mode is a feature that helps developers find and fix errors by showing detailed information
-about the website’s processes and any issues in the code.
+**Debug mode**: Debug Mode is a feature that helps developers find and fix errors by showing detailed information
+about a website’s processes and any issues with the code.
-**Developer**: A developer is someone who builds, customizes, and maintains the website, creating new features,
+**Developer**: A developer is someone who builds, customizes, and maintains a website, creating new features,
fixing issues, and ensuring everything works smoothly for users and administrators.
-**Dependencies**: In Composer there exist usually dependencies that have to be installed too.
+**Dependencies**: In Composer there are usually dependencies that have to be installed too.
**E**
-**Editor**: An editor is a user who creates and manages content on the website, such as adding text, images, and links,
+**Editor**: An editor is a user who creates and manages content on a website, such as adding text, images, and links,
without needing technical or coding knowledge.
-**Extension**: An extension is an add-on that provides additional features or functionality to the website,
+**Extension**: An extension is an add-on that provides additional features or functionality to a website,
allowing you to customize and expand what TYPO3 can do.
**Extension Configuration**:
@@ -124,22 +125,23 @@ documents, and media, that are used on your website.
**Filelist**: The filelist is a backend module where you can upload files and
manage your uploaded files.
-**FAL**: :ref:`File abstraction layer (FAL) <t3coreapi:fal_introduction>` is a system that manages and organizes media files, allowing you to
-easily store, access, and use files across the entire website in a standardized way.
+**FAL**: :ref:`File abstraction layer (FAL) <t3coreapi:fal_introduction>` is a
+system that manages and organizes media files, allowing you to easily store,
+access, and use files across the entire website in a standardized way.
-**Frontend**: The frontend is the publicly accessible part of the website.
+**Frontend**: The frontend is the publicly accessible part of a website.
-**Frontend login**: You can also implement a frontend login on your website. To
-implement this you can use the system extension felogin provided by TYPO3.
+**Frontend login**: You can implement a frontend login on your website. To
+implement this use the system extension felogin provided by TYPO3.
**Fluid styled content extension**: The fluid styled content extension is a
system extension provided by TYPO3 that gives you default content elements,
-palettes and backend fields. That is the reason why you just can use bodytext,
-image and assets without having to make a database compare.
+palettes and backend fields. That is the reason why you can use bodytext,
+image and assets without having to do a database compare.
**G**
-**Global TYPO3 variables**: In TYPO3 exists a global TYPO3 configuration array
+**Global TYPO3 variables**: In TYPO3 there is a global TYPO3 configuration array
($GLOBALS) where you can declare :ref:`global settings/variables <t3coreapi:typo3ConfVars>`
for your TYPO3 instance. There are many different options. For example: BE -
backend configuration, DB - database connections and many more.
@@ -148,11 +150,13 @@ backend configuration, DB - database connections and many more.
**I**
-**Integrator**: An integrator is a person who connects and configures external systems, services, or data sources with
-the TYPO3 platform, ensuring smooth integration and functionality across different tools and applications.
+**Integrator**: An integrator is a person who connects and configures external
+systems, services, or data sources with the TYPO3 platform, ensuring smooth
+integration and functionality across different tools and applications.
-**Installtool password**: The Install Tool password is a secure password used to access the Install Tool, a feature that
-allows administrators to configure and manage the TYPO3 system, including database connections and system settings.
+**Installtool password**: The Install Tool password is a secure password used to
+access the Install Tool, a tool that allows administrators to configure and
+manage the TYPO3 system, including database connections and system settings.
**J**
@@ -162,22 +166,26 @@ allows administrators to configure and manage the TYPO3 system, including databa
**Local development**: It is common practice to develop locally on your local
machine first. Later when you are sure about your website you can think about
-deployment and setting up a production environment with better performance and
+deployment and setting up a production environment which has better performance and
Content Security Policy settings.
**Local extension**:
-**LTS**: LTS (Long-Term Support) in TYPO3 refers to a version of the software that receives extended updates and security
-fixes for several years, ensuring stability and reliability for businesses and long-term projects.
+**LTS**: LTS (Long-Term Support) in TYPO3 refers to a version of the software
+that receives extended updates and security fixes for several years, ensuring
+stability and reliability for businesses and long-term projects.
-**Language file**: A language file is a file that contains translated text for the website, allowing the content to be
-displayed in different languages based on the user’s preferences or settings.
+**Language file**: A language file is a file that contains translated text for
+a website, allowing content to be displayed in different languages based
+on a user’s preferences or settings.
-**Layouts**: Layouts are templates that define the structure and design of content elements on the website, allowing you
-to customize how the content is presented on different pages.
+**Layouts**: Layouts are templates that define the structure and design of
+content elements on a website, allowing you to customize how content is
+presented on different pages.
-**Log Folder**: The log folder is a directory where system logs are stored, helping administrators track errors, events,
-and activities to diagnose and troubleshoot issues with the website.
+**Log Folder**: The log folder is a directory where system logs are stored,
+helping administrators track errors, events, and activities to diagnose and
+troubleshoot issues with a website.
**Legacy installation**:
@@ -189,70 +197,85 @@ and activities to diagnose and troubleshoot issues with the website.
**P**
-**Production server**: A production server is the live server where the fully developed website is hosted, making it
-accessible to users on the internet, and it typically has optimized settings for performance and security.
+**Production server**: A production server is the live server where a fully
+developed website is hosted, making it accessible to users on the internet, and
+it typically has optimized settings for performance and security.
-**Partial**: A partial is a small or large HTML code snippet that usually can
-be used more often and on multiple spots. Here we
+**Partial**: A partial is a small or large HTML code snippet that can be used
+often and in multiple places. Here we
:ref:`split up the template into partials <t3sitepackage:partials>`.
**Public**:
-**Permissions**: Permissions control what users can see and do within the system, such as editing content, managing
-files, or configuring settings, based on their assigned roles and access levels.
+**Permissions**: Permissions control what users can see and do within a system,
+such as editing content, managing files, or configuring settings, based on their
+assigned roles and access levels.
-**PHP**: PHP is a programming language used in TYPO3 to create dynamic web pages and handle server-side logic, enabling
-features like content management, user interactions, and database access.
+**PHP**: PHP is a programming language used in TYPO3 to create dynamic web pages
+and handle server-side logic, enabling features like content management, user
+interactions, and database access.
-**Page tree**: The Page Tree is a hierarchical structure that represents the pages and their subpages on the website,
-allowing you to organize and manage the site’s content and navigation easily.
+**Page tree**: The Page Tree is a hierarchical structure that represents pages and
+their subpages on a website, allowing you to easily organize and manage content and
+navigation.
**Q**
**R**
-**Resources**: In TYPO3, resources refer to files such as images, documents, and other media that are used on the
-website, which are stored and managed through the File Abstraction Layer (FAL) for easy access and organization.
+**Resources**: In TYPO3, resources refer to files such as images, documents, and
+other media that are used on a website, which are stored and managed through the
+File Abstraction Layer (FAL) for easy access and organization.
-**Root page**: The Root Page is the top-level page in the Page Tree, serving as the starting point for the website's
-structure and the foundation for the site's overall configuration and settings.
+**Root page**: The Root Page is the top-level page in the Page Tree, serving as
+the starting point for a website's structure and is the foundation for the site's
+overall configuration and settings.
-**Reference index**: The Reference Index is a system that keeps track of all content elements, files, and records that
-are linked or referenced throughout the website, helping maintain data integrity and consistency.
+**Reference index**: The Reference Index is a system that keeps track of all
+content elements, files, and records that are linked or referenced throughout the
+website, helping maintain data integrity and consistency.
**S**
-**Symlink**: A symlink (symbolic link) is a shortcut or reference to a file or directory located elsewhere on the server,
-allowing you to link content or resources without duplicating them.
+**Symlink**: A symlink (symbolic link) is a shortcut or reference to a file or
+directory located elsewhere on the server, allowing you to link content or
+resources without duplicating them.
-**Snapshot**: A snapshot is a backup or saved version of the website's content, settings, and configuration at a
-specific point in time, which can be restored if needed.
+**Snapshot**: A snapshot is a backup or saved version of a website's content,
+settings, and configuration at a specific point in time, which can be restored if needed.
-**Static file**: In the context of templating we say to a html file "static"
+**Static file**: In the context of templating we say a html file is "static"
when it does not use Fluid but only plain HTML.
-**Site Package**: A :ref:`site package <t3coreapi:site-package>` is a custom extension that includes all the necessary
-templates, configurations and settings to create and manage a specific website, allowing for easy setup and deployment.
+**Site Package**: A :ref:`site package <t3coreapi:site-package>` is a custom
+extension that includes all the necessary templates, configurations and settings
+to create and manage a specific website, allowing for easy setup and deployment.
-**Site Set**: Site sets refer to configurations that define specific settings for different websites or domains within
-a multi-site setup, allowing you to manage multiple websites from a single TYPO3 installation.
+**Site Set**: Site sets refer to configurations that define specific settings for
+different websites or domains within a multi-site setup, allowing you to manage
+multiple websites from a single TYPO3 installation.
-**Site Configuration**: Site configuration is the setup that defines the settings for a specific website or domain,
-such as its language, routing, and templates, enabling TYPO3 to serve the correct content for that site.
+**Site Configuration**: Site configuration is the setup that defines the settings
+for a specific website or domain, such as its language, routing, and templates,
+enabling TYPO3 to serve the correct content for that site.
-**System extension**: A system extension is a built-in extension that provides essential functionality and features for
-the core system, such as user management, backend tools, and caching, which are necessary for the website to operate.
+**System extension**: A system extension is a built-in extension that provides
+essential functionality and features for the core system, such as user management,
+backend tools, and caching, which are necessary for the website to operate.
-**SEO**: SEO (Search Engine Optimization) refers to the process of optimizing a website's content, structure and
-technical settings to improve its visibility and ranking in search engine results, helping attract more visitors.
+**SEO**: SEO (Search Engine Optimization) refers to the process of optimizing a
+website's content, structure and technical settings to improve its visibility
+and ranking in search engine results, helping to attract more visitors.
-**System maintainer**: A System Maintainer is a person responsible for managing and maintaining the overall health and
-performance of the TYPO3 installation, ensuring that the system is up to date, secure, and running smoothly.
+**System maintainer**: A System Maintainer is a person responsible for managing
+and maintaining the overall health and performance of a TYPO3 installation,
+ensuring that the system is up to date, secure, and running smoothly.
**T**
-**Third-party extension**: A third-party extension is an add-on developed by external developers or companies that
-extends the functionality of TYPO3, providing additional features or integrations not included in the core system.
+**Third-party extension**: A third-party extension is an add-on developed by
+external developers or companies. They extend the functionality of TYPO3,
+providing additional features or integrations not included in the core system.
**TCA**:
@@ -261,7 +284,7 @@ See also :ref:`Fluid Templates <t3sitepackage:fluid-templates>`. Usually we use
:ref:`Fluid<t3coreapi:fluid>` and the :ref:`ViewHelpers<t3viewhelper:start>`.
Get an :ref:`introduction to Fluid templates <t3start:fluid-templates>`.
-**Templating**: The templating engine that TYPO3 is using is Fluid.
+**Templating**: The templating engine that TYPO3 uses is Fluid.
**TER**: TER (TYPO3 Extension Repository) is an online platform where developers can share and download extensions,
allowing users to easily extend the functionality of their TYPO3 installation.
@@ -269,17 +292,19 @@ allowing users to easily extend the functionality of their TYPO3 installation.
**TypoScript**: :ref:`TypoScript<t3tsref:start>` is the basic configuration
language used to configure the frontend output of a page in TYPO3.
-**Top-level objects**: Top-level objects are core components or elements, such as pages or content objects, that serve
-as the starting points for building and organizing the structure and content of a website.
+**Top-level objects**: Top-level objects are core components or elements, such
+as pages or content objects, that serve as starting points for building and
+organizing the structure and content of a website.
-**Testing**: Testing involves checking the functionality, performance, and security of a website or extension to ensure
-everything works as expected before deployment or during updates.
+**Testing**: Testing involves checking the functionality, performance, and
+security of a website or extension to ensure everything works as expected before
+deployment or during updates.
-**TSconfig**: In TYPO3 you can manage the appearance of the TYPO3 backend with
-TSconfig files. You can manage page related appearance, backend user related
-appearances and backend user group appearances. You can use
+**TSconfig**: In TYPO3 you can set how the TYPO3 backend looks with
+TSconfig files. You can set page related appearance, backend user related
+appearance and backend user group appearance. You can use
:ref:`TSconfig Reference <t3tsconfig:start>` as a overall reference to look up
-all possible settings that you can make using TSconfig. Normally you write all
+settings that you can use for TSconfig. Normally you keep all
your settings in TSconfig files like
EXT:my_extension/Configuration/Sets/MyExtension/page.tsconfig.
@@ -289,14 +314,17 @@ EXT:my_extension/Configuration/Sets/MyExtension/page.tsconfig.
**V**
-**Vendor folder**: The vendor folder is where external libraries and dependencies, such as third-party extensions or
-frameworks, are stored, typically managed by Composer, to be used by the TYPO3 system.
+**Vendor folder**: The vendor folder is where external libraries and dependencies,
+such as third-party extensions and frameworks, are stored. They are typically
+managed by Composer, to be used by the TYPO3 system.
-**Var folder**: The var folder is used to store temporary files, cached data, logs, and other system-related
-information that helps the system function efficiently during runtime.
+**Var folder**: The var folder is used to store temporary files, cached data,
+logs, and other system-related information that helps the system function
+efficiently during runtime.
-**ViewHelper**: A view helper is a reusable function or tool used in Fluid templates to manipulate or display data in a
-specific way, helping to keep the templates clean and organized.
+**ViewHelper**: A view helper is a reusable function or tool used in Fluid
+templates to manipulate or display data in a specific way, helping to keep
+templates clean and organized.
**W**
From b7468dc7a1de9ca693c0c37c5bed312a86d5cf55 Mon Sep 17 00:00:00 2001
From: Kiebele <mkiebele@w-commerce.de>
Date: Mon, 18 Nov 2024 12:04:42 +0100
Subject: [PATCH 6/8] [TASK] Add links in glossary
---
Documentation/Glossary/Index.rst | 26 +++++++++++++-------------
1 file changed, 13 insertions(+), 13 deletions(-)
diff --git a/Documentation/Glossary/Index.rst b/Documentation/Glossary/Index.rst
index c4060c1b..a179a2d1 100644
--- a/Documentation/Glossary/Index.rst
+++ b/Documentation/Glossary/Index.rst
@@ -22,20 +22,20 @@ checking environment information and setting up extensions.
**Admin User**:
-**Assets**: Assets are media resources such as images, videos and documents that are uploaded and managed in TYPO3 system.
+**Assets**: :ref:`Assets <t3start:webroot>` are media resources such as images, videos and documents that are uploaded and managed in TYPO3 system.
Also, extensions can include assets which used in the frontend, like icons or JavaScript libraries.
-**Application context**: In TYPO3, the Application Context is the environment
+**Application context**: In TYPO3, the :ref:`Application Context <t3coreapi:application-context>` is the environment
(e.g., Development, Production) the site is running in, which sets things like debugging or
performance optimization accordingly. This helps tailor TYPO3 behavior for each stage of deployment.
**B**
-**Backend**: The backend is the administrative interface for editors and administrators.
+**Backend**: The :ref:`backend <t3start:backend>` is the administrative interface for editors and administrators.
**Block syntax**: In TypoScript you can use block syntax to enhance the readability of your code.
-**Bootstrap**: Bootstrap is a popular, beginner-friendly framework for building responsive, mobile-first
+**Bootstrap**: `Bootstrap <https://getbootstrap.com/>`__ is a popular, beginner-friendly framework for building responsive, mobile-first
websites using pre-designed HTML, CSS, and JavaScript components.
**C**
@@ -44,16 +44,16 @@ websites using pre-designed HTML, CSS, and JavaScript components.
EXT:my_extension/Classes. If the namespace is correct they will be loaded
automatically.
-**Cache**: Caches are used to improve website performance by storing frequently
+**Cache**: :ref:`Caches <t3start:cache>` are used to improve website performance by storing frequently
accessed data. TYPO3 has multiple caches for various performance-relevant areas in both the frontend and backend.
-**cObject**: A cObject (content object) is a core concept used to render content types on a website,
+**cObject**: A :ref:`cObject (content object) <t3tsref:cobject>` is a core concept used to render content types on a website,
allowing developers to define and control how content elements like text, images, and menus are displayed.
**Character Set**: A `character set <https://www.w3.org/International/getting-started/characters.en.html>`__
is a collection of letters and symbols used in a writing system.
-**Composer**: Composer is a tool used in TYPO3 to install, update, and manage extensions and libraries,
+**Composer**: `Composer <https://getcomposer.org/>`__ is a tool used in TYPO3 to install, update, and manage extensions and libraries,
making it simple to handle dependencies and keep the system up to date.
**Compression**: In TypoScript you can compress css and js files.
@@ -83,13 +83,13 @@ allowing the system to retrieve and display data dynamically on the site.
**Documentation**: Documentation consists of detailed guides and instructions to help users and developers understand,
set up, and customize TYPO3, making it easier to work with the system effectively.
-**Docker**: Docker is a tool that runs TYPO3 in a consistent and isolated environment by packaging it with all its
+**Docker**: `Docker <https://www.docker.com/>`__ is a tool that runs TYPO3 in a consistent and isolated environment by packaging it with all its
dependencies, making setup, deployment, and development easier and more reliable.
-**DDEV**: DDEV is a local development tool that simplifies setting up a TYPO3 environment on your computer, making it
+**DDEV**: `DDEV <https://ddev.com/>`__ is a local development tool that simplifies setting up a TYPO3 environment on your computer, making it
easy to start developing, testing, and managing TYPO3 projects without complex configuration.
-**Deployment**: Deployment refers to the process of transferring your website’s code, content, and settings from a
+**Deployment**: :ref:`Deployment <t3start:deployment>` refers to the process of transferring your website’s code, content, and settings from a
development environment to a live server, making it accessible to users online.
**Debug mode**: Debug Mode is a feature that helps developers find and fix errors by showing detailed information
@@ -105,7 +105,7 @@ fixing issues, and ensuring everything works smoothly for users and administrato
**Editor**: An editor is a user who creates and manages content on a website, such as adding text, images, and links,
without needing technical or coding knowledge.
-**Extension**: An extension is an add-on that provides additional features or functionality to a website,
+**Extension**: An :ref:`extension <t3start:concepts-extensions>` is an add-on that provides additional features or functionality to a website,
allowing you to customize and expand what TYPO3 can do.
**Extension Configuration**:
@@ -129,7 +129,7 @@ manage your uploaded files.
system that manages and organizes media files, allowing you to easily store,
access, and use files across the entire website in a standardized way.
-**Frontend**: The frontend is the publicly accessible part of a website.
+**Frontend**: The :ref:`frontend <t3start:frontend>` is the publicly accessible part of a website.
**Frontend login**: You can implement a frontend login on your website. To
implement this use the system extension felogin provided by TYPO3.
@@ -227,7 +227,7 @@ navigation.
other media that are used on a website, which are stored and managed through the
File Abstraction Layer (FAL) for easy access and organization.
-**Root page**: The Root Page is the top-level page in the Page Tree, serving as
+**Root page**: The :ref:`Root Page <t3start:create-root-page>` is the top-level page in the Page Tree, serving as
the starting point for a website's structure and is the foundation for the site's
overall configuration and settings.
From f00a1f1aca714c2abfddd41597e71593361a6aa0 Mon Sep 17 00:00:00 2001
From: Kiebele <mkiebele@w-commerce.de>
Date: Fri, 6 Dec 2024 12:14:25 +0100
Subject: [PATCH 7/8] [Task] changed to glossary directive
---
Documentation/Glossary/Index.rst | 658 ++++++++++++++++---------------
1 file changed, 339 insertions(+), 319 deletions(-)
diff --git a/Documentation/Glossary/Index.rst b/Documentation/Glossary/Index.rst
index a179a2d1..de963d05 100644
--- a/Documentation/Glossary/Index.rst
+++ b/Documentation/Glossary/Index.rst
@@ -11,325 +11,345 @@
Glossary
========
-**A**
+.. glossary::
+
+ **Apache**:
+ `Apache httpd <https://en.wikipedia.org/wiki/Apache_HTTP_Server>`__
+ is a web server. Others are Nginx, Microsoft IIS and Caddy Server (`see system requirements <https://get.typo3.org/version/13#system-requirements>`__).
+
+ **Admin Tools**:
+ Admin tools are a group of backend modules.
+ These include maintaining the installation, adjusting settings, executing upgrade wizards,
+ checking environment information and setting up extensions.
-**Apache**: `Apache httpd <https://en.wikipedia.org/wiki/Apache_HTTP_Server>`__
-is a web server. Others are Nginx, Microsoft IIS and Caddy Server (`see system requirements <https://get.typo3.org/version/13#system-requirements>`__).
+ **Admin User**:
+
+ **Assets**:
+ :ref:`Assets <t3start:webroot>` are media resources such as images, videos and documents that are uploaded and managed in TYPO3 system.
+ Also, extensions can include assets which used in the frontend, like icons or JavaScript libraries.
-**Admin Tools**: Admin tools are a group of backend modules.
-These include maintaining the installation, adjusting settings, executing upgrade wizards,
-checking environment information and setting up extensions.
+ **Application context**:
+ In TYPO3, the :ref:`Application Context <t3coreapi:application-context>` is the environment
+ (e.g., Development, Production) the site is running in, which sets things like debugging or
+ performance optimization accordingly. This helps tailor TYPO3 behavior for each stage of deployment.
-**Admin User**:
-
-**Assets**: :ref:`Assets <t3start:webroot>` are media resources such as images, videos and documents that are uploaded and managed in TYPO3 system.
-Also, extensions can include assets which used in the frontend, like icons or JavaScript libraries.
-
-**Application context**: In TYPO3, the :ref:`Application Context <t3coreapi:application-context>` is the environment
-(e.g., Development, Production) the site is running in, which sets things like debugging or
-performance optimization accordingly. This helps tailor TYPO3 behavior for each stage of deployment.
-
-**B**
-
-**Backend**: The :ref:`backend <t3start:backend>` is the administrative interface for editors and administrators.
-
-**Block syntax**: In TypoScript you can use block syntax to enhance the readability of your code.
-
-**Bootstrap**: `Bootstrap <https://getbootstrap.com/>`__ is a popular, beginner-friendly framework for building responsive, mobile-first
-websites using pre-designed HTML, CSS, and JavaScript components.
-
-**C**
-
-**Class**: In PHP we can define classes located in the directory
-EXT:my_extension/Classes. If the namespace is correct they will be loaded
-automatically.
-
-**Cache**: :ref:`Caches <t3start:cache>` are used to improve website performance by storing frequently
-accessed data. TYPO3 has multiple caches for various performance-relevant areas in both the frontend and backend.
-
-**cObject**: A :ref:`cObject (content object) <t3tsref:cobject>` is a core concept used to render content types on a website,
-allowing developers to define and control how content elements like text, images, and menus are displayed.
-
-**Character Set**: A `character set <https://www.w3.org/International/getting-started/characters.en.html>`__
-is a collection of letters and symbols used in a writing system.
-
-**Composer**: `Composer <https://getcomposer.org/>`__ is a tool used in TYPO3 to install, update, and manage extensions and libraries,
-making it simple to handle dependencies and keep the system up to date.
-
-**Compression**: In TypoScript you can compress css and js files.
-
-**CMS**: A CMS, or Content Management System, is software like TYPO3 that allows users to create, edit,
-and manage website content without needing to code, making it easier to maintain and update websites.
-
-**Content Security Policy**: A Content Security Policy (CSP)
-makes the frontend and backend more secure from attacks by restricting the rules
-governing what a user of a website or TYPO3 backend can do. CSP is a W3C standard
-valid for everyone. TYPO3 provides a backend module that manages
-this security feature. CSP helps to protect your website from
-attacks by controlling which resources (like scripts, styles, or images) are
-loaded, reducing the risk of malicious content being injected. To
-configure CSP go to :ref:`Content Security Policy <t3coreapi:content-security-policy>`.
-
-**CType**: CType refers to Content Type and is a database column field in a very
-important database table called 'tt_content' which stores all the content elements.
-The column defines the name of the content element, and influences how it is
-displayed in the backend and frontend.
-
-**D**
-
-**Database**: A database stores and manages all a website's content, settings, and configurations,
-allowing the system to retrieve and display data dynamically on the site.
-
-**Documentation**: Documentation consists of detailed guides and instructions to help users and developers understand,
-set up, and customize TYPO3, making it easier to work with the system effectively.
-
-**Docker**: `Docker <https://www.docker.com/>`__ is a tool that runs TYPO3 in a consistent and isolated environment by packaging it with all its
-dependencies, making setup, deployment, and development easier and more reliable.
-
-**DDEV**: `DDEV <https://ddev.com/>`__ is a local development tool that simplifies setting up a TYPO3 environment on your computer, making it
-easy to start developing, testing, and managing TYPO3 projects without complex configuration.
-
-**Deployment**: :ref:`Deployment <t3start:deployment>` refers to the process of transferring your website’s code, content, and settings from a
-development environment to a live server, making it accessible to users online.
-
-**Debug mode**: Debug Mode is a feature that helps developers find and fix errors by showing detailed information
-about a website’s processes and any issues with the code.
-
-**Developer**: A developer is someone who builds, customizes, and maintains a website, creating new features,
-fixing issues, and ensuring everything works smoothly for users and administrators.
-
-**Dependencies**: In Composer there are usually dependencies that have to be installed too.
-
-**E**
-
-**Editor**: An editor is a user who creates and manages content on a website, such as adding text, images, and links,
-without needing technical or coding knowledge.
-
-**Extension**: An :ref:`extension <t3start:concepts-extensions>` is an add-on that provides additional features or functionality to a website,
-allowing you to customize and expand what TYPO3 can do.
-
-**Extension Configuration**:
-
-**Error page**: An error page is a custom page that is displayed to users when something goes wrong,
-such as when a page is not found (404) or there is a server issue (500).
-
-**F**
-
-**Fluid**: Fluid is a PHP template engine and is the de facto standard for any
-HTML-based output in the TYPO3 CMS. See :ref:`Fluid Reference<t3coreapi:fluid>`
-for further details.
-
-**Fileadmin**: Fileadmin is a folder structure where you can organize and manage all the files, such as images,
-documents, and media, that are used on your website.
-
-**Filelist**: The filelist is a backend module where you can upload files and
-manage your uploaded files.
-
-**FAL**: :ref:`File abstraction layer (FAL) <t3coreapi:fal_introduction>` is a
-system that manages and organizes media files, allowing you to easily store,
-access, and use files across the entire website in a standardized way.
-
-**Frontend**: The :ref:`frontend <t3start:frontend>` is the publicly accessible part of a website.
-
-**Frontend login**: You can implement a frontend login on your website. To
-implement this use the system extension felogin provided by TYPO3.
-
-**Fluid styled content extension**: The fluid styled content extension is a
-system extension provided by TYPO3 that gives you default content elements,
-palettes and backend fields. That is the reason why you can use bodytext,
-image and assets without having to do a database compare.
-
-**G**
-
-**Global TYPO3 variables**: In TYPO3 there is a global TYPO3 configuration array
-($GLOBALS) where you can declare :ref:`global settings/variables <t3coreapi:typo3ConfVars>`
-for your TYPO3 instance. There are many different options. For example: BE -
-backend configuration, DB - database connections and many more.
-
-**H**
-
-**I**
-
-**Integrator**: An integrator is a person who connects and configures external
-systems, services, or data sources with the TYPO3 platform, ensuring smooth
-integration and functionality across different tools and applications.
-
-**Installtool password**: The Install Tool password is a secure password used to
-access the Install Tool, a tool that allows administrators to configure and
-manage the TYPO3 system, including database connections and system settings.
-
-**J**
-
-**K**
-
-**L**
-
-**Local development**: It is common practice to develop locally on your local
-machine first. Later when you are sure about your website you can think about
-deployment and setting up a production environment which has better performance and
-Content Security Policy settings.
-
-**Local extension**:
-
-**LTS**: LTS (Long-Term Support) in TYPO3 refers to a version of the software
-that receives extended updates and security fixes for several years, ensuring
-stability and reliability for businesses and long-term projects.
-
-**Language file**: A language file is a file that contains translated text for
-a website, allowing content to be displayed in different languages based
-on a user’s preferences or settings.
-
-**Layouts**: Layouts are templates that define the structure and design of
-content elements on a website, allowing you to customize how content is
-presented on different pages.
-
-**Log Folder**: The log folder is a directory where system logs are stored,
-helping administrators track errors, events, and activities to diagnose and
-troubleshoot issues with a website.
-
-**Legacy installation**:
-
-**M**
-
-**N**
-
-**O**
-
-**P**
-
-**Production server**: A production server is the live server where a fully
-developed website is hosted, making it accessible to users on the internet, and
-it typically has optimized settings for performance and security.
-
-**Partial**: A partial is a small or large HTML code snippet that can be used
-often and in multiple places. Here we
-:ref:`split up the template into partials <t3sitepackage:partials>`.
-
-**Public**:
-
-**Permissions**: Permissions control what users can see and do within a system,
-such as editing content, managing files, or configuring settings, based on their
-assigned roles and access levels.
-
-**PHP**: PHP is a programming language used in TYPO3 to create dynamic web pages
-and handle server-side logic, enabling features like content management, user
-interactions, and database access.
-
-**Page tree**: The Page Tree is a hierarchical structure that represents pages and
-their subpages on a website, allowing you to easily organize and manage content and
-navigation.
-
-**Q**
-
-**R**
-
-**Resources**: In TYPO3, resources refer to files such as images, documents, and
-other media that are used on a website, which are stored and managed through the
-File Abstraction Layer (FAL) for easy access and organization.
-
-**Root page**: The :ref:`Root Page <t3start:create-root-page>` is the top-level page in the Page Tree, serving as
-the starting point for a website's structure and is the foundation for the site's
-overall configuration and settings.
-
-**Reference index**: The Reference Index is a system that keeps track of all
-content elements, files, and records that are linked or referenced throughout the
-website, helping maintain data integrity and consistency.
-
-**S**
-
-**Symlink**: A symlink (symbolic link) is a shortcut or reference to a file or
-directory located elsewhere on the server, allowing you to link content or
-resources without duplicating them.
-
-**Snapshot**: A snapshot is a backup or saved version of a website's content,
-settings, and configuration at a specific point in time, which can be restored if needed.
-
-**Static file**: In the context of templating we say a html file is "static"
-when it does not use Fluid but only plain HTML.
-
-**Site Package**: A :ref:`site package <t3coreapi:site-package>` is a custom
-extension that includes all the necessary templates, configurations and settings
-to create and manage a specific website, allowing for easy setup and deployment.
-
-**Site Set**: Site sets refer to configurations that define specific settings for
-different websites or domains within a multi-site setup, allowing you to manage
-multiple websites from a single TYPO3 installation.
-
-**Site Configuration**: Site configuration is the setup that defines the settings
-for a specific website or domain, such as its language, routing, and templates,
-enabling TYPO3 to serve the correct content for that site.
-
-**System extension**: A system extension is a built-in extension that provides
-essential functionality and features for the core system, such as user management,
-backend tools, and caching, which are necessary for the website to operate.
-
-**SEO**: SEO (Search Engine Optimization) refers to the process of optimizing a
-website's content, structure and technical settings to improve its visibility
-and ranking in search engine results, helping to attract more visitors.
-
-**System maintainer**: A System Maintainer is a person responsible for managing
-and maintaining the overall health and performance of a TYPO3 installation,
-ensuring that the system is up to date, secure, and running smoothly.
-
-**T**
-
-**Third-party extension**: A third-party extension is an add-on developed by
-external developers or companies. They extend the functionality of TYPO3,
-providing additional features or integrations not included in the core system.
-
-**TCA**:
-
-**Template**: A HTML (Fluid) template is used to output HTML code.
-See also :ref:`Fluid Templates <t3sitepackage:fluid-templates>`. Usually we use
-:ref:`Fluid<t3coreapi:fluid>` and the :ref:`ViewHelpers<t3viewhelper:start>`.
-Get an :ref:`introduction to Fluid templates <t3start:fluid-templates>`.
-
-**Templating**: The templating engine that TYPO3 uses is Fluid.
-
-**TER**: TER (TYPO3 Extension Repository) is an online platform where developers can share and download extensions,
-allowing users to easily extend the functionality of their TYPO3 installation.
-
-**TypoScript**: :ref:`TypoScript<t3tsref:start>` is the basic configuration
-language used to configure the frontend output of a page in TYPO3.
-
-**Top-level objects**: Top-level objects are core components or elements, such
-as pages or content objects, that serve as starting points for building and
-organizing the structure and content of a website.
-
-**Testing**: Testing involves checking the functionality, performance, and
-security of a website or extension to ensure everything works as expected before
-deployment or during updates.
-
-**TSconfig**: In TYPO3 you can set how the TYPO3 backend looks with
-TSconfig files. You can set page related appearance, backend user related
-appearance and backend user group appearance. You can use
-:ref:`TSconfig Reference <t3tsconfig:start>` as a overall reference to look up
-settings that you can use for TSconfig. Normally you keep all
-your settings in TSconfig files like
-EXT:my_extension/Configuration/Sets/MyExtension/page.tsconfig.
-
-**U**
-
-**Update**:
-
-**V**
-
-**Vendor folder**: The vendor folder is where external libraries and dependencies,
-such as third-party extensions and frameworks, are stored. They are typically
-managed by Composer, to be used by the TYPO3 system.
-
-**Var folder**: The var folder is used to store temporary files, cached data,
-logs, and other system-related information that helps the system function
-efficiently during runtime.
-
-**ViewHelper**: A view helper is a reusable function or tool used in Fluid
-templates to manipulate or display data in a specific way, helping to keep
-templates clean and organized.
-
-**W**
-
-**X**
-
-**Y**
-
-**Z**
+ **Backend**:
+ The :ref:`backend <t3start:backend>` is the administrative interface for editors and administrators.
+
+ **Block syntax**:
+ In TypoScript you can use block syntax to enhance the readability of your code.
+
+ **Bootstrap**:
+ `Bootstrap <https://getbootstrap.com/>`__ is a popular, beginner-friendly framework for building responsive, mobile-first
+ websites using pre-designed HTML, CSS, and JavaScript components.
+
+ **Class**:
+ In PHP we can define classes located in the directory
+ EXT:my_extension/Classes. If the namespace is correct they will be loaded
+ automatically.
+
+ **Cache**:
+ :ref:`Caches <t3start:cache>` are used to improve website performance by storing frequently
+ accessed data. TYPO3 has multiple caches for various performance-relevant areas in both the frontend and backend.
+
+ **cObject**:
+ A :ref:`cObject (content object) <t3tsref:cobject>` is a core concept used to render content types on a website,
+ allowing developers to define and control how content elements like text, images, and menus are displayed.
+
+ **Character Set**:
+ A `character set <https://www.w3.org/International/getting-started/characters.en.html>`__
+ is a collection of letters and symbols used in a writing system.
+
+ **Composer**:
+ `Composer <https://getcomposer.org/>`__ is a tool used in TYPO3 to install, update, and manage extensions and libraries,
+ making it simple to handle dependencies and keep the system up to date.
+
+ **Compression**:
+ In TypoScript you can compress css and js files.
+
+ **CMS**:
+ A CMS, or Content Management System, is software like TYPO3 that allows users to create, edit,
+ and manage website content without needing to code, making it easier to maintain and update websites.
+
+ **Content Security Policy**:
+ A Content Security Policy (CSP)
+ makes the frontend and backend more secure from attacks by restricting the rules
+ governing what a user of a website or TYPO3 backend can do. CSP is a W3C standard
+ valid for everyone. TYPO3 provides a backend module that manages
+ this security feature. CSP helps to protect your website from
+ attacks by controlling which resources (like scripts, styles, or images) are
+ loaded, reducing the risk of malicious content being injected. To
+ configure CSP go to :ref:`Content Security Policy <t3coreapi:content-security-policy>`.
+
+ **CType**:
+ CType refers to Content Type and is a database column field in a very
+ important database table called 'tt_content' which stores all the content elements.
+ The column defines the name of the content element, and influences how it is
+ displayed in the backend and frontend.
+
+ **Database**:
+ A database stores and manages all a website's content, settings, and configurations,
+ allowing the system to retrieve and display data dynamically on the site.
+
+ **Documentation**:
+ Documentation consists of detailed guides and instructions to help users and developers understand,
+ set up, and customize TYPO3, making it easier to work with the system effectively.
+
+ **Docker**:
+ `Docker <https://www.docker.com/>`__ is a tool that runs TYPO3 in a consistent and isolated environment by packaging it with all its
+ dependencies, making setup, deployment, and development easier and more reliable.
+
+ **DDEV**:
+ `DDEV <https://ddev.com/>`__ is a local development tool that simplifies setting up a TYPO3 environment on your computer, making it
+ easy to start developing, testing, and managing TYPO3 projects without complex configuration.
+
+ **Deployment**:
+ :ref:`Deployment <t3start:deployment>` refers to the process of transferring your website’s code, content, and settings from a
+ development environment to a live server, making it accessible to users online.
+
+ **Debug mode**:
+ Debug Mode is a feature that helps developers find and fix errors by showing detailed information
+ about a website’s processes and any issues with the code.
+
+ **Developer**:
+ A developer is someone who builds, customizes, and maintains a website, creating new features,
+ fixing issues, and ensuring everything works smoothly for users and administrators.
+
+ **Dependencies**:
+ In Composer there are usually dependencies that have to be installed too.
+
+ **Editor**:
+ An editor is a user who creates and manages content on a website, such as adding text, images, and links,
+ without needing technical or coding knowledge.
+
+ **Extension**:
+ An :ref:`extension <t3start:concepts-extensions>` is an add-on that provides additional features or functionality to a website,
+ allowing you to customize and expand what TYPO3 can do.
+
+ **Extension Configuration**:
+
+ **Error page**:
+ An error page is a custom page that is displayed to users when something goes wrong,
+ such as when a page is not found (404) or there is a server issue (500).
+
+ **Fluid**:
+ Fluid is a PHP template engine and is the de facto standard for any
+ HTML-based output in the TYPO3 CMS. See :ref:`Fluid Reference<t3coreapi:fluid>`
+ for further details.
+
+ **Fileadmin**:
+ Fileadmin is a folder structure where you can organize and manage all the files, such as images,
+ documents, and media, that are used on your website.
+
+ **Filelist**:
+ The filelist is a backend module where you can upload files and
+ manage your uploaded files.
+
+ **FAL**:
+ :ref:`File abstraction layer (FAL) <t3coreapi:fal_introduction>` is a
+ system that manages and organizes media files, allowing you to easily store,
+ access, and use files across the entire website in a standardized way.
+
+ **Frontend**:
+ The :ref:`frontend <t3start:frontend>` is the publicly accessible part of a website.
+
+ **Frontend login**:
+ You can implement a frontend login on your website. To
+ implement this use the system extension felogin provided by TYPO3.
+
+ **Fluid styled content extension**:
+ The fluid styled content extension is a
+ system extension provided by TYPO3 that gives you default content elements,
+ palettes and backend fields. That is the reason why you can use bodytext,
+ image and assets without having to do a database compare.
+
+ **Global TYPO3 variables**:
+ In TYPO3 there is a global TYPO3 configuration array
+ ($GLOBALS) where you can declare :ref:`global settings/variables <t3coreapi:typo3ConfVars>`
+ for your TYPO3 instance. There are many different options. For example: BE -
+ backend configuration, DB - database connections and many more.
+
+ **Integrator**:
+ An integrator is a person who connects and configures external
+ systems, services, or data sources with the TYPO3 platform, ensuring smooth
+ integration and functionality across different tools and applications.
+
+ **Installtool password**:
+ The Install Tool password is a secure password used to
+ access the Install Tool, a tool that allows administrators to configure and
+ manage the TYPO3 system, including database connections and system settings.
+
+ **Local development**:
+ It is common practice to develop locally on your local
+ machine first. Later when you are sure about your website you can think about
+ deployment and setting up a production environment which has better performance and
+ Content Security Policy settings.
+
+ **Local extension**:
+
+ **LTS**:
+ LTS (Long-Term Support) in TYPO3 refers to a version of the software
+ that receives extended updates and security fixes for several years, ensuring
+ stability and reliability for businesses and long-term projects.
+
+ **Language file**:
+ A language file is a file that contains translated text for
+ a website, allowing content to be displayed in different languages based
+ on a user’s preferences or settings.
+
+ **Layouts**:
+ Layouts are templates that define the structure and design of
+ content elements on a website, allowing you to customize how content is
+ presented on different pages.
+
+ **Log Folder**:
+ The log folder is a directory where system logs are stored,
+ helping administrators track errors, events, and activities to diagnose and
+ troubleshoot issues with a website.
+
+ **Legacy installation**:
+
+ **Production server**:
+ A production server is the live server where a fully
+ developed website is hosted, making it accessible to users on the internet, and
+ it typically has optimized settings for performance and security.
+
+ **Partial**:
+ A partial is a small or large HTML code snippet that can be used
+ often and in multiple places. Here we
+ :ref:`split up the template into partials <t3sitepackage:partials>`.
+
+ **Public**:
+
+ **Permissions**:
+ Permissions control what users can see and do within a system,
+ such as editing content, managing files, or configuring settings, based on their
+ assigned roles and access levels.
+
+ **PHP**:
+ PHP is a programming language used in TYPO3 to create dynamic web pages
+ and handle server-side logic, enabling features like content management, user
+ interactions, and database access.
+
+ **Page tree**:
+ The Page Tree is a hierarchical structure that represents pages and
+ their subpages on a website, allowing you to easily organize and manage content and
+ navigation.
+
+ **Resources**:
+ In TYPO3, resources refer to files such as images, documents, and
+ other media that are used on a website, which are stored and managed through the
+ File Abstraction Layer (FAL) for easy access and organization.
+
+ **Root page**:
+ The :ref:`Root Page <t3start:create-root-page>` is the top-level page in the Page Tree, serving as
+ the starting point for a website's structure and is the foundation for the site's
+ overall configuration and settings.
+
+ **Reference index**:
+ The Reference Index is a system that keeps track of all
+ content elements, files, and records that are linked or referenced throughout the
+ website, helping maintain data integrity and consistency.
+
+ **Symlink**:
+ A symlink (symbolic link) is a shortcut or reference to a file or
+ directory located elsewhere on the server, allowing you to link content or
+ resources without duplicating them.
+
+ **Snapshot**:
+ A snapshot is a backup or saved version of a website's content,
+ settings, and configuration at a specific point in time, which can be restored if needed.
+
+ **Static file**:
+ In the context of templating we say a html file is "static"
+ when it does not use Fluid but only plain HTML.
+
+ **Site Package**:
+ A :ref:`site package <t3coreapi:site-package>` is a custom
+ extension that includes all the necessary templates, configurations and settings
+ to create and manage a specific website, allowing for easy setup and deployment.
+
+ **Site Set**:
+ Site sets refer to configurations that define specific settings for
+ different websites or domains within a multi-site setup, allowing you to manage
+ multiple websites from a single TYPO3 installation.
+
+ **Site Configuration**:
+ Site configuration is the setup that defines the settings
+ for a specific website or domain, such as its language, routing, and templates,
+ enabling TYPO3 to serve the correct content for that site.
+
+ **System extension**:
+ A system extension is a built-in extension that provides
+ essential functionality and features for the core system, such as user management,
+ backend tools, and caching, which are necessary for the website to operate.
+
+ **SEO**:
+ SEO (Search Engine Optimization) refers to the process of optimizing a
+ website's content, structure and technical settings to improve its visibility
+ and ranking in search engine results, helping to attract more visitors.
+
+ **System maintainer**:
+ A System Maintainer is a person responsible for managing
+ and maintaining the overall health and performance of a TYPO3 installation,
+ ensuring that the system is up to date, secure, and running smoothly.
+
+ **Third-party extension**:
+ A third-party extension is an add-on developed by
+ external developers or companies. They extend the functionality of TYPO3,
+ providing additional features or integrations not included in the core system.
+
+ **TCA**:
+
+ **Template**:
+ A HTML (Fluid) template is used to output HTML code.
+ See also :ref:`Fluid Templates <t3sitepackage:fluid-templates>`. Usually we use
+ :ref:`Fluid<t3coreapi:fluid>` and the :ref:`ViewHelpers<t3viewhelper:start>`.
+ Get an :ref:`introduction to Fluid templates <t3start:fluid-templates>`.
+
+ **Templating**:
+ The templating engine that TYPO3 uses is Fluid.
+
+ **TER**:
+ TER (TYPO3 Extension Repository) is an online platform where developers can share and download extensions,
+ allowing users to easily extend the functionality of their TYPO3 installation.
+
+ **TypoScript**:
+ :ref:`TypoScript<t3tsref:start>` is the basic configuration
+ language used to configure the frontend output of a page in TYPO3.
+
+ **Top-level objects**:
+ Top-level objects are core components or elements, such
+ as pages or content objects, that serve as starting points for building and
+ organizing the structure and content of a website.
+
+ **Testing**:
+ Testing involves checking the functionality, performance, and
+ security of a website or extension to ensure everything works as expected before
+ deployment or during updates.
+
+ **TSconfig**:
+ In TYPO3 you can set how the TYPO3 backend looks with
+ TSconfig files. You can set page related appearance, backend user related
+ appearance and backend user group appearance. You can use
+ :ref:`TSconfig Reference <t3tsconfig:start>` as a overall reference to look up
+ settings that you can use for TSconfig. Normally you keep all
+ your settings in TSconfig files like
+ EXT:my_extension/Configuration/Sets/MyExtension/page.tsconfig.
+
+ **Update**:
+
+ **Vendor folder**:
+ The vendor folder is where external libraries and dependencies,
+ such as third-party extensions and frameworks, are stored. They are typically
+ managed by Composer, to be used by the TYPO3 system.
+
+ **Var folder**:
+ The var folder is used to store temporary files, cached data,
+ logs, and other system-related information that helps the system function
+ efficiently during runtime.
+
+ **ViewHelper**:
+ A view helper is a reusable function or tool used in Fluid
+ templates to manipulate or display data in a specific way, helping to keep
+ templates clean and organized.
From 631194c0736ccb9292139187bba742606e650b5e Mon Sep 17 00:00:00 2001
From: Lina Wolf <48202465+linawolf@users.noreply.github.com>
Date: Fri, 6 Dec 2024 12:48:11 +0100
Subject: [PATCH 8/8] Update Index.rst
---
Documentation/Glossary/Index.rst | 163 +++++++++++++++----------------
1 file changed, 81 insertions(+), 82 deletions(-)
diff --git a/Documentation/Glossary/Index.rst b/Documentation/Glossary/Index.rst
index de963d05..df573df9 100644
--- a/Documentation/Glossary/Index.rst
+++ b/Documentation/Glossary/Index.rst
@@ -2,76 +2,75 @@
.. _getting-started-glossary-index:
-
-.. todo: Note for contributing
-.. todo: Links for further information
-.. todo: Add missing descriptions
-
========
Glossary
========
+.. todo: Note for contributing
+.. todo: Links for further information
+.. todo: Add missing descriptions
+
.. glossary::
- **Apache**:
+ Apache
`Apache httpd <https://en.wikipedia.org/wiki/Apache_HTTP_Server>`__
is a web server. Others are Nginx, Microsoft IIS and Caddy Server (`see system requirements <https://get.typo3.org/version/13#system-requirements>`__).
- **Admin Tools**:
+ Admin Tools
Admin tools are a group of backend modules.
These include maintaining the installation, adjusting settings, executing upgrade wizards,
checking environment information and setting up extensions.
- **Admin User**:
+ Admin User
- **Assets**:
+ Assets
:ref:`Assets <t3start:webroot>` are media resources such as images, videos and documents that are uploaded and managed in TYPO3 system.
Also, extensions can include assets which used in the frontend, like icons or JavaScript libraries.
- **Application context**:
+ Application context
In TYPO3, the :ref:`Application Context <t3coreapi:application-context>` is the environment
(e.g., Development, Production) the site is running in, which sets things like debugging or
performance optimization accordingly. This helps tailor TYPO3 behavior for each stage of deployment.
- **Backend**:
+ Backend
The :ref:`backend <t3start:backend>` is the administrative interface for editors and administrators.
- **Block syntax**:
+ Block syntax
In TypoScript you can use block syntax to enhance the readability of your code.
- **Bootstrap**:
+ Bootstrap
`Bootstrap <https://getbootstrap.com/>`__ is a popular, beginner-friendly framework for building responsive, mobile-first
websites using pre-designed HTML, CSS, and JavaScript components.
- **Class**:
+ Class
In PHP we can define classes located in the directory
EXT:my_extension/Classes. If the namespace is correct they will be loaded
automatically.
- **Cache**:
+ Cache
:ref:`Caches <t3start:cache>` are used to improve website performance by storing frequently
accessed data. TYPO3 has multiple caches for various performance-relevant areas in both the frontend and backend.
- **cObject**:
+ cObject
A :ref:`cObject (content object) <t3tsref:cobject>` is a core concept used to render content types on a website,
allowing developers to define and control how content elements like text, images, and menus are displayed.
- **Character Set**:
+ Character Set
A `character set <https://www.w3.org/International/getting-started/characters.en.html>`__
is a collection of letters and symbols used in a writing system.
- **Composer**:
+ Composer
`Composer <https://getcomposer.org/>`__ is a tool used in TYPO3 to install, update, and manage extensions and libraries,
making it simple to handle dependencies and keep the system up to date.
- **Compression**:
+ Compression
In TypoScript you can compress css and js files.
- **CMS**:
+ CMS
A CMS, or Content Management System, is software like TYPO3 that allows users to create, edit,
and manage website content without needing to code, making it easier to maintain and update websites.
- **Content Security Policy**:
+ Content Security Policy
A Content Security Policy (CSP)
makes the frontend and backend more secure from attacks by restricting the rules
governing what a user of a website or TYPO3 backend can do. CSP is a W3C standard
@@ -81,254 +80,254 @@ Glossary
loaded, reducing the risk of malicious content being injected. To
configure CSP go to :ref:`Content Security Policy <t3coreapi:content-security-policy>`.
- **CType**:
+ CType
CType refers to Content Type and is a database column field in a very
important database table called 'tt_content' which stores all the content elements.
The column defines the name of the content element, and influences how it is
displayed in the backend and frontend.
- **Database**:
+ Database
A database stores and manages all a website's content, settings, and configurations,
allowing the system to retrieve and display data dynamically on the site.
- **Documentation**:
+ Documentation
Documentation consists of detailed guides and instructions to help users and developers understand,
set up, and customize TYPO3, making it easier to work with the system effectively.
- **Docker**:
+ Docker
`Docker <https://www.docker.com/>`__ is a tool that runs TYPO3 in a consistent and isolated environment by packaging it with all its
dependencies, making setup, deployment, and development easier and more reliable.
- **DDEV**:
+ DDEV
`DDEV <https://ddev.com/>`__ is a local development tool that simplifies setting up a TYPO3 environment on your computer, making it
easy to start developing, testing, and managing TYPO3 projects without complex configuration.
- **Deployment**:
+ Deployment
:ref:`Deployment <t3start:deployment>` refers to the process of transferring your website’s code, content, and settings from a
development environment to a live server, making it accessible to users online.
- **Debug mode**:
+ Debug mode
Debug Mode is a feature that helps developers find and fix errors by showing detailed information
about a website’s processes and any issues with the code.
- **Developer**:
+ Developer
A developer is someone who builds, customizes, and maintains a website, creating new features,
fixing issues, and ensuring everything works smoothly for users and administrators.
- **Dependencies**:
+ Dependencies
In Composer there are usually dependencies that have to be installed too.
- **Editor**:
+ Editor
An editor is a user who creates and manages content on a website, such as adding text, images, and links,
without needing technical or coding knowledge.
- **Extension**:
+ Extension
An :ref:`extension <t3start:concepts-extensions>` is an add-on that provides additional features or functionality to a website,
allowing you to customize and expand what TYPO3 can do.
- **Extension Configuration**:
+ Extension Configuration
- **Error page**:
+ Error page
An error page is a custom page that is displayed to users when something goes wrong,
such as when a page is not found (404) or there is a server issue (500).
- **Fluid**:
+ Fluid
Fluid is a PHP template engine and is the de facto standard for any
HTML-based output in the TYPO3 CMS. See :ref:`Fluid Reference<t3coreapi:fluid>`
for further details.
- **Fileadmin**:
+ Fileadmin
Fileadmin is a folder structure where you can organize and manage all the files, such as images,
documents, and media, that are used on your website.
- **Filelist**:
+ Filelist
The filelist is a backend module where you can upload files and
manage your uploaded files.
- **FAL**:
+ FAL
:ref:`File abstraction layer (FAL) <t3coreapi:fal_introduction>` is a
system that manages and organizes media files, allowing you to easily store,
access, and use files across the entire website in a standardized way.
- **Frontend**:
+ Frontend
The :ref:`frontend <t3start:frontend>` is the publicly accessible part of a website.
- **Frontend login**:
+ Frontend login
You can implement a frontend login on your website. To
implement this use the system extension felogin provided by TYPO3.
- **Fluid styled content extension**:
+ Fluid styled content extension
The fluid styled content extension is a
system extension provided by TYPO3 that gives you default content elements,
palettes and backend fields. That is the reason why you can use bodytext,
image and assets without having to do a database compare.
- **Global TYPO3 variables**:
+ Global TYPO3 variables
In TYPO3 there is a global TYPO3 configuration array
($GLOBALS) where you can declare :ref:`global settings/variables <t3coreapi:typo3ConfVars>`
for your TYPO3 instance. There are many different options. For example: BE -
backend configuration, DB - database connections and many more.
- **Integrator**:
+ Integrator
An integrator is a person who connects and configures external
systems, services, or data sources with the TYPO3 platform, ensuring smooth
integration and functionality across different tools and applications.
- **Installtool password**:
+ Installtool password
The Install Tool password is a secure password used to
access the Install Tool, a tool that allows administrators to configure and
manage the TYPO3 system, including database connections and system settings.
- **Local development**:
+ Local development
It is common practice to develop locally on your local
machine first. Later when you are sure about your website you can think about
deployment and setting up a production environment which has better performance and
Content Security Policy settings.
- **Local extension**:
+ Local extension
- **LTS**:
+ LTS
LTS (Long-Term Support) in TYPO3 refers to a version of the software
that receives extended updates and security fixes for several years, ensuring
stability and reliability for businesses and long-term projects.
- **Language file**:
+ Language file
A language file is a file that contains translated text for
a website, allowing content to be displayed in different languages based
on a user’s preferences or settings.
- **Layouts**:
+ Layouts
Layouts are templates that define the structure and design of
content elements on a website, allowing you to customize how content is
presented on different pages.
- **Log Folder**:
+ Log Folder
The log folder is a directory where system logs are stored,
helping administrators track errors, events, and activities to diagnose and
troubleshoot issues with a website.
- **Legacy installation**:
+ Legacy installation
- **Production server**:
+ Production server
A production server is the live server where a fully
developed website is hosted, making it accessible to users on the internet, and
it typically has optimized settings for performance and security.
- **Partial**:
+ Partial
A partial is a small or large HTML code snippet that can be used
often and in multiple places. Here we
:ref:`split up the template into partials <t3sitepackage:partials>`.
- **Public**:
+ Public
- **Permissions**:
+ Permissions
Permissions control what users can see and do within a system,
such as editing content, managing files, or configuring settings, based on their
assigned roles and access levels.
- **PHP**:
+ PHP
PHP is a programming language used in TYPO3 to create dynamic web pages
and handle server-side logic, enabling features like content management, user
interactions, and database access.
- **Page tree**:
+ Page tree
The Page Tree is a hierarchical structure that represents pages and
their subpages on a website, allowing you to easily organize and manage content and
navigation.
- **Resources**:
+ Resources
In TYPO3, resources refer to files such as images, documents, and
other media that are used on a website, which are stored and managed through the
File Abstraction Layer (FAL) for easy access and organization.
- **Root page**:
+ Root page
The :ref:`Root Page <t3start:create-root-page>` is the top-level page in the Page Tree, serving as
the starting point for a website's structure and is the foundation for the site's
overall configuration and settings.
- **Reference index**:
+ Reference index
The Reference Index is a system that keeps track of all
content elements, files, and records that are linked or referenced throughout the
website, helping maintain data integrity and consistency.
- **Symlink**:
+ Symlink
A symlink (symbolic link) is a shortcut or reference to a file or
directory located elsewhere on the server, allowing you to link content or
resources without duplicating them.
- **Snapshot**:
+ Snapshot
A snapshot is a backup or saved version of a website's content,
settings, and configuration at a specific point in time, which can be restored if needed.
- **Static file**:
+ Static file
In the context of templating we say a html file is "static"
when it does not use Fluid but only plain HTML.
- **Site Package**:
+ Site Package
A :ref:`site package <t3coreapi:site-package>` is a custom
extension that includes all the necessary templates, configurations and settings
to create and manage a specific website, allowing for easy setup and deployment.
- **Site Set**:
+ Site Set
Site sets refer to configurations that define specific settings for
different websites or domains within a multi-site setup, allowing you to manage
multiple websites from a single TYPO3 installation.
- **Site Configuration**:
+ Site Configuration
Site configuration is the setup that defines the settings
for a specific website or domain, such as its language, routing, and templates,
enabling TYPO3 to serve the correct content for that site.
- **System extension**:
+ System extension
A system extension is a built-in extension that provides
essential functionality and features for the core system, such as user management,
backend tools, and caching, which are necessary for the website to operate.
- **SEO**:
+ SEO
SEO (Search Engine Optimization) refers to the process of optimizing a
website's content, structure and technical settings to improve its visibility
and ranking in search engine results, helping to attract more visitors.
- **System maintainer**:
+ System maintainer
A System Maintainer is a person responsible for managing
and maintaining the overall health and performance of a TYPO3 installation,
ensuring that the system is up to date, secure, and running smoothly.
- **Third-party extension**:
+ Third-party extension
A third-party extension is an add-on developed by
external developers or companies. They extend the functionality of TYPO3,
providing additional features or integrations not included in the core system.
- **TCA**:
+ TCA
- **Template**:
+ Template
A HTML (Fluid) template is used to output HTML code.
See also :ref:`Fluid Templates <t3sitepackage:fluid-templates>`. Usually we use
:ref:`Fluid<t3coreapi:fluid>` and the :ref:`ViewHelpers<t3viewhelper:start>`.
Get an :ref:`introduction to Fluid templates <t3start:fluid-templates>`.
- **Templating**:
+ Templating
The templating engine that TYPO3 uses is Fluid.
- **TER**:
+ TER
TER (TYPO3 Extension Repository) is an online platform where developers can share and download extensions,
allowing users to easily extend the functionality of their TYPO3 installation.
- **TypoScript**:
+ TypoScript
:ref:`TypoScript<t3tsref:start>` is the basic configuration
language used to configure the frontend output of a page in TYPO3.
- **Top-level objects**:
+ Top-level objects
Top-level objects are core components or elements, such
as pages or content objects, that serve as starting points for building and
organizing the structure and content of a website.
- **Testing**:
+ Testing
Testing involves checking the functionality, performance, and
security of a website or extension to ensure everything works as expected before
deployment or during updates.
- **TSconfig**:
+ TSconfig
In TYPO3 you can set how the TYPO3 backend looks with
TSconfig files. You can set page related appearance, backend user related
appearance and backend user group appearance. You can use
@@ -337,19 +336,19 @@ Glossary
your settings in TSconfig files like
EXT:my_extension/Configuration/Sets/MyExtension/page.tsconfig.
- **Update**:
+ Update
- **Vendor folder**:
+ Vendor folder
The vendor folder is where external libraries and dependencies,
such as third-party extensions and frameworks, are stored. They are typically
managed by Composer, to be used by the TYPO3 system.
- **Var folder**:
+ Var folder
The var folder is used to store temporary files, cached data,
logs, and other system-related information that helps the system function
efficiently during runtime.
- **ViewHelper**:
+ ViewHelper
A view helper is a reusable function or tool used in Fluid
templates to manipulate or display data in a specific way, helping to keep
templates clean and organized.