Skip to content

Commit

Permalink
[Backport 13.4] [TASK] Make introduction quick and short (#5091)
Browse files Browse the repository at this point in the history
* [TASK] Make introducition quick and short

Releases: main, 13.4, 12.4

* [TASK] Add minor language corrections

Releases: main, 13.4, 12.4

---------

Co-authored-by: lina.wolf <[email protected]>
Co-authored-by: Sarah McCarthy <[email protected]>
  • Loading branch information
3 people authored Nov 24, 2024
1 parent 3883690 commit aafff01
Show file tree
Hide file tree
Showing 2 changed files with 91 additions and 62 deletions.
61 changes: 61 additions & 0 deletions Documentation/ApiOverview/SystemOverview/Index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
.. include:: /Includes.rst.txt

.. _system-overview:
.. _overview:

===============
System Overview
===============

The TYPO3 system is multi-layered. The backend and frontend user interfaces
sit on top of the application layer, which in turn sits on top of the infrastructure
layer. The webserver, database and PHP in the infrastructure layer are
prerequisites for running TYPO3.

The TYPO3 Core primarily consists of an API (Application Programming Interface),
which defines a framework for managing content in the project. The API
includes functionality for content storage, user permissions and access, content
editing, and file management. This functionality is delivered via system
**extensions** that use the API. All of the content is stored in a database
that TYPO3 accesses via the API.

Extensions are clearly defined parcels of code, such as plugins, backend
modules, application logic, skins, and third-party apps.

The most important thing to note is that the TYPO3 CMS consists solely
of extensions. The most basic functions are packaged in a system extension called
"core".

.. figure:: /Images/Graphics/Typo3CmsStructure.svg
:alt: TYPO3 System layers diagram
:class: with-border
:width: 800px

Diagram showing the layers of the TYPO3 system

.. _system-overview-application:

Application layer
=================

The TYPO3 Core framework interacts with system and 3rd party extensions via
the TYPO3 extension API.

The core and extensions interact with each other seamlessly and operate as a
single, unified system.

.. _system-overview-ui:

User interface layer
====================

The backend is the **content-creation** side. It is an administrative area
where you can manage content and configuration based on the extensions that are
installed.

The frontend is the **content-delivery** side. Typically a website, it is the
meeting point for templates, CSS, content, and logic from extensions,
delivering your project to the world.
The frontend doesn't have to be a website, it can be a native mobile
application, a web application built in a frontend framework, or an API to
interface with other systems.
92 changes: 30 additions & 62 deletions Documentation/Introduction/Index.rst
Original file line number Diff line number Diff line change
@@ -1,83 +1,51 @@
.. include:: /Includes.rst.txt

.. _introduction:

============
Introduction
============

.. _system-overview:
.. _overview:

System Overview
===============

The TYPO3 system is multi-layered. The backend and frontend user interfaces
sit on top of the application layer, which in turn sits on the infrastructure
layer. The webserver, database and PHP in the infrastructure layer are
prerequisites for running TYPO3.

TYPO3 Core primarily consists of the API (Application Programming Interface),
which defines a framework for managing the project content. The base features
of the API include content storage, user permissions and access, content
editing, and file management. These features are delivered via system
**extensions** that use the API. All of the content is stored in a database
that TYPO3 then accesses via the API.

Extensions are clearly confined code additions, such as plugins, backend
modules, application logic, skins, and third-party apps.

The most important thing to note is that everything is an extension in TYPO3
CMS. Even the most basic functions are packaged in a system extension called
"core".
TYPO3 is a content management system based on PHP.
The :ref:`TYPO3 - Getting Started Tutorial <t3start:start>` gives you an
introduction to the core concepts of TYPO3 and will help you to kickstart your
first project.

.. figure:: /Images/Graphics/Typo3CmsStructure.svg
:alt: TYPO3 System layers diagram
:class: with-border
:width: 800px
.. _introduction-installation:

Diagram showing the layers of the TYPO3 system
A basic TYPO3 installation
==========================

Installation with Composer is covered in the Getting Started Guide
(see :ref:`Installation <t3start:installation_index>` chapter).

Application layer
-----------------
You can also `download TYPO3 from our official page <https://get.typo3.org/version/13>`_

The TYPO3 Core framework interacts with system and 3rd party extensions via
the TYPO3 extension API.
If you are starting out we would suggest using the latest TYPO3 version with
long term support.

The core and extensions interact with each other seamlessly and operate as a
single, unified system.
.. _introduction-site-package:

User interface layer
--------------------
A basic site package
====================

The backend is the **content-creation** side. It is the administrative area
where you manage content and configuration based on the extensions that are
installed.
To get started you need a basic
`site package <https://docs.typo3.org/permalink/t3coreapi:site-package>`_.

The frontend is the **content-delivery** side. Typically a website, it is the
meeting place for templates, CSS, content, and logic from extensions,
delivering your project to the world.
The frontend doesn't have to be a website, it could be a native mobile
application, a web application built in a frontend framework, or an API to
interface with other systems.
You can use the `official Site Package Builder <https://get.typo3.org.ddev.site/sitepackage>`_
to generate one for you or follow the :ref:`site package tutorial <t3sitepackage:start>`.

.. _introduction-installation:

A basic installation
====================
.. _introduction-getting-help:

To follow this document, it might help to have a totally trimmed down
installation of TYPO3 with *only* the Core and the required system
extensions at hand.
Getting help with TYPO3
=======================

The installation process is covered in the :doc:`Getting started
Guide <t3start:Index>`.
You should perform the basic installation steps and not install any
distribution. This will give you the "lightest" possible version of TYPO3.
`Meet the TYPO3 Community <Meet the TYPO3 Community>`_. You can chat with us
`on Slack <https://typo3.org/community/meet/chat-slack>`_, go to meetings in
your `local user group <https://typo3.org/community/meet/user-groups>`_ or
meet us at `events <https://typo3.org/community/events>`_.

In your basic installation, go to the :guilabel:`Admin Tools > Extensions`
module. You will see all extensions installed by Composer are activated by
default.
You can discuss TYPO3 related questions in the https://talk.typo3.org/ forum.

.. include:: /Images/AutomaticScreenshots/Introduction/ExtensionsMinimalList.rst.txt
If you think you have found a bug in the TYPO3 Core code, have a look at our
`issue tracker on forge <https://forge.typo3.org/projects/typo3cms-core/issues>`_
where you can check if the bug has already been reported or not.

0 comments on commit aafff01

Please sign in to comment.