TYPO3 Documentation
How to Document TYPO3
Options
Give feedback View source View as Markdown How to edit Edit on GitHub

How to Document TYPO3

BASICS

  • Basic principles
  • ReST Cheat Sheet
  • Markdown Cheat Sheet

REFERENCE

  • reStructuredText
    • Code blocks and code structure
      • Code blocks
      • Configuration values (confval)
      • Inline code
      • PHP domain
      • Site settings
    • Directives
      • Accordion
      • Admonitions: tip, note, warning, see also, etc
      • Cards
      • Comments
      • Special characters
      • Tables
      • Tabs
      • Versions
      • ViewHelper
      • Embed YouTube videos
    • Figures and diagrams
      • Images
      • Zoom and lightbox
      • Float and alignment
      • PlantUML diagrams
    • Inline Markup
      • Bold, Italic etc.
      • Text Roles
    • Links
      • Anchors
      • API links
      • Composer / Extensions
      • Core source
      • Documentation references
      • example.org
      • External URLs
    • Lists
      • Styled numbered sections (bignums)
      • Bullet lists / unordered lists
      • Definition lists
      • Directory tree
      • List items as buttons
      • Numbered lists
    • Menus and headers
      • Headlines
      • Main menu
      • Content menu
      • Including files
      • Navigation title
      • Orphans
      • Sidebar
  • CGL for ReST files
  • File structure
  • guides.xml
  • Rendering container
  • Screenshot container
  • Rendered artifacts

HOWTOS

  • Edit Locally
  • Edit on GitHub
  • Contribute
    • Help
  • Migrate
    • Markdown to ReST
  • Render
    • Automatic re-rendering (WYSIWYG)
  • Document extensions
    • Webhook
    • Reregister versions
    • FAQ
    • Contribute to system extensions
    • Contribute to third-party extensions

ADVANCED

  • Advanced
    • Coding guidelines for reST files
    • Commit messages
    • Spelling
    • Formats (reST, Markdown)
    • Spelling, terms and glossary
    • Guidelines for creating images
    • How to add translations
    • Licenses
    • Redirects
    • Policy for making and reviewing contributions

MAINTAINERS

  • For maintainers
    • Backport changes
    • Changelog
    • Code snippet generation
    • Fluid ViewHelper reference generation
    • New major Core version
    • Tools of the Documentation Team
  • Sitemap

Options

Give feedback View source View as Markdown How to edit Edit on GitHub
  1. How to Document
  2. reStructuredText
  3. Links
  4. example.org
Give feedback Markdown Edit on GitHub

Example domain: example.org 

The renderer automatically converts simple URLs into links. This can be unintentional in certain contexts, for example when using a hypothetical domain like "example.org" or placeholders instead of real query parameters in a tutorial. To prevent linking, the TYPO3 documentation uses the :samp: directive to wrap the URL.

For example:

The TYPO3 backend can be accessed via :samp:`https://example.org/typo3` ..
Copied!

is rendered like:

The TYPO3 backend can be accessed via https://example.org/typo3 ..

To emphasize parts of the URL, use curly braces:

The *route* is the "speaking URL" as a whole without the domain part,
for example :samp:`https://example.org/<page-path>/{<page-name>}`.
Copied!

is rendered like:

The route is the "speaking URL" as a whole without the domain part, for example https://example.org/<page-path>/{<page-name>}.

Hypothetical domains 

The TYPO3 documentation uses a defined set of dummy domains when describing URLs where the domain name does not matter, but serves as a placeholder. The defined set is

  1. https://example.org
  2. https://example.com
  3. https://example.net

– in this order: https://example.org as the preferred domain, and https://example.com and https://example.net as alternatives if multiple domains are required in the same context.

Why is https://example.com not preferred, as common sense would have it? Because the preference for .org over .com fits with the fact that the TYPO3 documentation is hosted on https://typo3.org and the TYPO3 Association is owning the TYPO3 GmbH.

For explicit mention of the local development context it uses

  1. https://example.localhost.

If you need additional dummy domains, use subdomains of the domains listed above such as https://staging.example.org and https://production.example.org.

For example:

The class :php:`MailMessage` can be used to generate and send a mail without
using Fluid:

..  code-block:: rst

    $mail = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Mail\MailMessage::class);
    $mail
        ->from(new Address('john.doe@example.org', 'John Doe'))
        ->to(
            new Address('receiver@example.com', 'Max Mustermann'),
            new Address('other@example.net')
        )
Copied!
  • Previous
  • Next
Reference to the headline

Copy and freely share the link

This link target has no permanent anchor assigned. You can make a pull request on GitHub to suggest an anchor. The link below can be used, but is prone to change if the page gets moved.

Copy this link into your TYPO3 manual.

  • Home
  • Contact
  • Issues
  • Repository

Last rendered: Oct 01, 2026 06:42

© since 2017 by the TYPO3 contributors
  • Legal Notice
  • Privacy Policy