TYPO3 Editors Guide

Once you have installed TYPO3 using the TYPO3 - Getting Started Tutorial; the next step is to log in to the backend of the CMS and start adding pages and create some content. In the TYPO3 world we often call users who carry out these tasks "Editors".

This guide contains detailed information about all of the common tasks an Editor is likely to perform including granting other users access to the backend, creating pages, adding content to pages in the form of content elements and uploading and managing various file types including images and PDFs.

This guide assumes that you are already familiar with TYPO3. If this is not the case, visit the concepts of TYPO3 to get started.

All of the examples used in this guide are taken from a TYPO3 installation running the Official Introduction Package.


Logging in to TYPO3 backend

With TYPO3, an editor's work is done via the backend and having an active backend account is required.

Enter your domain name into the address bar of your browser and append /typo3 to the end of it to access the backend login page. For example: http://www.example.org/typo3.

Check that JavaScript and cookies are enabled in your browser as they are required by TYPO3's backend.

The TYPO3 backend login screen

The TYPO3 backend login screen

The password can be displayed in clear text by clicking the "eye" symbol once something has been typed in the password field.

Troubleshooting: Forgot password for backend login

The following example only works if your installation's administrator has enabled the password reset feature and if your backend account has a valid email address set. It also requires that your TYPO3 installation is able to send mails. Contact your installation's administrator if in doubt.

  1. Click on Forgot your password?

    Go to the backend login page and select Forgot your password?.

  2. Enter your email address

    Use the same email address that you provided during registration.

    Click on "Forgot your password?"

    Click on Forgot your password?

  3. Open the email and follow the link

    If you did not receive the email, check your spam folder and double-check that the entered email address is correct.

  4. Enter the new password

    After you clicked on the password recovery link in the email you received you can enter a new password. The new password has to respect the password policy requirements configured by the administrator of your installation.

Troubleshooting: Login does not work

  • Check if JavaScript is enabled in your browser.
  • Check the credentials are correct and valid.
  • If your IP address changes you might be automatically logged out.

Backend and Install Tool are locked for maintenance

If the administrator locked you TYPO3 installation for maintenance purposes, you will see one of the following error messages:

503 Login Error: TYPO3 is in maintenance mode at the moment. Only administrators are allowed access.

The backend login is locked for maintenance.

Error message: Whoops, looks like something went wrong. Backend and Install Tool are locked for maintenance.

The backend login is locked for maintenance, including for administrators.

This message can only be removed by an administrator or integrator / programmer of the TYPO3 installation.

Too many failed logins

After a certain amount of failed login attempts within a short time span the TYPO3 backend will be automatically logged to prevent brute force login attempts and other security relevant attacks:

Wait until after the mentioned time before you retry. Contact your administrator if the problem persists.

Login dialog reloads, no error message displayed

This can happen if the login cookies are incorrectly set. Try deleting your cookies in the browser. If this does not help, inform your administrator.

Login trouble shooting for administrators

In case you are the administrator yourself you can find more trouble shooting options in TYPO3 Getting Started, Troubleshooting common TYPO3 backend login problems.

Pages

Creating Pages

Creating pages is one of the first things you will do with your new TYPO3 installation. This chapter contains information on how to create pages and arrange them in the page tree.

Creating Multiple Pages

TYPO3 has a built-in feature that allows multiple pages to be created at once, making it easier to get started with larger projects. This chapter contains information on how to use this tool.

Working With Pages

This chapter contains information on how pages can be moved, copied and deleted in the page tree as well as showing you how to use the filter tool.

Page Types

There are a number of different types of pages that can be created in the page tree, including restricted pages and shortcuts to other pages. This chapter contains information about the different types of pages that are available and how they can be used.

Page Properties

Every page in the page tree has a set of properties that can be changed. This includes what template a page uses, SEO information and its visibility in the frontend. This chapter contains detailed information on each of the property tabs and how they can be configured.

Creating Pages


There are two ways to add a new page to your site. It can be done either by dragging the new page icon to the desired location in the page tree or by right-clicking on an existing page and using the contextual menu.

To start adding pages:

  • Select the Web > Page module in the backend.
  • Expand the page tree so that all of its subpages are visible (optional).

Adding pages within the page tree

You can create a new page by dragging and dropping a page from the top of the page tree.

Creating a page using drag and drop

Creating a page using drag and drop

  1. Select the type of page you want to add by choosing from one of the icons. In this example we are creating a standard page.
  2. Drop the icon either between two existing pages to create a sibling or on top of an existing page to create a child.
  3. Give the new page a title.

    Inserting a page title

    Inserting a page title

New pages are disabled by default. To enable a newly created page, right-click on the page and select Enable. You can also enable a page from the Access tab in page properties.

Adding pages with the context menu

  1. Right-click any existing page and choose More options > 'Create New' Wizard from the context menu.

    Creating pages with the context menu

    Creating pages with the context menu

    The New record screen will appear.

  2. Decide where you want your new page to appear in the page tree by selecting one of the black arrows.

    Selecting a position for the new page using the wizard

    Selecting a position for the new page using the wizard

    The Create new Page screen will appear.

  3. Provide a title for the page. You can also go to the Access tab and enable the page to make it visible in the frontend.

    Making the new page publicly visible

    Making the new page publicly visible

Visit the page types chapter for more information on the different types of pages that can be created.

Creating Multiple Pages


  1. In the page tree, position your cursor on the page that you want to be the parent of the new pages you are about to create.
  2. Right-click the page and select More options > Create multiple pages from the context menu.

    Select "Create multiple pages" in the context menu

    The Create Multiple Pages screen will appear, with five new empty pages.

    The "Create Multiple Pages" screen
  3. Give each new page a title and select its type.
  4. Click the Add more lines button to add five more new pages if you need to create even more pages.
  5. Configure the new pages using the options at the bottom of the screen:

    • The Place new pages after the existing subpages option adds new pages below the existing subpages. Otherwise they will be placed above the current pages.
    • The Hide new pages and Hide new pages in menus options let you manage the visibility of your new pages.

      A hidden page cannot be accessed by anyone via the web site. A page which is hidden in menus does not appear in the site navigation but can be accessed by someone having the direct URL of that page.

  6. Click the Create pages button to create the pages.

Working with pages


You can manage pages directly in the page tree.

Move pages

  1. Choose the page you want to move, then drag it anywhere in the page tree.

    A horizontal line displays to indicate the new position of the page.

    Drag a page to move it on the page tree

    Drag a page to move it on the page tree

    A gray outlined background on existing pages indicates that your page will become a child of that page.

    Drop a page on another page to make it a child page

    Drop a page on another page to make it a child page

  2. Release your mouse. A confirmation message will appear displaying the option to copy or move the page.
  3. Select Move this item.

Copy pages

  1. Choose the page you want to copy, then drag it to its new position on the page tree.
  2. Release your mouse, then select Copy in the confirmation message.

Delete pages

Choose the page you want to delete. Drag it directly to the right to display the Delete option.

Drag a page to the right to delete it

Drag a page to the right to delete it

Context menu

A variety of functions are also available from the right-click context menu.

Filter the page tree

At the top of the page tree is a filtering tool. Type a word or numbers to filter the page tree based on matching page titles or page ID. Multiple keywords / IDs can be entered by separating them with a comma.

Filtering pages in the page tree

Filtering pages in the page tree

Page types


Default page types

By default, TYPO3 includes the following page types.

Page

Standard
This is the default page type, and the most common. It covers all basic needs.
Backend User Section
This page type only displays in the frontend for a specific group of backend users. You have to be logged in to the backend to see this type of page.

Special

Folder
A folder page type is a container. It is generally used to store records other than pages or content elements. It will not display in the frontend.
Recycler

Changed in version 13.0

The recycler type was removed. As a substitution use the recycler module.

Menu separator
This page type creates a visual separation in the page tree. You can use TypoScript to also display these separators in the frontend navigation.

Custom page types

Depending on the project, custom page types may also be available.

Page properties


To access the page properties, click on the Edit page properties icon in the Docheader.

The "Edit page properties" button is located in the doc-header of the page module

Click the "Edit page properties" button to open the properties

The page properties that are available depend on the page type, your user permissions, and the configuration of the TYPO3 installation. The default properties available for the Standard page type include:

General

This tab contains general information about the page. You can change the Page Type, and edit titles for the page and the URL.

The following fields are of interest:

Page Type

The page types listed here vary with how the site package is defined and your user rights.

See chapter Page types for details.

Page Title / Alternative Navigation Title

The Page Title is used as label in menus and in the <title> tag in the HTML header. It is also used to generate the URL Segment.

When you specify an Alternative Navigation Title this title is used as label in the menus while other usages of the "Page Title" stay unchanged.

The "Subtitle" is only used if your site package configured it to be output somewhere.

URL Segment

The "URL Segment", sometimes also called "Slug" is used to calculate the URL at which your page is available. Usually it is filled out automatically.

Location of the "Recalculate URL Segment" button at the end of the "URL Segment" field in the page properties

When you renamed or moved a page and also want to change the "URL Segment", click the "Recalculate URL Segment" button.

If the "Redirects" system extension is installed, an automatic redirect from the old to the new URL is created:

Info: Slugs updated and redirects created: Because you renamed a slug, the slugs of all sub-pages were updated and redirects were created for you automatically.

If you accidentally changed a URL segment you can revert that change here

It is also possible to edit the URL segment by clicking the "Toggle" button. You can then enter a different URL segment:

Manually editing a URL segment by clicking the "Toggle" button

SEO

This tab is used for search engine optimization. It uses the cs_seo system extension. See section SEO Tab in chapter Search engine optimization (SEO) for TYPO3 editors for more information.

Social media

The fields on this tab are used to enrich social media snippets for the URL of the page. See section Social media tab in chapter Search engine optimization (SEO) for TYPO3 editors for more information.

Metadata

The fields available on this tab depend on how your site is configured. How the data is used by the frontend depends on TypoScript which depends on your site configuration.

Typically, you might see the Abstract field, and editorial details like Author Name and Last Update.

Appearance

This tab contains properties that influence how the page is rendered. By default it contains settings for the page layout, which influences the pages appearance in both the frontend and the Page Module in the backend. Sometimes a site package defines additional fields in this tab regarding appearance. Refer to the documentation of your site package or ask your integrator.

Page Layout / Backend Layout

The Backend Layout is found in the tab "Appearance" of the page properties in the TYPO3 Backend

Backend Layouts influence the general structure of a page not only in the backend but also in the frontend. A Backend Layout influences, which content areas are available in the Page Module to Manage content in them. A Backend Layout is usually bound to its own frontend template which influences the appearance in the frontend.

Behaviour

In this tab there is usually not much to do for an editor. Advanced editors can use it to exclude certain pages from the search.

Resources

This tab lets you link media files to the current page. How those files are handled depends on your frontend rendering configuration.

Access

This tab lets you control the visibility of the page.

For more information, see Elements visibility.

Categories

How categories for pages are used during rendering is up to the site package. By default they do not do anything.

Notes

Use this tab for your own editorial notes and internal comments, such as reminders or to-do lists.

Screenshot demonstrating the location of the "Record information" at the top of the Page Properties

Notes display in the backend above the Page Properties tabs. They are not displayed in the frontend.

YouTube Video "Page Properties" (TYPO3 11.5)

Content Elements

Creating content elements in the TYPO3 backend

Creating Content

This chapter contains information you need to start adding content to your TYPO3 website.

Editing content elements in the TYPO3 backend

Editing Content

Want to change a content element's type? This chapter contains information on how you can change a content element's type while preserving its content.

Manage content elements in the TYPO3 backend

Managing Content

This chapter contains information on how you can move, copy and cut content. It also has information on the different ways you can view content in the backend.

Content element Regular Text in the TYPO3 backend

Rich Text Editor

We use the rich text editor to add written content. Find out how you can use it to format text and add both internal and external links.

Content element Images in the TYPO3 backend

Working With Images

Find out how to upload images, resize and add images to a page.

Content element Text and Media in the TYPO3 backend

Embedding Video And Audio

This chapter contains information on how to embed video and audio files to a page. Including content from YouTube and Vimeo.

Content element Contact Form in the TYPO3 backend

Creating A Contact Form

Find out how to create a contact form using the step-by-step guide.

Creating content

Creating content elements in the TYPO3 backend

In the Web > Page module, on any page, click the + Create new content button in the place where you want to insert content:

The New Page Content wizard will then be displayed.

In the following screenshot you see the location of that button:

"Create new content button" in the Page module, column "Normal"

Create a new Content Element by clicking the button

Types of content elements

The content elements you can see here are provided by a standard TYPO3 installation with a site package as described in the TYPO3 site package tutorial.

If you are working with a different setup you might see more, or different content elements.

Which content elements you can see as an editor also depends on your user rights:

A standard editor can see the following content elements:

Screenshot of the "New Page Content" wizard as seen by a common TYPO3 editor, featuring "Typical Page Content", "Lists" and "Special elements"

Screenshot of the "New Page Content" wizard as seen by a common TYPO3 editor

An advanced editor or an administrator can see the following content elements:

Screenshot of the "New Page Content" wizard as seen by an advanced TYPO3 editor, additionally including "Form elements", "Menus" and additional "Special elements"

An advanced editor sees more groups and more content elements types in some of the groups

Content elements seen by a typical TYPO3 editor

Typical page content

Insert regular text and image content types to build standard web pages.

'Typical page content' tab contains content like Header, Regular Text Element, Text & Media, Images etc

The Typical page content tab of the new content element window

Lists

Lists can be used for structured content. They provide less flexibility then standard content elements but are easier to use for their specialized use case.

The 'List' tab contains content elements like "Bullet List", "Table" and "File Links"

The List tab of the new content element window

Depending on how the Rendering is defined in the Site Package the way the results are displayed on the page might vary.

Advanced content elements

The following content elements are usually visible to advanced users:

Form elements

Create a login form or a simple contact form.

Tab "Form elements" with "Form" and "Login Form"

The Form elements tab of the new content element window

Plugins

The tab "Plugins" is available if the integrator of your site installed an extension that provides a plugin in this section and you have the required user rights. Refer to the manual of the extension that provides the plugin for more information.

Special elements

Insert plain HTML, or a horizontal divider on the page. The "Insert records" element lets you reference other content elements, i.e. reuse a content element from another page without duplicating it.

The 'Special elements' tab of the new content element window

The Plugins tab of the new content element window

Add new content to a page

  1. On a page, click the + Create new content button in the area where you want to insert content.
  2. On the Typical Page Content tab, choose the "Text & Media" element. This is the most commonly used content type. The Create new Page Content form appears.
Create new Page Content on page "Page 1" form screenshot

Unsaved changes are highlighted in light blue

  1. In the Header field, type My new content element.
  2. In the Text area, type in some text. This field uses a Rich Text Editor (RTE).
  3. Save and close the content element. You can see the newly added element on the page:
The new content element appears in the Page module

The new content element appears in the Page module

Video of creating a content element (TYPO3 11.5)

Editing content

Editing content elements in the TYPO3 backend

On a page, click the pencil icon for the content element you want to edit, then edit the text and make other changes as required.

Changing text and setting in a content element

Once you clicked on the edit button you can change text, images and all settings that you have permissions for. There might be additional settings that only an advanced editor or an administrator can see and edit. Those might be hidden to you.

Content element edit form screenshot, demonstrating changed content which is highlighted

Changed content is highlighted. The save button is found on the top

Content in the Content element forms is not auto-saved. If you try to leave a form that has changes you will be prompted to save:

Prompt: Do you want to close without saving? You currently have unsaved changes. Are you sure you want to discard these changes?

You are prompted when you try to leave a form with unsaved changes

Troubleshooting content element edits

Content element has no edit button

If you have no permissions to change a content element, you will see that element in the overview but no edit, hide or delete button appears.

A content element without an edit button

A content element that cannot be edited due to lacking permissions

Possible reasons:

  • The content element may only be edited by a user or group that created it.
  • Only admins may edit this content element.
  • The content element is of a type that your group may not edit.

An administrator can support you in finding out why you cannot edit this content element.

Content element does not get saved

If one of the fields you edited contains an illegal value now or if you did not fill out a required field, you cannot save your changes.

Screenshot of a required field

A required field that has no value prevents saving of a content element

Input error caused by a letter entered in a number field

Input error caused by a letter entered in a number field

If the field you changed is on a different then the currently changed tab, you might not notice it right away.

Error message after saving a content element

Such error messages can happen if you are editing content during or right after an update. Note the time and exact error message and copy the URL from your browser where you saw the error. Send these to your integrator or programmer.

Screenshot of an error message in the TYPO3 backend

Such an error can happen during or after updates or when a programmer is working on your installation.

Changes not visible in the frontend after saving a content element

There can be various reasons:

Changing the type of an existing content element

You can also change the content element type by selecting another element from the Type list.

Edit form of a content element in the TYPO3 backend, demonstrating the location of the "Type" selector in tab General

You can find the "Type" selector in tab General

When you change a content element's type, the TYPO3 backend wants to reload the screen to display different input fields, you are prompted first:

Edit form of a content element in the TYPO3 backend, demonstrating the location of the "Type" selector in tab General

You can find the "Type" selector in tab General

This action does not delete content. It is saved in the background and will be restored if you select the applicable content element type again.

Video: Changing a content elements type (TYPO3 11)

Managing content

Manage content elements in the TYPO3 backend

In TYPO3, working with content happens mostly in the Web > Page module. Chose the page you want to edit from the page tree.

You can Hide. Move or Copy & paste content elements using the context menu.

The following screenshot demonstrates how to open the Page module:

Screenshot demonstrating the page module and the page tree in the TYPO3 backend

Click on "Page" in the module menu, then choose the page to be managed in the page tree

Overview of the Page module in TYPO3

A typical view of the Page module with various content columns

Common page icons explained:

  1. Use this icon to edit all the content elements of a column.
  2. Add a new content element to the column at this specific position.
  3. Content element icon. This can provide a visual clue to the type of content element. Click to access the context menu for the element (to perform actions like copy).
  4. This group of icons is enabled when hovering over the whole element.

    • Use the pencil icon to edit the element.
    • Enable/disable the element to show or hide it in the frontend
    • Delete the element.
    • Open the context menu.
  5. If the edit icons are missing you do not have sufficient permission to edit the content element in question.

Hiding content elements

You can temporarily hide content that should be hidden for a while but will be needed later. You can also hide a content element while you are still working on it. Hidden content elements are not visible in the frontend

A content element in the page module is hidden

Use the "hide" button to hide a content element. The second content element is hidden and can be unhidden by the same button.

A content element can also be hidden in the "Access" tab of its edit form, its context menu or the List module.

Moving content elements

You can move content elements using drag and drop. You can either drop them in one of the highlighted areas on the current page or drop them on a different page within the page tree.

Screenshot of moving a content element via drag and drop in the TYPO3 backend

Drop the content element on a page in the page tree to move it to another page

Copy and paste content elements

The context menu of a content menu in the TYO3 backend

Use the context menu of the upper left button of the content element to start copying a content element

Location of the paste button beside the "Create new content" button

Paste the content into the desired location.

You can also copy content elements by pressing Ctrl during drag and drop.

Copied content is hidden by default and has the text "(copy xx)" appended to its title. Your integrator can disable this default behaviour: Disable hide and prepend at copy if desired.

Troubleshooting page management

Unused elements detected on this page

Sometimes the following warning is displayed on your page:

Warning: Unused elements detected on this page: These elements don't belong to any of the available columns of this page. You should either delete them or move them to existing columns. We highlighted the problematic records for you.

Warning that some content elements belong to no valid content area

This commonly happens when you switched the Backend layout in the page properties.

It can also happen after imports or updates. "Unused content" is usually not displayed on the page. You can restore it if it is still needed or delete it if it is not needed anymore.

The "Unused content" is found at the bottom of the page module. you can move it via drag an drop to the desired location or delete it, if it is not needed anymore.

Demonstration of moving unused content back into a normal content area

Restore deleted content elements using the Recycler

If you accidentally delete a content element or even a complete page you can restore your data using the module Web > Recycler if you have sufficient permissions and it is installed.

Screenshot of the Recycler module in the TYPO3 backend, demonstrating how to restore a deleted content element

See also Recycler manual, For editors.

Undo changes using the Page History

You can use the page history to undo any kind of content changes. If you have no access to the recycler you can also use it to restore deleted content.

Use the context menu on the page tree and choose "History/Undo".

Screenshot of the page history in the TYPO3 backend

Use the "Undo" button to undo your changes

In this module you can even see a detailed view on how text or other fields where changed and who made which changes when.

Screenshot of the page history in the TYPO3 backend

Compare the differences. Use the undo button to undo changes.

The BE-User 'xxx' began to edit this record x min ago

It is not possible in TYPO3 for two editors to work on the same content element at the same time. The last editor who saves the content element will override all other changes. You should therefore avoid working on content elements that another editor is currently working on. These are marked with a warning:

Warning: The BE-User 'e.doe' began to edit this record 3 min ago.

Avoid working on content elements that are currently edited by someone else

The rich text editor

Content element Regular Text in the TYPO3 backend

Start by Creating a content element of type "Text & Images", "Text & Media", or "Regular Text Element". You can find them in the tab Typical page content.

The TYPO3 text editing interface is not much different from a word processor. The options available in the toolbars vary depending on how your TYPO3 installation is configured.

Screenshot of a typical rich text editor in the TYPO3 backend

The options you see depend on the configuration of your site

You can format text, set the alignment, insert tables and symbols and add internal and external links to text.

Working with images

Content element Images in the TYPO3 backend

For content elements that support images (for example Text & Images, Text & Media, Images Only), you will see an Images or Media tab when you create or edit the content element.

Start by Creating a content element of type "Text & Images", "Text & Media", or "Images Only". You can find them in the tab Typical page content.

Add an image to the content element

On the Images tab, click the Add image button. The File selector window displays to let you browse for an image.

Screenshot of a "Text with Image" TYPO3 content element, tab "Images"

Click the "Add image" button in tab images to chose or upload an image

Browse the file tree, then select a folder.

The file selector window in the TYPO3 backend

Click the name of an image to select it or use the "Upload files" dialoge. Alternatively, mark several images and import all of them at once.

Configure the image

The Images tab lets you perform a number of actions to configure an image.

Image metadata

Use the small arrow next to the thumbnail to collapse and expand this section.

Here you can set general metadata including description, alt text, and insert a link to the image.

Screenshot of the meta data of an image in a "Text and Image" content element

Override the default meta data of the image with custom values for this location.

The information displayed here is drawn from the file metadata set in the Filelist. If required, you can override this metadata to set specific values for the image for the current content element.

You can experiment with the image manipulation editor to crop or resize the image. Making changes here won't impact the original image file in Filelist.

Media adjustments

Manually specify the width and height of the image in pixels, and apply a border.

Screenshot of the Media Adjustments section of a "Text and Images" content element in TYPO3

A value of '0' means the size is calculated dynamically.

Behavior

Use the Enlarge on Click setting to enable a lightbox display for the image.

Manage your images in the Filelist

You can manage your previously uploaded images in the backend module File > Filelist:

Screenshot of the "Filelist" backend module in TYPO3

You can view the files as Tiles or List by switching the settings.

TYPO3 uses a file abstraction layer (FAL) you can therefore move images into different folders without impending the frontend output of the web page, even if they are used in multiple places.

You can move images into folders by drag and drop:

Screenshot of the "Filelist" backend module demonstration Drag and Drop

Grab a picture with the mouse, drag it to a folder and drop it there

The file abstraction layer will not allow you to delete images that are still in use in some content element:

File not deleted, The file "xxx.png" cannot be deleted since it is still used at the following places

TYPO3 FAL will prevent you from deleting files that are still in use

First alter or delete all content elements that still use the file, then you can delete the file itself.

See also chapter Managing files in the Fileadmin.

Embedding videos as content into a TYPO3 website

Content element "Text & Media" in the TYPO3 backend

The "Text & Media" content element extends the capabilities of the "Text & Image" <Working with images>`_ content element (introduced in the previous chapter) by supporting a wider range of media types. While "Text & Image" focuses on combining text and static images, "Text & Media" allows you to embed dynamic media, such as videos and audio files.

It also provides the option to embed content from external platforms like YouTube and Vimeo. The specific file types and formats supported (e.g., audio and video) depend on your site's configuration, including any installed extensions that may add support for additional formats. A list of allowed file extensions and pseudo-formats (e.g., YouTube, Vimeo) is displayed below the element selector.

This enhanced functionality makes "Text & Media" a versatile choice for presenting multimedia content alongside textual information.

Add a video to a page

If you want to embed a previously uploaded video or upload a new video use the button Add media file. If you want to embed a video from an external source like YouTube or Vimeo, use the button Add media URL instead.

Tab media of the text and media content element in TYPO3

Configure the video

Use the Autoplay setting to specify whether the video should start playing as soon as the page loads.

You can configure various settings for media files (for example, adding a border, setting page position and behavior) just as you would to configure an image.

External video sources and data privacy

Using certain external video sources can have legal consequences concerning data privacy laws in your country.

Talk to your Data Protection Officer (DPO) or legal department. Ask your integrator to install an extension that ensures you can use YouTube without data privacy issues on your page.

Extension b13/twoclickmedia enables you to use the standard "Text & Media" content element while requiring consent from your readers before any data is sent to YouTube.

Other extensions like t3brightside/youtubevideo provide their own content element.

Creating a contact form

Content element Contact Form in the TYPO3 backend

You can create a form from the Web > Forms module. This is a system extension which needs to be activated by your administrator. It is written in TypoScript and is fully documented in the Form Framework system extension manual.

This module provides a guided interface for editors to create any kind of form such as a contact form, newsletter subscription or even a survey. TYPO3 comes with one pre-defined form already built, which you can use to get started.

  1. In the Web > Forms module, click the + Create new form button. The Create new form wizard displays.

    Launching the Create new form wizard

  2. Choose whether you want to create a blank form or use a predefined form. In this case, choose Predefined Form.

    Choose Predefined form

  3. Choose the predefined Simple contact form and enter a name.

  4. Check the settings and click Next once more.

  5. In the Start template list, select 'Simple contact form', and then type a name for the form.
  6. Click Next and then click Finish. Your new form displays.

    New form based on template

    The predefined 'Simple contact form' comes with some settings already configured, but you can edit these settings and add more fields. For example, you might want to delete the Summary page, and change the labels on the buttons.

  7. Add your form to a page the same way you would add any content element. On the Form elements tab, choose 'Form'.
  8. In the form content element, go to the Plugin tab and in the Form definition list, choose your form.

    Choose your form on the Plugin tab

  9. On the General tab, type a header for your form, then save and close the record.

    Preview the page and it should look something like this:

    The contact form in the frontend

Create a form from scratch

  1. In the Web > Forms module, click the + Create new form button.
  2. In the Create new form wizard, choose to create a blank form.
  3. Give your form a name, then click Next and Finish.

    A blank form displays.

    Create a new form from scratch

  4. Click the Create new element button. The New element window displays.

    Create new element in form

    TYPO3 comes with over twenty form fields by default, including:

    • Basic elements like text or password fields
    • Special elements requiring specific format validation, like phone numbers or dates
    • Select elements like checkboxes or multiple choice
    • Advanced elements that have special rules, like user uploads or calendar date pickers
    • Container elements to visually organize surveys

    Once you’ve selected a form element, you can customize the settings for how the field is displayed.

  5. Choose the Text element and the field is added to your form. You can configure settings for the field (such as placeholder text and field validation) on the right-hand side of the screen .

    Create a new form from scratch

  6. Click the Preview mode icon to see an indication of how your form will display on the frontend. Use the Edit mode icon to return to editing your form.

    Create a new form from scratch

Working with forms

When you have added multiple fields to your form, you can drag and drop them to rearrange their order.

Click the Settings button at the top of the form to add Finishers like a confirmation message or redirection to another page.

Add finishers to a form

You can integrate extensions with existing forms. For example, if you're running a sales operation, you can integrate with Mautic and any changes to a TYPO3 form will update Mautic to give you seamless lead tracking.

Records

Using The List Module

The list view displays a list of records stored on the current page, grouped by type.

Copy and paste

You can copy and paste records using the context menu and then choose "copy" (or cut if you want to move the record instead).

Clipboard usage

Find out how to make get the most out of the clipboard with an overview of some its extra features.

Mass Editing

The List module makes it possible to display the content of several fields at once and gives you the ability edit several records with one action.

Using the list module

The Web > List module allows you to browse through pages and folders in your site and view the records that are stored there. You can also create and edit records.

Select the Web > List module and choose a page or storage folder.

The List module header

Screenshots of the List module in the TYPO3 backend, demonstrating the locations of the buttons mentioned below

See below about the meaning of the labeled buttons

The list view displays a list of records stored on the current page, grouped by type. The List module is commonly used for records that have no dedicated backend module, for example website users and groups.

The list view has action icons in the module header including:

  1. Create new record (a wizard appears to let you choose which type)
  2. Edit page properties of the current page
  3. Clear the cache of the current page
  4. Refresh the List view
  5. Create internal note
  6. View Show or hide search or The clipboard
  7. Share Copy an URL to this page or bookmark it for quick access

Editing a record of a certain type

If there are already database records stored on the current page, each record type features its own action buttons for available actions:

Example of the action icons available for record type "Website Usergroup"

In this example the first button can be used to edit the user group, the second button to hide or unhide it, the third button to delete it. The button with the three dots offers additional options.

Finding a record in a long list

If there are a large number of records you can use the search box to search for a record containing a certain word.

Screenshot of the List module with the search box visible

To make the search box visible, Select "Show Search" from the "View" dropdown.

It is also possible to include subpages of the current page by choosing the number of levels (for performance reasons) in which to search.

If you do not know on which page the record could be found you can also use the Backend search.

The search can be opened by selecting the magnifying glass in the top right corner of the toolbar or by pressing the Cmd + K keystroke on MacOS or the Ctrl + K keystroke on Windows and Linux systems.

Copy and paste database record

You can copy and paste records in the List module using the context menu and then choose "copy" (or cut if you want to move the record instead).

How to copy and paste via list module

Open the context menu by clicking the three dots button or the icon to the left of the record. Copy or cut the database record.

The context menu contains options copy and cut amongst others

Copy or cut a record using the context menu.

To paste the copied record you have several options:

Location of the paste buttons in the TYPO3 List module: At the top of the module and in the context menu.

(1) inserts the record at the end of the other records, with the context menu (2) you can choose the location

Trouble shooting during copy and paste

If you see any error messages not listed here, note the date and time, error message and what you have been doing. Send the information to your site administrator.

Why is the header appended with (copy 1)?

A copied content element with (copy 1) appended to its header

The pasted database record is changed to "Mercury (copy 1)"

By default the title of the pasted record is post fixed with "(copy x)" and the new record is marked as hidden and not displayed in the frontend.

This default behaviour of titles being prefixed can make working with copy and paste tedious and advanced editors often prefer that the integrator of the site turns of this behaviour. They can use the setting disablePrependAtCopy to disable this.

Attempt to insert record on a page that can't store record type

Some record types, for example frontend user records or category records may only be created in pages of type "folder". If you try to insert such a record on a plain page, an error message will be displayed:

TYPO3 Backend Error: Attempt to insert record "fe_groups:3" on a page (8) that can't store record type

Result of trying to copy a frontend user group into a plain page

The record was not pasted in this case. Use the page tree to switch to a folder, for example the folder "Frontend Users" and click the "Paste in clipboard content" there.

The value of the field "username" has been changed as it is required to be unique

Some fields need to be unique across the complete TYPO3 installation, for example a user name or identifier.

If you try to copy & paste such a record, the affected fields are automatically renamed by appending a number.

TYPO3 Backend Warning: The value of the field "username" has been changed from "galileo" to "galileo0" as it is required to be unique

Fields that have to be unique are automatically alterered on paste

The record has been pasted but renamed. Edit the new record and replace the field with a unique value.

Using the clipboard to copy or move multiple records at once

If the clipboard is not yet enabled, display it via the "View" drop down in the header of the "List" module. Then choose one of the clipboards, for example "Clipboard #1".

The clipboard can be shown by "Show clipbaord" entry in the "View" drop down

Choose "Clipboard #1" to activate the multi-selection mode

As soon as one or more records are checked, new buttons will appear at the top of the list:

  1. Edit all selected items at once
  2. Transfer to Clipboard all selected items at once
  3. Remove from Clipboard all selected items at once
  4. Delete all selected items at once

Now check several boxes and click the Transfer to Clipboard button. Your clipboard should look like this:

TYPO3 backend clipboard with several items

You can transfer multiple items of different types from different pages

The button Move Elements is selected by default. Select the button Copy Elements instead. The selected elements will now be copied and the current page will remain unchanged.

Move to another page and click the "Paste in clipboard content" button:

Button "Paste in clipboard content"

The text on the button is the same no matter weather you move or copy items

A confirmation dialog appears. If you click ok, the chosen records are moved or copied, depending on the mode selected in the Clipboard on the bottom of the List module.

Mass editing

The List module makes it possible to display the content of several fields at once and gives you the ability edit several records with one action.

Choose the columns to be displayed by clicking the Show Columns button.

Screenshot demonstrating the location of the "Show Columns" Button in the TYPO3 List module

The Show Columns button

Then chose the field or fields you want to edit from the modal. Click on the Update button.

Screenshot of the "Show columns for Page Content" popup

Choose the fields to be displayed and click "Update"

This makes the additional fields appear in a new column to the right of the record list:

List Module table with additional fields enabled

Click on the title or arrow to enable mass edit mode

Edit selected fields

To enable mass editing you have to switch into the record list single view by clicking the tables title:

Screen shot of the mass edit mode in the list module, edit buttons above columns visible

1: Edit all headers 2: Edit all Selected Fields 3: Edit just one field

To edit the headers of all records in one go, select the pencil icon next to the "Header" label (1).

You will then see a screen with input fields to change all headers and save them all at once.

All fields that are currently viewable can be edited at the same time by selecting a different icon (2) in the screenshot above.

The result is almost the same form, but with several fields per database record displayed.

Edit selected fields of selected records

It is possible to select only those records that should be edited by using the checkboxes:

The list module with specific database records checked for mass edit

Selecting records for editing

The result is a form for editing just the chosen field for the selected records.

Files

The File > Filelist module is where you can manage all the media associated with your TYPO3 web site.

Managing files in the TYPO3 CMS

Files including documents and images are managed in the Filelist module. Similar to the Web > List module, it displays a navigation tree, which corresponds to the file structure on the server, and a list of all files for the selected directory.

A typical view from the The Filelist module

For admin users, the folder displayed by default is called "fileadmin/ (auto-generated)" and corresponds to the fileadmin/ folder located under the document root folder on your web server.

Using these files inside content elements to display them or link to them in your web site is covered in the images chapter.

File metadata

You can provide metadata for the file by clicking on the button that looka like a pencil with the title text Edit Metadata of this file.

The metadata you provide can include (depending on the setup of the system and the format of the file):

  • Text to be displayed to all users in some contexts (Title, Description)
  • Text for Accessibility such as the alternative text for an image or a download name
  • Data required due to copyright issues
  • Metadata attached to the uploaded file such as information about the camera used or the location

Clipboard

There's a clipboard just like in the List module.

The Filelist module's clipboard

The handling is the same as the description used in the Advanced clipboard usage.

Uploading new files

You can upload files to a given folder by using the context menu or to the current directory by using the action icon in the docheader.

Upload possibilities in the Filelist module

Next steps

The next chapters cover configuration and administration tasks that require special access privileges as described in Access control in the backend (users and groups).

Working with languages

TYPO3 CMS comes with the built-in ability to handle web sites in multiple languages.

Detailed information about setting up a multilingual web site is found in the Frontend Localization Guide.


Defining a new language

Languages are defined per site.

Adding a new language is done in the Site Management > Sites module, which is restricted to admin users. Detailed information on how to configure your site to add more languages can be found in the Site Handling documentation.

The Introduction Package's default languages are English, Danish and German languages.

Translation modes

When you choose to translate content, TYPO3 offers two methods:

  • Translate - Use this option when you have a strict translation workflow or content structure.

    TYPO3 will create a direct connection between the original language and the translation. When the original language content is changed, the translations are marked as out-of-date and you can see the changes in the original language when editing a translation.

    This mode means that TYPO3 can help you maintain consistency when you have separate teams localizing content. This mode also allows TYPO3 to automatically mark translated content for review, and notify translators when the original text changes.

  • Copy - Use this option when you would like the content structure to be free and independent between languages.

    TYPO3 creates a copy of the content in the target language. No connection is maintained between the original and the translation, which means subsequent versions of the translations can easily diverge from the original.

Working with translations

  1. Working with the Introduction Package, in the Web > Pages module, go to the "Congratulations" home page.
  2. Using the menu in the docheader, switch to the "Languages" view.

    The "Languages" view of the Page module
  3. In the drop-down menu "Create a new translation of this page", choose a language, let's say German in this case. The page properties displays for the German version of the page.
  4. Type the German translation in the Page Title field.

    Creating a new page translation
  5. Save and close the page. The screen now displays two versions of the content elements showing the default language and the German version side by side.

    Viewing languages side by side in the page module
  6. In the German column, click the Translate button for a content element. The Localize wizard displays.

    First step of the Localize wizard
  7. For this example, click the Translate button then click Next. Step 2 of the wizard will pass by automatically since we are translating in a single language. Step 3 provides a summary of the elements that will be translated.
  8. Click Next to complete the wizard.

    The German version of the content element is now prepended with [Translate to German:]. The element is hidden by default, so that incomplete translations aren't displayed on the frontend until you are ready.

    A newly created content element translation

    A newly created content element translation

Adjusting the view

The Page module may now seem cluttered, with one column for each translation. You can view a single language at a time by switching back to the "Columns" mode and choosing a specific language in the docheader.

The "Columns" mode displaying a translation

The "Columns" mode displaying a translation

Next steps

The Frontend Localization Guide contains detailed information about setting up a multilingual web site and how to actually do the translation and localization.

The Site Handling documentation contains information about how to configure your site to add more languages.

Search engine optimization (SEO) for TYPO3 editors

Welcome to our small SEO introduction. We will explain the basic fields the TYPO3 core provides and introduce the SEO tools this way.

All the following fields are part of the page record.

You can reach it by:

  • Open the Web > Page module
  • Use the pen (Edit page properties) in the top bar icon to edit the page record.

An alternative way is to use the context menu.

  • Open Web > Page module
  • Right click the page you want to edit in the page tree
  • Select the Edit action

General tab

Page Title

The page title field is used for several purposes. From a SEO perspective it is mainly used to define the default URL segment and as a fallback title, if you do not set a specific SEO title. More information about the usage of the title fields can be found at Title for search engines.

URL Segment (slug)

The URL segment is the part of the URL the user enters to access your page. Depending on your use case URLs have to fulfill certain criteria.

By default the URL segment is based on the page tree and page title, but you can override this and set it yourself.

If you want to optimize your page for search engines, it is recommended to have at least the keyword you want to be found on in your URL segment. Please make sure to check other best practices with your SEO specialist.

SEO Tab

Title for search engines

The Title for search engines field is used for the <title>...</title> tag of your web page. This title is used in the search results of search engines. There are some best practices for the value of this field.

  • Use a speaking title, which targets your audience
  • If possible, use the keywords you want to be found on in the title
  • Please make sure your title fits in a Google Snippet. You can use third party extensions to help you with this.

When no value for the Title for search engines field is defined, it will have a fallback to the field Page title. It will show the page title in the search results in that case.

The title can have the name of the site as a prefix or suffix. The behaviour of this can be defined by an integrator.

By default the title will have the name of the site as a suffix, separated by a dash.

Description

The description field is important for SEO purposes. This field is used to instruct search engines to use this text to show as a teaser of your page in the search result snippets. With this description, you can give the user a clear overview of the topic of this page.

Index this page

Defines whether the page should be indexed by a search engine or not. Disabling indexing also removes the page from the XML sitemap.

Follow this page

Defines whether search engines should follow the links on this page.

Change frequency

This field is used in the XML sitemap and will give search engines a hint how often the content of your page is likely to change.

For example: News in an archive are “never” updated, while your home page might get “weekly” updates.

Priority

The priority is also used in the XML sitemap. Priority allows you to define how important the page is compared to other pages on your site. The priority is stated in a value from 0 to 1. Your most important pages can get an higher priority as other pages. This value does not affect how important your pages are compared to pages of other websites. All pages and records get a priority of 0.5 by default.

Social media

The social media tab contains information which is used to enrich the snippet that is shown when visitors share your URLs in social networks, modern browsers etc.

TYPO3 offers to have different content for OpenGraph (used for example by Facebook and LinkedIn) and X (formerly Twitter) Cards.

Both implementations allow you to set a title, a description and to provide an image. When this information is not set manually, the social network will decide itself what to show. Most probably it will use the information from Title for search engines and Description.

Title

This title can be specified to be shown as the title of the snippet preview when your page is shared on the social network. You only have to fill this field when you want a different title as in the search results.

Description

Used to adjust the description of the preview snippet when your page is shared at a social network. You only have to fill this field when you want a different description as the description in the search results.

Image

You can specify the image that should be shown when your page is shared on a social network. Please be aware that the different social networks need specific dimensions for an image. TYPO3 ships with the most used dimension. If you want to have more dimensions, please let your integrator add more dimensions.

Metadata Tab

The Metadata tab contains a list of elements like Abstract, Keywords and editorial information.

Some site packages may utilize this for embedding within your frontend. They are not output by default

Dashboard widgets for Search engine optimization (SEO) in TYPO3

The following dashboard widgets are available to editors if your integrator installed the system extension typo3/cms-seo and if you have been granted the permissions to use them.

"Missing Meta Description" widget

To make it more convenient for TYPO3 editors to optimize their website for search engines, typo3/cms-seo offers a dashboard widget that shows pages without a meta description.

The description field is important for SEO purposes. This field is used to instruct search engines to use this text to show as a teaser of your page in the search result snippets. With this description, you can give the user a clear overview of the topic of this page:

Adding the "Missing Meta Description" widget to your personal Dashboard

If you have the access rights to the Dashboard module and are granted access to the "Missing Meta Description" widget you can add it yourself to your Dashboard:

Screenshot of the backend, showing the widget "Pages missing Meta Description" in category "SEO"

Adding the widget "Pages missing Meta Description"

  1. Open the Dashboard module
  2. Click on the plus button to add a widget
  3. Go to category "SEO"
  4. Choose widget "Pages missing Meta Description"

Using the "Missing Meta Description" widget to improve SEO results

Therefore this widget lists pages without a description in their meta data:

Screenshot a widget listing pages without description

Pages without description listed in the Dashboard

You can now click on the pencil icon to add a description to the page:

Screenshot of an edit form showing just the description field

Add a description to the page

Access Control

There are many ways to restrict access to pages, content elements and other information in your TYPO3 CMS installation. Options can range from hiding pages in menus, to limiting visibility of content for a set time period, all the way through to requiring visitors to log in to view content.

Visibility

When an element is hidden, be it a page, a content element or a news item, it will not display in the frontend. You can, however, preview it in the backend.

Frontend Login

Find out how to configure content and pages to only be visible to frontend users who have logged in to a restricted area.

Elements visibility

When an element is hidden, be it a page, a content element or a news item, it will not display in the frontend. You can, however, preview it in the backend.

In the Core, and in extensions that follow best practice, all options related to visibility are controlled in the Access tab of the page properties.

Publication dates

You can specify a period of time for content to be visible. This might be useful for seasonal announcements or festive periods. Any page or content element with a defined Publish Date will not be visible before that date. If it has an Expiration Date, it will be hidden from that point onward.

Setting a publication date for a page

When you set a publication date in the future then try to navigate to that page, you are redirected to the home page.

When you enable the Extend to Subpages setting, the publication date (and other access restrictions) also apply to all child pages of the current page. This makes it possible to apply restrictions to a whole branch of the page tree.

Frontend login

You can configure content or pages to only be visible to frontend users who have logged in.

Frontend users

The concept of the TYPO3 backend and frontend is explained in the Getting Started Tutorial.

You can use the concept of frontend users (website visitors) to create member-only content and restrict access to pages and content elements by requiring a log in.

Frontend users are always part of frontend groups. Access is granted to groups, never directly to users. Users and groups are defined like any other record, and stored in a suitable page in the backend.

Create a user group and user

  1. Create a new folder in the page tree, and name it "Frontend users".

    Creating a folder for storing the users and groups
  2. Navigate to the Web > List module, and select your new folder.
  3. Click the + Create new record icon at the top left of the Docheader. The "New record" wizard displays.

    Select "Usergroup" with the new record wizard
  4. Click Website Usergroup to create a new frontend group.
  5. Name it "Private Area".

    Creating a new frontend group
  6. Save and close the record.
  7. Use the "New record" wizard again, but this time create a Website User.
  8. Type a username, a password and click the "Private Area" group to select it.

    Creating a new frontend user

    You can add further information on the Personal Data tab if required.

  9. Save and close the record.

Assign access rights

Now that we have at least one group, and a user assigned to that group, we can assign access restrictions. This is done on the Access tab of the page properties or content element properties.

Usergroup access rights
  1. Navigate to the Web > Page module, and create a new page called "Members only".
  2. Add a text content element to the Members Only page, with text similar to "You need to authenticate to access the members area".
  3. On the Access tab, select the "Hide at login" group for it.
  4. Save and close the record.
  5. Add another text content element to the page, with text similar to "Welcome to the members area".
  6. On the Access tab, select the "Private area" group for it.
  7. Save and close the record.

You should have something like this:

Placing access restriction on individual content elements

Try setting the access for an entire page to "Private area". When you save the page, notice how the icon in the page tree changes. This is a visual reminder that the page is not public. If you try to access a restricted page in the frontend, the TYPO3 error message "Page Not Found" will display.

Add a login form

The next step is to place a login box somewhere on the site so that visitors can log in to view the restricted content.

  1. On the "Members only" page, click the + Content button between the two existing content elements.
  2. In the new content element wizard, go to the Form elements tab and select "Login Form".
  3. Give it a header (for example, Log in).
  4. Go to the Plugin tab. There are several options for the Login Form, but the only one which is absolutely necessary is the "User Storage Page".
  5. Use the Browse for records icon to browse the page tree and select the "Web site users" folder.

    Defining a new login form
  6. Save and close the record.
  7. View the page. You should have something like this:

    The page with the login box
  8. Enter the user name and the password you defined earlier for the frontend user, and you should see the following:

    The page with the authenticated user

This is just a quick overview of the login form provided by TYPO3 CMS. It has a rich set of features that are described in the Frontend Login manual.

Deep Linking

Deep linking allows users to share links to specific pages, content elements and modules from within TYPO3's backend.

For example, a user could be writing content for a new page that is about to be published. Using deep links, they can share a link to the page they are working on or even share a link to the actual content element that contains their work and send it to another member of the team for review.

Backend search

The backend search tool accepts text and searches against various types of records in the backend.

The search can be opened by selecting the magnifying glass in the top right corner of the toolbar or by pressing the Cmd + K keystroke on macOS or the Ctrl + K keystroke on Windows and Linux systems.

The backend search modal with some search results

The backend search modal with some search results

Internal notes in the TYPO3 backend

Internal notes, also called system notes, are small text notes that are displayed in the Page module and List module.

You can use them to write notes to yourself or other editors. Administrators can use them to write notes to you as well.

They look like this:

Screenshot of a TODO note on the top of the "Page" backend module

If you have sufficient permissions you can also edit or delete the note.

The following image shows a detailed view of the TYPO3 backend toolbar, specifically in the context of the "Page" or "List" module. On the right side of the toolbar are a number of buttons, each providing different functionality. The button highlighted in this screenshot is which allows the user to create a new internal note.

Screenshot demonstrating the location of the "Create internal note" button in the module header of the Page module

The button to create a system note is located on the top right of the "Page" and "List" modules

Keyboard commands

Actions in backend forms

  • ctrl + s = Save
  • ctrl + shift + s = Save and close
  • cmd (⌘) + s = Save
  • cmd (⌘) + shift + s = Save and close

Editing text in the Rich Text Editor (RTE)

Below is a list of common keyboard commands that can be used when editing text in TYPO3's RTE.

  • ctrl + a = Select all text
  • ctrl + c = Copy
  • ctrl + v = Paste
  • ctrl + x = Cut
  • ctrl + z = Undo
  • ctrl + i = Italic
  • ctrl + b = Bold
  • cmd (⌘) + a = Select all text
  • cmd (⌘) + c = Copy
  • cmd (⌘) + v = Paste
  • cmd (⌘) + x = Cut
  • cmd (⌘) + z = Undo
  • cmd (⌘) + i = Italic
  • cmd (⌘) + b = Bold

Reloading pages and clearing browser cache

  • F5 = Reload
  • ctrl + F5 = Reload page and clear browser cache
  • cmd (⌘) + r = Reload page
  • cmd (⌘) + option (⌥) + r = Reload page and clear browser cache

Opening the backend search modal

New in version 12.0

  • ctrl + k
  • cmd (⌘) + k

Multiselect in content elements

New in version 12.3

The keyboard commands can be used on a select element:

A multiselect element

A multiselect element

Or a folder element:

A folder element

A folder element

Or a group element:

A group element

A group element

Selecting and deselecting options with the keyboard:

  • enter = Add options, either from right to left or left to right
  • delete or backspace = Remove an option for Windows and Mac users
  • alt + arrow up = Move the option one up
  • alt + arrow down = Move the option one down
  • alt + shift + arrow up = Move the option to the top
  • alt + shift + arrow down = Move the option to the bottom

More combinations:

  • shift + arrow up = Include the upper option
  • shift + arrow down = Include the lower option
  • home = Move the cursor to the top
  • end = Move the cursor to the bottom

TYPO3 online documentation

You can find the startpage of the official TYPO3 documentation at https://docs.typo3.org/ .

You can conveniently open this documentation from your TYPO3 backend:

In the top bar, click the question mark icon to access the Help section, then select the TYPO3 Online Documentation module.

The TYPO3 Online Documentation in the Help menu

The TYPO3 Online Documentation in the Help menu

Tooltips

Hover your mouse pointer over buttons and icons to display a short description
of the function.
Tooltip for the Forms module

See the Tooltip help for the Forms module

Concepts

The following concepts are of interest:

Cache

A beginners guide to browser caching and managing TYPO3's cache.

File Abstraction Layer

Information about TYPO3's File Abstraction Layer (FAL) and how editors can modify meta data for individual files.

Accessibility

An introduction to writing accessible content with links to third party resources.

Copyright

Information on copyright and data privacy.

Cache

Computing a page to be displayed in the frontend requires time and resources.

TYPO3 (and many other CMS) use caching to help reduce the amount of time and resources it takes to generate a page.

When you display a page in the frontend, TYPO3 first checks if that page can be found in the cache and has already been calculated. If the page is found in the cache, the previously calculated result is delivered right away. If the page is not found in the cache, it is generated by collecting data from different sources and performing some calculations. The result is then delivered to the visitor and stored for future use.

Browser cache

The browser on the client machine (Chrome, Edge, Firefox, etc) also caches pages. Sometimes you cannot see changes you have made to a page because your browser has cached the old content.

It depends on the browser and the operating system, how you can clear your browsers cache.

On Windows in most browsers you can press Ctrl + F5 to clear the browser cache.

Automatic cache clearing

With TYPO3, the cache of a page is cleared automatically in the following cases:

  • You changed something about the page itself like its title
  • You changed a content of the page like a text or image on that page
  • In certain time intervals, usually once a day
  • If content with a starttime or endtime set becomes visible or invisible
  • In some other cases that your integrator or developer might have defined

Scenario: Changes are not visible in the frontend

If the cache did not get automatically cleared, the changes you made might not be visible right away in the frontend.

Some scenarios in which manual cache clearing might be necessary:

  • You changed the title of a page. You view the affected page and everything looks fine. Now you go to the start page and cannot see your change in the menu. The following happened: Changing a pages title deletes the cache of the affected page. It does, however, not delete the cache of other pages like the start page.
  • You added a news record. It does not appear in the news list. Creating a record does not automatically delete the cache of any page unless the integrator made some configurations.
  • You changed content on one page that should also be displayed on other pages. This is often done with static parts of the page that should be editable such as the footer, a carousel in the header, etc.

Manual cache clearing

Clearing the cache of a single page can be done without ill effect in most installations.

To clear the cache of that page, go to the module Web > Page and click the button representing a lightning bolt with the tooltip Clear cache for this page.

Clear cache for this page

Clear cache for this page

When you reload the affected page, the changes should be visible right away. If the changes are not visible, clear the Browser cache. Or use an incognito tab in your browser.

Only editors who have the relevant user rights can flush the cache of all pages. If you cannot see the lightning bolt button beside the help menu button in the toolbar you might not have the rights to carry out this action:

Flush cache of all pages

Flush cache of all pages

Previewing a page without clearing the cache

If you need to preview a page and cannot clear its cache you can use the parameter no_cache=1 to preview the page as it will look once the cache is cleared. This option might have been disabled by the administrator however.

For example, visit https://example.org/community/events?no_cache=1.

File abstraction layer (FAL)

TYPO3 has a file abstraction layer (FAL) integrated which abstracts technical details (where the file is stored) and allows to work with different storage forms.

FAL also allows the editors to manage meta data that can be displayed wherever an asset is displayed. The metadata can also be used for copyright notices.

Working with multi media: Digital asset management

Multi media assets (images, videos, audio, etc) are usually stored as files on the server. Especially videos are frequently displayed from third-party sources such as Youtube or Vimeo.

In TYPO3 you can manage all assets in the backend module File > Filelist if you have sufficient permissions. See chapter Managing files in the TYPO3 CMS.

Accessibility

Accessibility is the design of products, services, [...] or environments so as to be usable by people with disabilities. The concept of accessible design and practice of accessible development ensures both "direct access" (i.e. unassisted) and "indirect access" meaning compatibility with a person's assistive technology (computer screen readers, keyboard only access).

https://en.wikipedia.org/wiki/Accessibility

As an editor, it is your responsibility to help provide accessible content.

Writing accessible text

See also the following W3C page: Writing for Web Accessibility

Provide informative, unique page titles

The title of a page can - in most cases - be influenced in the page properties. Part of the page title - such as the name of the organization - might be added automatically. Ask your developer about this.

Use headings to convey meaning and structure

Almost all content elements have the ability to provide a heading.

Depending on your user rights you may also be able to influence the level of the heading (Headlines > Type). The choice of the level of the heading should be made in accordance to the semantics of the text and not according to design choices.

The rich text editor (RTE) also offers the ability to create headlines of different levels.

Write meaningful text alternatives for images

In TYPO3 when you are uploading or managing an image file in the module File > Filelist you can provide an alternative text in the metadata of this file.

When you are displaying an image as Image content element you can override the alternative text to fit the context or use the default.

About this guide

Credits

This guide is based on material originally written by Marlies Cohen and Eikaa.

It has since been updated by Susanne Moog, François Suter and Felicity Brand.

Thanks to them all!

Feedback

If you find a bug in this guide, please use the "Edit on GitHub" button in the top right corner and submit a pull request via GitHub. Alternatively you can file an issue using the bug tracker: https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-Editors/issues.

To support the translation to other languages see Internationalization and Localization.

Maintaining high quality documentation requires time and effort and the TYPO3 Documentation Team always appreciates support. If you want to support us, please contact us as described in the next section.

Contact the Documentation Team

For general questions about the documentation get in touch with the Documentation Team.

Next steps

If your activities are not limited to editorial work, you may want to further learn about TYPO3 CMS by following the Sitepackage Tutorial. This tutorial teaches you to create individual templates using Fluid and some TypoScript. There are also some sitepackage generators you can use.

Sitemap