From 783b7854e010484d6f68029b3b53c8736242ba65 Mon Sep 17 00:00:00 2001 From: Kiebele Date: Fri, 8 Nov 2024 17:16:39 +0100 Subject: [PATCH] [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` 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) ` 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 ` 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 `. **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` 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**