Note

This version of the guide covers the new PHP-based rendering of Documentation with the TYPO3 Documentation theme.

If the project you are looking at has a file Documentation/guides.xml it is using the new rendering.

Otherwise, consider to migrate the Documentation or head over to the legacy version of this guide: How to document, Sphinx based.

Spelling, terms and glossary¶

Spelling¶

Pick the spelling and recommended terms from this list.

A

Apache, API,

B

backend, blog post, blogger, blogging,

C

code sprint,

command line, run something at the command line, command-line something, run a command-line spell-checker,

Composer, Core Team, TYPO3 Core Team, Core, TYPO3 Core cross-site scripting, Crowdin, CSV (comma separated values), checkbox

D

Data Processor, DBAL Docker, Docker Compose, Doctrine Documentation Team, TYPO3 Documentation Team, DataHandler,

E

Edit on GitHub, Edit on GitHub button, Edit on GitHub workflow, Extbase Extension Manager extension,

F

FlexForm, Fluid, FormEngine, frontend, frontend rendering,

G

Git, GitHub,

H

how to document, how-to, a how-to video,

I

InnoDB, Introduction Package,

L

LinkHandler, Linux,

M

Markdown, mark up the text, markup (the), MariaDB, MySQL, MacOs, outdated: Mac, Mac OS X, model-view-controller, MVC,

N

nginx

O

Open Source,

P

page TSconfig, PNG, PostgreSQL

Q

quick start,

R

reStructuredText, reST, richt text editor, RTE

S

sitepackage, Sphinx style guide (en), Styleguide (de), SVG, system extension, not: 'sys extension', core extension

T

TCA, TCE, TCEforms, TCEmain, textrole, third party extension, toctree, TSconfig, TYPO3, TYPO3 Core, Core, TYPO3 Core Engine, TYPO3 Core Team, Core Team, TYPO3 Core Engine, TYPO3 v11, TYPO3 v11.5, TYPO3 v11 LTS, TYPO3 version 11, TypoScript,

U

UNIX,

V

ViewHelper

W

Windows, Microsoft Windows, windows, modal windows,

Terms¶

How to use these terms:

reStructuredText: Use reST as abbreviation.
reST: reStructuredText is a 'Markup Syntax and Parser Domponent of Docutils'.
TYPO3: Always and everywhere written with capital letters.
third party extension: Do not write "3rd party extension".
ViewHelper: Our community agreed on this spelling.