Study guide · Backend and Editing
The TYPO3 backend for editors and consultants
As a consultant, you need to know the TYPO3 backend well enough to demonstrate it, plan training and design editorial workflows. To do that, we follow the tourism association Seetal Holiday Region. Editors such as Lena maintain the content there, the head of marketing, Ms Berger, approves changes, and hosts get an area that is only visible after logging in. Afterwards you know what an editorial team can do without a developer, and where the limits are.
Frontend, backend and the browser
The frontend is the website that visitors see in their browser. It is built from the content and the Fluid templates of the installation. The backend is the administration interface. There, authorised users create and publish content, configure sites and manage users.
By default, you reach the backend under the path typo3 of the domain, for example at example.org/typo3. Since TYPO3 13 this entry point can be changed. If the path does not work, the correct address is in the project documentation, or you ask the administrator.
The backend runs entirely in the browser, and there is no desktop application. Current versions of Chrome, Edge, Firefox and Safari are supported. JavaScript must be enabled, otherwise even the login fails. TYPO3 needs cookies for the session.
With HTTPS, the connection between browser and server is encrypted with TLS. With HTTP it is unencrypted, and third parties can read data such as passwords. That is why a backend always belongs behind HTTPS.
Logging in and your own account
Lena logs in with her username and password. If she has set up multi-factor authentication, MFA for short, TYPO3 then asks for a second factor. So she needs something she knows, namely the password, and something she has, for example an authenticator app. TYPO3 ships time-based one-time codes, called TOTP codes, and recovery codes. A stolen password alone is then no longer enough.
Forgot your password? The login page offers a link for this, and TYPO3 sends a reset link by email. This only works if the feature is enabled, the account has a valid email address and TYPO3 can send emails. Otherwise, the administrator helps. After too many failed attempts, TYPO3 blocks the login for a while.
Her own account is something Lena maintains herself. A click on her username in the top bar opens the User Settings. There she changes her name, email address, language and password, and sets up MFA. The module Users in the Administration area, on the other hand, is reserved for administrators.
A tour of the backend
- The top bar contains the bookmarks menu, the lightning bolt icon for clearing caches, system information, the search and the user menu with User Settings and logout.
- The module menu on the left is the central entry point, divided into main modules with submodules. Which modules someone sees depends on their permissions.
- The page tree shows all pages in a hierarchy and usually matches the navigation. The page with the globe icon is the root of a website.
- The folder tree in the Media module, by contrast, shows the folders of a file storage, by default fileadmin.
- The docheader above the content area holds save, close, view, share and the language selector.
- The content area is where the work happens: arranging a page, filling in a form, editing a list.
New module names in TYPO3 14. Older training material uses other names. The main module Web is now called Content. It contains Layout, formerly Page, Records, formerly List, Preview, formerly View, and Status, formerly Info. On top of that come Publish for workspaces, Recycler and Forms. File management is called Media. Under Sites you find, for example, Setup, Settings and Link Management. Under Administration there are Users, Permissions, Log and Scheduler, among others, and under System, for example, Maintenance and Extensions.
Search. The magnifying glass in the top bar, or Ctrl plus K, Cmd plus K on a Mac, opens the backend search. It searches pages, content elements, other records and backend modules. You can search for keywords, IDs or a frontend URL. Inside the Rich Text Editor, the same shortcut inserts a link instead.
Deep links and bookmarks. A deep link points directly to a page, a content element or a module in the backend. You create it with the Share icon in the docheader. This is how Lena sends the head of marketing the draft of the page “Hiking along the lake” for review. Copying the URL from the address bar is not recommended. In the same Share menu, you create a bookmark. The bookmark icon in the top bar opens the list of your bookmarks.
Pages and page types
Editors work on pages in the Layout module in the Content area. Lena selects a page in the page tree on the left and edits its content elements. She drags new pages into the page tree, or she uses the context menu. From there she can also copy, move, hide and delete pages.
A disabled, that is hidden, page cannot be reached in the frontend, but in the backend it stays fully editable. So Lena can prepare a page and switch it on later. Nothing is deleted.
The standard page types:
- Standard is the normal page with content.
- A Backend User Section is only visible in the frontend if you are logged in to the backend.
- A Shortcut sends visitors on to another page in the page tree. No copy is created.
- A Mount Point includes a whole subtree at another place in the page tree.
- A Link points to external URLs, files or individual content elements.
- A Folder holds records such as news or frontend users, or collects pages that are not in the main menu, for example for a footer menu. It does not appear in the frontend at all, not even as an empty page.
- A Menu Separator is a divider in the page tree and in the menu. It does not list any subpages.
The Preview module in the Content area shows the page inside the backend and offers a selector for screen sizes such as smartphone or tablet. This way Lena checks the display without leaving the backend. Nothing is published.
Page properties and the URL segment
The page properties are divided into tabs:
- The General tab holds the page type, page title, alternative navigation title and the URL segment.
- The SEO tab holds the title for search engines, the description, the robots settings index and follow, and the canonical link. It also has settings for the XML sitemap.
- The Social Media tab holds the title, description and image for sharing on social networks.
- In the Appearance tab you choose the page layout.
- The Access tab holds visibility, publish date, expiration date and frontend groups.
The page title appears as the label in the menu and in the title element of the HTML page. TYPO3 also generates the URL segment from it. If the menu should show a different text, you use the alternative navigation title.
The page layout, technically the backend layout, defines which content areas are available in the Layout module, for example a main column and a sidebar. Usually the matching frontend template depends on it as well.
The URL segment, also called slug, forms the address of the page. If you change it, the URL changes. If the system extension Redirects is installed, TYPO3 automatically creates a redirect from the old address to the new one. A notification appears, which also lets you undo the change. This way, old links and search engine results do not lead nowhere.
Creating and maintaining content elements
Lena creates content in the Layout module: add new content in the desired column, choose the type, fill in the form, save. The most important element is called Text and Media. It combines text with images, videos or audio and can also embed YouTube or Vimeo videos. Other types include “Header only”, “File links” for downloads, and “Insert records”, which shows existing content elements again.
The header type, such as H2 or H3, creates a heading element of level one to six in the frontend, and with that the outline of the document. Screen readers and search engines read the structure from it. So choose the type by the hierarchy of the content, not by the size you want.
Images are references. The original file lives in the Media module, and in the content element Lena works with a reference to it. If she crops the image or overrides the alternative text, this only applies to this one usage. The file in fileadmin and its default metadata stay unchanged.
Forms are created in the Forms module with the form editor, also from templates such as a simple contact form. On the page, editors insert the content element “Form” and choose the form definition in the Plugin tab. The Form Framework is a system extension that the administrator has to activate.
Changing the type. If Lena switches an element from “Text and Media” to “Header only”, TYPO3 reloads the form with the matching fields. Text and images are not deleted. They are only hidden and come back when she selects the old type again. The frontend only shows what belongs to the current type.
Unused elements. When you change the page layout, a content area may disappear. Elements in it no longer belong to any valid column. The Layout module lists them at the bottom as unused elements, and usually they are not rendered. You drag them into a valid area or delete them.
Editing at the same time. If Lena opens an element that her colleague is currently editing, TYPO3 shows a notice that another user began to edit it a few minutes ago. Nothing is locked or merged. If both save, the version saved last wins and overwrites the other one. So agree with each other first.
When something is missing or does not show up
Deleted does not mean gone. TYPO3 first only marks deleted records as deleted. The Core offers two ways back. The Recycler module in the Content area restores content and whole pages, provided it is installed and Lena has the permissions. The history of a page, available through the context menu, shows who changed what and when, and undoes changes, including deletions. You only need a database backup if records have been removed for good.
The change does not show up. Lena saves, but the frontend still shows the old state. Typical causes:
- The browser is still showing a cached version. Clearing the browser cache or opening a private window helps.
- Saving failed, for example because of a required field or an invalid value in another tab.
- The website works with workspaces, and the change has not been published yet.
- Another page is still delivering its cached state.
The Rich Text Editor
Text fields such as the body text in “Text and Media” use the Rich Text Editor, RTE for short. In TYPO3 this is CKEditor 5. It works much like a word processor: you add headings, lists, tables and links. Which buttons appear is defined by the RTE configuration of the installation.
Setting links. Lena selects the text and clicks the link icon, or presses Ctrl plus K, Cmd plus K on a Mac. In the link browser she links to pages, content elements, files, external URLs, email addresses or phone numbers.
Use bold and italic on purpose. The editor outputs bold as strong and italic as em. Both express emphasis in the content, which screen readers also convey. Pure design such as colours or sizes is the job of the template styles.
Records in the Records module
News, frontend users or categories are records. The Records module in the Content area, called List until TYPO3 13, shows all records of a page or folder, grouped by type. It is mainly used for records without a module of their own, such as frontend users and frontend groups. Files are managed in the Media module.
Copying. When Lena pastes a copy, TYPO3 adds “copy 1” in brackets to the title and hides the copy. That way it does not appear in the frontend by accident. Integrators can switch off both with TSconfig, using disablePrependAtCopy and disableHideAtCopy.
Not every record fits everywhere. Some record types may only be stored on pages of the type Folder, for example frontend users and frontend groups. If Lena tries to paste a copied frontend group on a normal page, TYPO3 rejects it with an error message. She switches to a suitable folder and pastes it there.
Unique fields. Some fields must be unique. The username of a frontend user, for example, may only occur once in the same folder. So when Lena pastes a copy there, TYPO3 appends a number and reports the change. Lena then enters a suitable unique name.
Editing many records at once. A click on the table name shows only that table. Then Lena proceeds like this:
- With “Show Columns” she displays the fields she wants to change, for example the header.
- She selects the records, for example with “Check all”.
- “Edit columns” opens a form with only these fields of all selected records.
The clipboard. For one record, the normal clipboard is enough. For several records there are numbered clipboards, three by default, such as “Clipboard #1”. Lena shows the clipboard through the View menu and activates a numbered pad. There she collects records, even of different types and from different pages. On the target page she pastes them all in one step, in move mode, which is the default, or in copy mode.
Download. The list view offers downloading as CSV or JSON. For CSV you choose the delimiter, such as comma, semicolon or vertical bar, and the text qualifier. There are no Excel or PDF exports there, and no re-import through this function either.
Who sees what: access in the frontend
For the hosts' area, Seetal needs frontend users, that is website visitors with an account. They always belong to frontend groups, because access is always granted to a group, never to a single user. In the Access tab of a page or content element, you select the group, for example “Hosts”. So that people can log in, the website also needs a login form.
There are also two fixed entries for pages and content elements:
- Hide at login shows an element only as long as nobody is logged in.
- Show at any login shows an element to every logged-in frontend user, no matter which group they belong to.
If a visitor who is not logged in opens a page directly that is only released for one group, TYPO3 does not deliver it. It answers with status 403, that is “Access denied”. What the error page looks like is decided by the error handling of the site. Older versions of the editors' tutorial speak of “Page Not Found”. There is no automatic redirect to the login. The project has to solve that itself, for example with its own error handling or the configuration of the frontend login.
Scheduling. With the publish date and expiration date in the Access tab, you define when an element is visible. This way the winter offer appears on 1 November and disappears on 31 March. Outside this period it stays in the backend, and nothing is deleted. If you open a page with a publish date in the future, TYPO3 reports it as not found, that is status 404. This also applies to logged-in editors in the normal frontend. What appears then is decided by the error handling of the site. Before the date, editors check it with the preview in the backend.
Extend to Subpages makes the publication period and access restrictions of a page apply to all its subpages as well. So you lock the whole hosts' area with one setting. Titles and content of the subpages stay untouched.
Workspaces: draft, approval, publishing
Before the season starts, Seetal wants to rework many pages without anything half-finished going online. That is what workspaces are for. The system extension workspaces is part of the Core, but it is not installed by default.
In the live workspace, every change applies immediately. Access to it must be granted to users or groups explicitly. In a custom workspace, TYPO3 automatically creates a new version with every change, and the live website stays untouched. Only tables that support versioning can be edited there. An option in the workspace record does allow other records too, but changes to them then go live immediately. When publishing, the live record keeps its uid, that is its number, and all references to it stay intact.
Stages. By default, a custom workspace has the stages “Editing” and “Ready to publish”, followed by publishing. Custom stages, such as a legal review, always sit in between. With every change of stage, the people involved can be notified by email. Anyone allowed to publish can do so from any stage, unless this is restricted. So a change does not have to pass through all stages.
Preview for the client. Inside the workspace, you see the website as it would look after publishing. There are also preview links. You can share them with anyone, even with people who have no access to the backend, for example the client for sign-off. A preview link is valid for 48 hours by default, adjustable with the User TSconfig option options.workspaces.previewLinkTTLHours. A scheduler task cleans up expired links.
Publishing. The Publish module in the Content area, formerly Workspaces, lists all changes. You can publish or discard elements one by one. Be careful with the mass actions: if no element is selected, publish or discard affects the whole workspace. This includes changes in other branches of the page tree that are not visible right now. If Lena has only selected the News section on the left, the mass action still publishes everything. To publish only part of it, select the elements individually. Integrators can disable mass actions with User TSconfig.
Scheduled publishing. The winter campaign should go online automatically on 1 December at midnight, with several pages and content elements. In the Publishing tab of the custom workspace, you enter a publish date. The scheduler task “Workspaces auto-publication” checks this date. Once it has passed, the task publishes all changes that have reached the stage “Ready to publish”. Changes in earlier stages stay where they are. Alternatively, single elements can be scheduled with the publish date in the Access tab.
Limits. Workspaces separate drafts within one installation. They do not transfer content from a test server to the live server. Export and import or community solutions do that. The option to freeze a workspace for editing no longer exists since TYPO3 14.
Key points in brief
- The backend runs in the browser under the path typo3, needs JavaScript and cookies, and belongs behind HTTPS.
- In TYPO3 14 the modules are called Content with Layout, Records, Preview, Publish and Recycler, plus Media, Sites, Administration and System.
- Deep links and bookmarks are created with the Share icon in the docheader.
- A shortcut sends visitors to one page, a mount point includes a subtree, and a folder never appears in the frontend.
- A new slug needs a redirect. Automatic ones use 307 by default, permanent is 301.
- Cropping and alternative text in the content element only apply to that one usage. When two people edit at the same time, whoever saves last wins.
- Access is granted to groups. “Hide at login” is for guests, “Show at any login” for everyone logged in.
- Workspaces have the stages Editing and Ready to publish. Preview links last 48 hours, mass actions affect the whole workspace, and files are not versioned.
Terms
- Backend layout
- Defines which content areas a page has in the Layout module.
- Deep link
- Shareable link straight to a place in the backend.
- Docheader
- Bar with actions above the content area.
- Frontend group
- Group of website visitors with an account, which is given access to pages and content.
- MFA
- Login with a password plus a second factor, such as a code from an app.
- Mount point
- Page type that includes a whole subtree at another place.
- Reference
- Usage of a file in a piece of content, with its own cropping and metadata.
- Slug
- URL segment of a page.
- Stage
- Approval step in a workspace.
- Workspace
- Draft area where changes are prepared and checked before publishing.