TYPO3 Logo
Writing Documentation
Release: main

Loading data.

BASICS

  • About this guide
  • Help & Support
  • Basic principles
  • Documentation content style guide
    • Spelling
    • Spelling, terms and glossary
    • File structure
    • Formats (reST, Markdown)
    • Coding guidelines for reST files
    • Guidelines for creating images
    • Commit messages
    • Licenses
  • reStructuredText & Sphinx
    • Introduction
    • Basic reST & Sphinx syntax
    • Common pitfalls
      • Problems with headers
      • Problems with links
      • Problems with indents
      • Problems with inline style
      • Problems with lists
    • reST & Sphinx cheat sheet
    • reST & Sphinx reference
      • Bold, Italic etc.
      • Hyperlinks & cross referencing
      • Code blocks with syntax highlighting
      • Inline code & text roles
      • Headlines and sections
      • Toctree and the hierarchical structure of a manual
      • Content menu
      • Including files
      • Bullet lists
      • Numbered lists
      • Definition lists
      • List items as buttons
      • Styled numbered sections (bignums)
      • Configuration values (confval)
      • PHP domain
      • Images
      • Embed YouTube videos
      • Tip, Note, Important etc. (Admonitions)
      • Comments
      • Tables
      • Cards
      • Tabs
      • Special characters
      • Graphviz graphs
      • PlantUML diagrams
      • Orphaned pages
      • Clever reST
      • Special styles
      • Sidebar
  • User’s round trip

HOWTOS

  • How to write good content
    • Tips for writing good content
    • Writing a tutorial
    • Writing Resources
  • How to document an extension
    • Register for docs.typo3.org
    • Webhook
    • Reregister versions
    • FAQ
    • Contribute to system extensions
    • Contribute to third-party extensions
  • Contribute to the TYPO3 documentation
    • Workflow #1: “Edit on GitHub”
    • Workflow #2: “Local editing and rendering with Docker”
    • How You Can Help
  • Tools for Editing reST
  • How to render documentation
    • Rendering the documentation with Docker
    • Rendering the documentation with Docker Compose
    • Troubleshooting local rendering with Docker
  • How to work with GitHub

ADVANCED

  • How to add translations
  • Update documentation for new releases
  • Guidelines for reviewing manuals

MAINTAINERS

  • For maintainers
    • Backport changes
  • Sitemap
  • Index
  • Appendix
    • Example Toctree
      • Topic1
        • Subtopic 1
        • Subtopic 2
    • Information for editing this guide

PAGE CONTENTS

  • Problems with links
    • Correct syntax
    • Common mistake #1: Missing space
      • Wrong syntax
    • Common mistake #2: Missing underscore (_)
      • Wrong Syntax
    • Additional information
  1. Start
  2. reStructuredText & Sphinx
  3. Common pitfalls
  4. Problems with links
View source How to edit Edit on GitHub

Problems with links¶

There are several ways to write links, here we assume you are using external links with the following syntax. For more information see the references at the bottom on this page.

Correct syntax¶

`anchor text <url>`__

Example:

`T3O <https://typo3.org>`__

How this looks:

T3O

Common mistake #1: Missing space¶

Make sure there is a space between the anchor text and the opening <.

Tip

To test this yourself right now, click on “Edit on GitHub” in the top right corner of this page, fix the errors, then use “Preview changes” to view the changes (you need a GitHub account for this, if you do not have an account, go to https://github.com/join).

Wrong syntax¶

`T3O<https://typo3.org>`__

How this looks:

`T3O<https://typo3.org>`__

Common mistake #2: Missing underscore (_)¶

Missing _ or __ at the end:

Wrong Syntax¶

`T3O <https://typo3.org>`

How this looks:

T3O <https://typo3.org>

Additional information¶

  • External links
  • Previous
  • Next
  • Home
  • Contact
  • Issues
  • Repository

Last updated: Jun 29, 2022 06:51

Last rendered: Jun 29, 2022 06:52

TYPO3 Theme 4.6.2

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