Usage Tips ¶
General 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 an extension manual like ext:form or a tutorial like Getting Started Tutorial .
You can regard the “glue pages” as a special top-level manual which is used for information, orientation and navigation. Most manuals are linked to from the “glue pages”, so you can use the “glue pages” to find what you are looking for.
The “glue pages” contain :
Go to Start Page ¶
Wherever you are, you can click TYPO3 Documentation in the top left to return to the start page (click the image for an animated demo!):
Go to the Start Page of a Manual ¶
When you are viewing a page of a manual (not the “glue pages”), you can go to the start page of the manual by clicking on the title of the manual (directly under “TYPO3 Documentation” ).
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 of the menu: Click on “Related Links” and then select a version. The version usually reflects the TYPO3 version, so for example choose 8.7 if you are using TYPO3 8.7 LTS. Click the image for an animated demo!
You cannot select a version from the page you are currently reading. The “glue pages” are not specific to a TYPO3 version.
The search box only searches in the selected manual. For example, if you are reading Getting Started Tutorial , then search will only search within this manual.
For a global search, use a search engine.
Restrict the search to
you only want to search within
the official documentation on docs.typo3.org.
Just add your search query to one of these queries:
Browse Pages by Keyboard ¶
Each manual knows about a linear sequence of its pages. Click on the buttons Next or Previous to move forwards or backwards in that sequence. The buttons are located on the bottom of every page and on the top (in a smaller and more dimmed variant).
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:
|Linux||any||Alt + Shift|
|OSX 10.6||Safari, Firefox, Chrome, iCab||Ctrl + Alt|
|Win7||Firefox||Shift + Alt|
|Windows||IE||Alt + <character> + enter|
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.
Previous Page ¶
Press access key + p or click “Previous” to go to the page that precedes the current page.