Usage Tips

Structure

The page you are currently reading is part of a few start pages we call "glue pages". From here, everything else is linked. The entire documentation is built out of individual "manuals". This can be, for example, an extension manual like ext:form or a tutorial like Getting Started Tutorial.

When you are on the start page https://docs.typo3.org, you can use the menu to navigate to one of the manuals, for example go to the Tutorials and Guides page or Extensions by Extension Key to select an extension.

../../_images/mobilemenu.svg

Menu on mobile

../../_images/menu1.svg

Desktop view

Start Page

Wherever you are, you can click TYPO3 Documentation in the top left to return to the start page:

../../_images/home.png

Click the image for a demo!

../../_images/home.gif

Version Selector

When you are reading a manual, for example the Getting Started Tutorial, you can select a version from the version selector on the bottom: Click on Related Links and then select a version. The version usually reflects the TYPO3 version, so for example choose 9.5 if you are using TYPO3 9.5 LTS.

../../_images/version-selector.svg

Click the image for a demo!

../../_images/version-selector.gif

Note

You cannot select a version from the page you are currently reading. The start page and the "glue pages" are not specific to a TYPO3 version.

Browse Pages by Keyboard

Each manual knows about a linear sequence of its pages. Click Next and Previous to move forwards or backwards in that sequence.

The good news is that these functions are also available from the keyboard by the "access keys".

What's an "Access Key"?

In a web browser, an access key or accesskey allows a computer user to jump to a specific part of a web page via the keyboard.

Unfortunately each browser seems to use its own modifier to make the access key work. In most web browsers the user invokes the access key by pressing the "modifier (which often is Alt or Ctrl) simultaneously with the appropriate character on the keyboard. So we have for example:

OS Browser Modifier
Linux any Alt + Shift
OSX 10.6 Safari, Firefox, Chrome, iCab Ctrl + Alt
OSX 10.7 Firefox Ctrl
Win7 Chrome, Safari Alt
Win7 Firefox Shift + Alt
Windows IE Alt + <character> + enter

Tip

Hover over the Next or Previous button on the top or bottom of the page to see the tooltip.

Next Page

Press access key + n or click Next to advance to the next page in line.

click on 'next'

Previous Page

Press access key + p or click "Previous" to go to the page that precedes the current page.

click on 'next'