Skip to content

Commit 0a9bf17

Browse files
mkiebeleAlagtsKiebelesarahmccarthy123linawolf
authored
Glossary (#616)
* Start glossary * [FIX] Changed :t3ext: to :composer: * [TASK] Add descriptions in glossary * [TASK] Glossary: Improve and add missing descriptions * [TASK] Small language corrections * [TASK] Add links in glossary * [Task] changed to glossary directive * Update Index.rst --------- Co-authored-by: Sandra Erbel <[email protected]> Co-authored-by: Kiebele <[email protected]> Co-authored-by: Sarah McCarthy <[email protected]> Co-authored-by: Lina Wolf <[email protected]>
1 parent 19a6598 commit 0a9bf17

File tree

2 files changed

+362
-0
lines changed

2 files changed

+362
-0
lines changed

‎Documentation/Glossary/Index.rst‎

Lines changed: 354 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,354 @@
1+
.. include:: /Includes.rst.txt
2+
3+
.. _getting-started-glossary-index:
4+
5+
========
6+
Glossary
7+
========
8+
9+
.. todo: Note for contributing
10+
.. todo: Links for further information
11+
.. todo: Add missing descriptions
12+
13+
.. glossary::
14+
15+
Apache
16+
`Apache httpd <https://en.wikipedia.org/wiki/Apache_HTTP_Server>`__
17+
is a web server. Others are Nginx, Microsoft IIS and Caddy Server (`see system requirements <https://get.typo3.org/version/13#system-requirements>`__).
18+
19+
Admin Tools
20+
Admin tools are a group of backend modules.
21+
These include maintaining the installation, adjusting settings, executing upgrade wizards,
22+
checking environment information and setting up extensions.
23+
24+
Admin User
25+
26+
Assets
27+
:ref:`Assets <t3start:webroot>` are media resources such as images, videos and documents that are uploaded and managed in TYPO3 system.
28+
Also, extensions can include assets which used in the frontend, like icons or JavaScript libraries.
29+
30+
Application context
31+
In TYPO3, the :ref:`Application Context <t3coreapi:application-context>` is the environment
32+
(e.g., Development, Production) the site is running in, which sets things like debugging or
33+
performance optimization accordingly. This helps tailor TYPO3 behavior for each stage of deployment.
34+
35+
Backend
36+
The :ref:`backend <t3start:backend>` is the administrative interface for editors and administrators.
37+
38+
Block syntax
39+
In TypoScript you can use block syntax to enhance the readability of your code.
40+
41+
Bootstrap
42+
`Bootstrap <https://getbootstrap.com/>`__ is a popular, beginner-friendly framework for building responsive, mobile-first
43+
websites using pre-designed HTML, CSS, and JavaScript components.
44+
45+
Class
46+
In PHP we can define classes located in the directory
47+
EXT:my_extension/Classes. If the namespace is correct they will be loaded
48+
automatically.
49+
50+
Cache
51+
:ref:`Caches <t3start:cache>` are used to improve website performance by storing frequently
52+
accessed data. TYPO3 has multiple caches for various performance-relevant areas in both the frontend and backend.
53+
54+
cObject
55+
A :ref:`cObject (content object) <t3tsref:cobject>` is a core concept used to render content types on a website,
56+
allowing developers to define and control how content elements like text, images, and menus are displayed.
57+
58+
Character Set
59+
A `character set <https://www.w3.org/International/getting-started/characters.en.html>`__
60+
is a collection of letters and symbols used in a writing system.
61+
62+
Composer
63+
`Composer <https://getcomposer.org/>`__ is a tool used in TYPO3 to install, update, and manage extensions and libraries,
64+
making it simple to handle dependencies and keep the system up to date.
65+
66+
Compression
67+
In TypoScript you can compress css and js files.
68+
69+
CMS
70+
A CMS, or Content Management System, is software like TYPO3 that allows users to create, edit,
71+
and manage website content without needing to code, making it easier to maintain and update websites.
72+
73+
Content Security Policy
74+
A Content Security Policy (CSP)
75+
makes the frontend and backend more secure from attacks by restricting the rules
76+
governing what a user of a website or TYPO3 backend can do. CSP is a W3C standard
77+
valid for everyone. TYPO3 provides a backend module that manages
78+
this security feature. CSP helps to protect your website from
79+
attacks by controlling which resources (like scripts, styles, or images) are
80+
loaded, reducing the risk of malicious content being injected. To
81+
configure CSP go to :ref:`Content Security Policy <t3coreapi:content-security-policy>`.
82+
83+
CType
84+
CType refers to Content Type and is a database column field in a very
85+
important database table called 'tt_content' which stores all the content elements.
86+
The column defines the name of the content element, and influences how it is
87+
displayed in the backend and frontend.
88+
89+
Database
90+
A database stores and manages all a website's content, settings, and configurations,
91+
allowing the system to retrieve and display data dynamically on the site.
92+
93+
Documentation
94+
Documentation consists of detailed guides and instructions to help users and developers understand,
95+
set up, and customize TYPO3, making it easier to work with the system effectively.
96+
97+
Docker
98+
`Docker <https://www.docker.com/>`__ is a tool that runs TYPO3 in a consistent and isolated environment by packaging it with all its
99+
dependencies, making setup, deployment, and development easier and more reliable.
100+
101+
DDEV
102+
`DDEV <https://ddev.com/>`__ is a local development tool that simplifies setting up a TYPO3 environment on your computer, making it
103+
easy to start developing, testing, and managing TYPO3 projects without complex configuration.
104+
105+
Deployment
106+
:ref:`Deployment <t3start:deployment>` refers to the process of transferring your website’s code, content, and settings from a
107+
development environment to a live server, making it accessible to users online.
108+
109+
Debug mode
110+
Debug Mode is a feature that helps developers find and fix errors by showing detailed information
111+
about a website’s processes and any issues with the code.
112+
113+
Developer
114+
A developer is someone who builds, customizes, and maintains a website, creating new features,
115+
fixing issues, and ensuring everything works smoothly for users and administrators.
116+
117+
Dependencies
118+
In Composer there are usually dependencies that have to be installed too.
119+
120+
Editor
121+
An editor is a user who creates and manages content on a website, such as adding text, images, and links,
122+
without needing technical or coding knowledge.
123+
124+
Extension
125+
An :ref:`extension <t3start:concepts-extensions>` is an add-on that provides additional features or functionality to a website,
126+
allowing you to customize and expand what TYPO3 can do.
127+
128+
Extension Configuration
129+
130+
Error page
131+
An error page is a custom page that is displayed to users when something goes wrong,
132+
such as when a page is not found (404) or there is a server issue (500).
133+
134+
Fluid
135+
Fluid is a PHP template engine and is the de facto standard for any
136+
HTML-based output in the TYPO3 CMS. See :ref:`Fluid Reference<t3coreapi:fluid>`
137+
for further details.
138+
139+
Fileadmin
140+
Fileadmin is a folder structure where you can organize and manage all the files, such as images,
141+
documents, and media, that are used on your website.
142+
143+
Filelist
144+
The filelist is a backend module where you can upload files and
145+
manage your uploaded files.
146+
147+
FAL
148+
:ref:`File abstraction layer (FAL) <t3coreapi:fal_introduction>` is a
149+
system that manages and organizes media files, allowing you to easily store,
150+
access, and use files across the entire website in a standardized way.
151+
152+
Frontend
153+
The :ref:`frontend <t3start:frontend>` is the publicly accessible part of a website.
154+
155+
Frontend login
156+
You can implement a frontend login on your website. To
157+
implement this use the system extension felogin provided by TYPO3.
158+
159+
Fluid styled content extension
160+
The fluid styled content extension is a
161+
system extension provided by TYPO3 that gives you default content elements,
162+
palettes and backend fields. That is the reason why you can use bodytext,
163+
image and assets without having to do a database compare.
164+
165+
Global TYPO3 variables
166+
In TYPO3 there is a global TYPO3 configuration array
167+
($GLOBALS) where you can declare :ref:`global settings/variables <t3coreapi:typo3ConfVars>`
168+
for your TYPO3 instance. There are many different options. For example: BE -
169+
backend configuration, DB - database connections and many more.
170+
171+
Integrator
172+
An integrator is a person who connects and configures external
173+
systems, services, or data sources with the TYPO3 platform, ensuring smooth
174+
integration and functionality across different tools and applications.
175+
176+
Installtool password
177+
The Install Tool password is a secure password used to
178+
access the Install Tool, a tool that allows administrators to configure and
179+
manage the TYPO3 system, including database connections and system settings.
180+
181+
Local development
182+
It is common practice to develop locally on your local
183+
machine first. Later when you are sure about your website you can think about
184+
deployment and setting up a production environment which has better performance and
185+
Content Security Policy settings.
186+
187+
Local extension
188+
189+
LTS
190+
LTS (Long-Term Support) in TYPO3 refers to a version of the software
191+
that receives extended updates and security fixes for several years, ensuring
192+
stability and reliability for businesses and long-term projects.
193+
194+
Language file
195+
A language file is a file that contains translated text for
196+
a website, allowing content to be displayed in different languages based
197+
on a user’s preferences or settings.
198+
199+
Layouts
200+
Layouts are templates that define the structure and design of
201+
content elements on a website, allowing you to customize how content is
202+
presented on different pages.
203+
204+
Log Folder
205+
The log folder is a directory where system logs are stored,
206+
helping administrators track errors, events, and activities to diagnose and
207+
troubleshoot issues with a website.
208+
209+
Legacy installation
210+
211+
Production server
212+
A production server is the live server where a fully
213+
developed website is hosted, making it accessible to users on the internet, and
214+
it typically has optimized settings for performance and security.
215+
216+
Partial
217+
A partial is a small or large HTML code snippet that can be used
218+
often and in multiple places. Here we
219+
:ref:`split up the template into partials <t3sitepackage:partials>`.
220+
221+
Public
222+
223+
Permissions
224+
Permissions control what users can see and do within a system,
225+
such as editing content, managing files, or configuring settings, based on their
226+
assigned roles and access levels.
227+
228+
PHP
229+
PHP is a programming language used in TYPO3 to create dynamic web pages
230+
and handle server-side logic, enabling features like content management, user
231+
interactions, and database access.
232+
233+
Page tree
234+
The Page Tree is a hierarchical structure that represents pages and
235+
their subpages on a website, allowing you to easily organize and manage content and
236+
navigation.
237+
238+
Resources
239+
In TYPO3, resources refer to files such as images, documents, and
240+
other media that are used on a website, which are stored and managed through the
241+
File Abstraction Layer (FAL) for easy access and organization.
242+
243+
Root page
244+
The :ref:`Root Page <t3start:create-root-page>` is the top-level page in the Page Tree, serving as
245+
the starting point for a website's structure and is the foundation for the site's
246+
overall configuration and settings.
247+
248+
Reference index
249+
The Reference Index is a system that keeps track of all
250+
content elements, files, and records that are linked or referenced throughout the
251+
website, helping maintain data integrity and consistency.
252+
253+
Symlink
254+
A symlink (symbolic link) is a shortcut or reference to a file or
255+
directory located elsewhere on the server, allowing you to link content or
256+
resources without duplicating them.
257+
258+
Snapshot
259+
A snapshot is a backup or saved version of a website's content,
260+
settings, and configuration at a specific point in time, which can be restored if needed.
261+
262+
Static file
263+
In the context of templating we say a html file is "static"
264+
when it does not use Fluid but only plain HTML.
265+
266+
Site Package
267+
A :ref:`site package <t3coreapi:site-package>` is a custom
268+
extension that includes all the necessary templates, configurations and settings
269+
to create and manage a specific website, allowing for easy setup and deployment.
270+
271+
Site Set
272+
Site sets refer to configurations that define specific settings for
273+
different websites or domains within a multi-site setup, allowing you to manage
274+
multiple websites from a single TYPO3 installation.
275+
276+
Site Configuration
277+
Site configuration is the setup that defines the settings
278+
for a specific website or domain, such as its language, routing, and templates,
279+
enabling TYPO3 to serve the correct content for that site.
280+
281+
System extension
282+
A system extension is a built-in extension that provides
283+
essential functionality and features for the core system, such as user management,
284+
backend tools, and caching, which are necessary for the website to operate.
285+
286+
SEO
287+
SEO (Search Engine Optimization) refers to the process of optimizing a
288+
website's content, structure and technical settings to improve its visibility
289+
and ranking in search engine results, helping to attract more visitors.
290+
291+
System maintainer
292+
A System Maintainer is a person responsible for managing
293+
and maintaining the overall health and performance of a TYPO3 installation,
294+
ensuring that the system is up to date, secure, and running smoothly.
295+
296+
Third-party extension
297+
A third-party extension is an add-on developed by
298+
external developers or companies. They extend the functionality of TYPO3,
299+
providing additional features or integrations not included in the core system.
300+
301+
TCA
302+
303+
Template
304+
A HTML (Fluid) template is used to output HTML code.
305+
See also :ref:`Fluid Templates <t3sitepackage:fluid-templates>`. Usually we use
306+
:ref:`Fluid<t3coreapi:fluid>` and the :ref:`ViewHelpers<t3viewhelper:start>`.
307+
Get an :ref:`introduction to Fluid templates <t3start:fluid-templates>`.
308+
309+
Templating
310+
The templating engine that TYPO3 uses is Fluid.
311+
312+
TER
313+
TER (TYPO3 Extension Repository) is an online platform where developers can share and download extensions,
314+
allowing users to easily extend the functionality of their TYPO3 installation.
315+
316+
TypoScript
317+
:ref:`TypoScript<t3tsref:start>` is the basic configuration
318+
language used to configure the frontend output of a page in TYPO3.
319+
320+
Top-level objects
321+
Top-level objects are core components or elements, such
322+
as pages or content objects, that serve as starting points for building and
323+
organizing the structure and content of a website.
324+
325+
Testing
326+
Testing involves checking the functionality, performance, and
327+
security of a website or extension to ensure everything works as expected before
328+
deployment or during updates.
329+
330+
TSconfig
331+
In TYPO3 you can set how the TYPO3 backend looks with
332+
TSconfig files. You can set page related appearance, backend user related
333+
appearance and backend user group appearance. You can use
334+
:ref:`TSconfig Reference <t3tsconfig:start>` as a overall reference to look up
335+
settings that you can use for TSconfig. Normally you keep all
336+
your settings in TSconfig files like
337+
EXT:my_extension/Configuration/Sets/MyExtension/page.tsconfig.
338+
339+
Update
340+
341+
Vendor folder
342+
The vendor folder is where external libraries and dependencies,
343+
such as third-party extensions and frameworks, are stored. They are typically
344+
managed by Composer, to be used by the TYPO3 system.
345+
346+
Var folder
347+
The var folder is used to store temporary files, cached data,
348+
logs, and other system-related information that helps the system function
349+
efficiently during runtime.
350+
351+
ViewHelper
352+
A view helper is a reusable function or tool used in Fluid
353+
templates to manipulate or display data in a specific way, helping to keep
354+
templates clean and organized.

‎Documentation/Index.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,13 @@ system and detailed information on how to install TYPO3.
7979
.. card-footer:: :ref:`Learn how to add content and create templates <next-steps>`
8080
:button-style: btn btn-secondary stretched-link
8181

82+
.. card:: Glossary
83+
84+
Here you get an overview of important terms in TYPO3.
85+
86+
.. card-footer:: :ref:`See the glossary <getting-started-glossary-index>`
87+
:button-style: btn btn-secondary stretched-link
88+
8289
.. toctree::
8390
:hidden:
8491
:titlesonly:
@@ -90,6 +97,7 @@ system and detailed information on how to install TYPO3.
9097
Troubleshooting/Index
9198
Extensions/Index
9299
NextSteps/Index
100+
Glossary/Index
93101

94102
.. toctree::
95103
:hidden:

0 commit comments

Comments
 (0)